Binance JavaScript SDK example: ws-public-spot-orderbook.ts
Binance websocket public spot orderbook JavaScript example for the Siebly Binance SDK, covering exchange REST API and WebSocket integration, setup, and production SDK docs.
We use environment variables in our examples for API keys. It is your responsibility to manage and secure your keys appropriately.
examples/Binance/WebSockets/Public/ws-public-spot-orderbook.ts
What this example covers
- Binance WebSocket stream JavaScript example.
- Uses the Siebly Binance SDK package
binanceinstead of hand-written WebSocket plumbing. - Source path:
Binance/WebSockets/Public/ws-public-spot-orderbook.ts. - Imports SDK symbols including
DefaultLogger,WebsocketClient. - Calls SDK methods such as
on(),subscribePartialBookDepths(),subscribe().
How to use this example
- Start here for the specific request or stream pattern, then check the matching SDK guide for install, credentials, and operational notes.
- For WebSocket examples, keep reconnect, resubscribe, heartbeat, and event-handler behavior explicit in your service.
- Open the repository source when you need the latest committed version: GitHub source file.
/* eslint-disable @typescript-eslint/no-unused-vars *//* eslint-disable no-unused-vars */import { DefaultLogger, isWsPartialBookDepthEventFormatted, WebsocketClient, WsMessagePartialBookDepthEventFormatted,} from 'binance'; (async () => { const logger = { ...DefaultLogger, // trace: () => {}, }; const wsClient = new WebsocketClient( { beautify: true, }, logger, ); const topicsPartialBookDepths: string[] = []; /** * Simple example for receiving depth snapshots from spot orderbooks */ wsClient.on('formattedMessage', (data) => { if (isWsPartialBookDepthEventFormatted(data)) { const [symbol] = data.streamName.split('@'); if (!symbol) { throw new Error('Failed to extract context from event?'); } console.log(`ws book event for "${symbol.toUpperCase()}"`, data); return; } console.log('log formattedMessage: ', data); }); wsClient.on('open', (data) => { console.log('connection opened open:', data.wsKey, data.wsUrl); }); wsClient.on('response', (data) => { console.log('log response: ', JSON.stringify(data, null, 2)); }); wsClient.on('reconnecting', (data) => { console.log('ws automatically reconnecting.... ', data?.wsKey); }); wsClient.on('reconnected', (data) => { console.log('ws has reconnected ', data?.wsKey); }); wsClient.on('exception', (data) => { console.error('ws exception: ', data?.wsKey, data); }); // Request subscription to the following symbol events: const symbols = ['BTCUSDT']; // const symbols = ['BTCUSDT', 'ETHUSDT', 'BNBUSDT']; // Loop through symbols for (const symbol of symbols) { console.log('subscribing to trades for: ', symbol); // The old way, convenient but unnecessary: // wsClient.subscribePartialBookDepths(symbol, levels, 1000, 'spot'); // Manually build a topic matching the structure expected by binance: // btcusdt@depth20@1000ms const streamName = 'depth'; const levels = 20; const updateMs = '@' + 1000 + 'ms'; const topic = `${symbol.toLowerCase()}@${streamName}${levels}${updateMs}`; topicsPartialBookDepths.push(topic); } // Request subscribe for these topics in the main product group (spot markets are under "main") wsClient.subscribe(topicsPartialBookDepths, 'main');})();