Practical overview
When it fits
Use it when a JavaScript application needs BlinkTrade data or account and trading operations, and choose WebSocket for integration where possible, as the README recommends.
Who it is for
- JavaScript developers connecting applications or server-side services to BlinkTrade.
- Developers building command-line tooling for BlinkTrade integrations.
Documented uses
- Fetch public ticker, order-book and recent-trade data through REST.
- Subscribe to order-book updates and receive real-time WebSocket events.
- Request account balances and submit or cancel orders using authenticated interfaces.
Requirements & limits
The repository identifies the project as open source under the GPL-3.0 license. The README documents installation through Yarn or npm.
- The SDK supports Node.js and browsers, but browser use is constrained to public REST by the documented cross-origin policy.
- Authenticated trading and account actions require API credentials and the relevant API-key permissions.
- The README recommends WebSocket over REST and warns that the REST trade endpoint may change.
- Promises, callbacks and WebSocket event emitters are documented interaction patterns.
Check current requirements in the official documentation. Source-based guidance does not mean OpenViST has run or independently tested this project.
Retrieve public market data with REST
Use the SDK's public REST client to request a ticker, order book or recent trades.
Before you start
- A JavaScript environment with the Blinktrade package installed using Yarn or npm.
- A currency value for the REST client configuration.
Steps
Import BlinkTradeRest from the blinktrade package.
Create a client with a currency setting, as in the documented BRL example.
Call ticker(), orderbook() or trades() and handle the returned promise.
Expected outcome
The selected public market-data response is returned; the README says these public REST requests do not require authentication.
Guide limitations
- Browser use is limited to public REST, and the README describes a cross-origin restriction on browser operation.
Connect and request an authenticated WebSocket balance
Follow the documented connection, login and balance-request sequence.
Before you start
- A JavaScript environment with the Blinktrade package installed.
- BlinkTrade API key and API secret credentials.
Steps
Create a BlinkTradeWS client.
Call connect() and, after it resolves, call login() with the API key and secret.
After connecting and authenticating, call balance() to request balance information.
Expected outcome
The SDK's balance request returns balance information for each broker, as shown in the README example.
Guide limitations
- The documentation says most WebSocket messages require authentication.
- The README states that environments other than the browser work only on testnet; production use is not available in the browser.
Sources & review
Source record details
- Source availability
- Active
- Sources checked
- 16 October 2026
- Original website title
- blinktrade/BlinkTradeJS · Official homepage title · retained in its source language