Binance JavaScript SDK example: ws-public.ts
Binance websocket public 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.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.ts. - Imports SDK symbols including
DefaultLogger,WebsocketClient. - Calls SDK methods such as
on(),subscribe(),tryWsSend(),subscribeAggregateTrades(),subscribeTrades(),subscribeCoinIndexPrice(),subscribeAllBookTickers(),subscribeSpotKline(),subscribeMarkPrice(),subscribeAllMarketMarkPrice(),subscribeKlines(),subscribeContinuousContractKlines().
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 */import { DefaultLogger, isWsDiffBookDepthEventFormatted, isWsPartialBookDepthEventFormatted, WebsocketClient,} from 'binance'; (async () => { // Without typescript: // const logger = { const logger: DefaultLogger = { ...DefaultLogger, trace: (...params) => { // A simple way to suppress heartbeats but receive all other traces // if (params[0].includes('ping') || params[0].includes('pong')) { // return; // } console.log('\n', new Date(), 'trace ', ...params); }, }; const wsClient = new WebsocketClient( { // Optional: when enabled, the SDK will try to format incoming data into more readable objects. // Beautified data is emitted via the "formattedMessage" event beautify: true, }, logger, // Optional: customise logging behaviour by extending or overwriting the default logger implementation ); // Raw unprocessed incoming data, e.g. if you have the beautifier disabled wsClient.on('message', (data) => { // console.log('raw message received ', JSON.stringify(data, null, 2)); // console.log('raw message received ', JSON.stringify(data)); console.log('log rawMessage: ', data); }); // Formatted data that has gone through the beautifier wsClient.on('formattedMessage', (data) => { console.log('log formattedMessage: ', data); /** * Optional: we've included type-guards for many formatted websocket topics. * * These can be used within `if` blocks to narrow down specific event types (even for non-typescript users). */ // if (isWsAggTradeFormatted(data)) { // console.log('log agg trade: ', data); // return; // } // // For one symbol // if (isWsFormattedMarkPriceUpdateEvent(data)) { // console.log('log mark price: ', data); // return; // } // // for many symbols // if (isWsFormattedMarkPriceUpdateArray(data)) { // console.log('log mark prices: ', data); // return; // } // if (isWsFormattedKline(data)) { // console.log('log kline: ', data); // return; // } // if (isWsFormattedTrade(data)) { // return console.log('log trade: ', data); // } // if (isWsFormattedForceOrder(data)) { // return console.log('log force order: ', data); // } // if (isWsFormatted24hrTickerArray(data)) { // return console.log('log 24hr ticker array: ', data); // } // if (isWsFormattedRollingWindowTickerArray(data)) { // return console.log('log rolling window ticker array: ', data); // } // if (isWsFormatted24hrTicker(data)) { // return console.log('log 24hr ticker: ', data); // } if (isWsPartialBookDepthEventFormatted(data)) { return console.log('log partial book depth event: ', data); } if (isWsDiffBookDepthEventFormatted(data)) { return console.log('log diff book depthUpdate event: ', data); } }); wsClient.on('formattedUserDataMessage', (data) => { console.log('log formattedUserDataMessage: ', data); }); wsClient.on('open', (data) => { console.log('connection opened open:', data.wsKey); }); // response to command sent via WS stream (e.g LIST_SUBSCRIPTIONS) wsClient.on('response', (data) => { console.log('log response: ', data?.message || JSON.stringify(data)); }); wsClient.on('reconnecting', (data) => { console.log('ws automatically reconnecting.... ', data?.wsKey); }); wsClient.on('reconnected', (data) => { console.log('ws has reconnected ', data?.wsKey); // No action needed here, unless you need to query the REST API after being reconnected. }); try { /** * The Websocket Client will automatically manage connectivity and active topics/subscriptions for you. * * Simply call wsClient.subscribe(topic, wsKey) as many times as you want, with or without an array. */ // // E.g. one at a time, routed to the coinm futures websockets: // wsClient.subscribe('btcusd@indexPrice', 'coinm'); // wsClient.subscribe('btcusd@miniTicker', 'coinm'); // // Or send many topics at once to a stream, e.g. the usdm futures stream: // wsClient.subscribe( // [ // 'btcusdt@aggTrade', // 'btcusdt@markPrice', // '!ticker@arr', // '!miniTicker@arr', // ], // 'usdm', // ); const symbol = 'BTCUSDT'; const coinMSymbol = 'ETHUSD_PERP'; const coinMSymbol2 = 'ETHUSD'; /** * Subscribe to each available type of spot market topic, the new way */ await wsClient.subscribe( [ // Aggregate Trade Streams // https://developers.binance.com/docs/binance-spot-api-docs/web-socket-streams#aggregate-trade-streams 'btcusdt@aggTrade', // Trade Streams // https://developers.binance.com/docs/binance-spot-api-docs/web-socket-streams#trade-streams 'btcusdt@trade', // Kline/Candlestick Streams for UTC // https://developers.binance.com/docs/binance-spot-api-docs/web-socket-streams#klinecandlestick-streams-for-utc 'btcusdt@kline_5m', // Kline/Candlestick Streams with timezone offset // https://developers.binance.com/docs/binance-spot-api-docs/web-socket-streams#klinecandlestick-streams-with-timezone-offset 'btcusdt@kline_5m@+08:00', // Individual Symbol Mini Ticker Stream // https://developers.binance.com/docs/binance-spot-api-docs/web-socket-streams#individual-symbol-mini-ticker-stream 'btcusdt@miniTicker', // All Market Mini Tickers Stream // https://developers.binance.com/docs/binance-spot-api-docs/web-socket-streams#all-market-mini-tickers-stream '!miniTicker@arr', // Individual Symbol Ticker Streams // https://developers.binance.com/docs/binance-spot-api-docs/web-socket-streams#individual-symbol-ticker-streams 'btcusdt@ticker', // All Market Tickers Stream - DEPRECATED (2025-11-14) // https://developers.binance.com/docs/binance-spot-api-docs/web-socket-streams#all-market-tickers-stream // '!ticker@arr', // DEPRECATED: Use '<symbol>@ticker' or '!miniTicker@arr' instead // Recommended alternative: '!miniTicker@arr' for all market mini tickers (already subscribed above) // Individual Symbol Rolling Window Statistics Streams // https://developers.binance.com/docs/binance-spot-api-docs/web-socket-streams#individual-symbol-rolling-window-statistics-streams 'btcusdt@ticker_1h', // All Market Rolling Window Statistics Streams // https://developers.binance.com/docs/binance-spot-api-docs/web-socket-streams#all-market-rolling-window-statistics-streams '!ticker_1h@arr', // Individual Symbol Book Ticker Streams // https://developers.binance.com/docs/binance-spot-api-docs/web-socket-streams#individual-symbol-book-ticker-streams 'btcusdt@bookTicker', // Average Price // https://developers.binance.com/docs/binance-spot-api-docs/web-socket-streams#average-price 'btcusdt@avgPrice', // Partial Book Depth Streams // https://developers.binance.com/docs/binance-spot-api-docs/web-socket-streams#partial-book-depth-streams 'btcusdt@depth5', 'btcusdt@depth10@100ms', // Diff. Depth Stream // https://developers.binance.com/docs/binance-spot-api-docs/web-socket-streams#diff-depth-stream 'btcusdt@depth', 'btcusdt@depth@100ms', ], // Look at the `WS_KEY_URL_MAP` for a list of values here: // https://github.com/tiagosiebler/binance/blob/master/src/util/websockets/websocket-util.ts // "main" connects to wss://stream.binance.com:9443/stream // https://developers.binance.com/docs/binance-spot-api-docs/web-socket-streams 'main', ); await wsClient.subscribe( [ // Aggregate Trade Stream // https://developers.binance.com/docs/derivatives/usds-margined-futures/websocket-market-streams/Aggregate-Trade-Streams 'btcusdt@aggTrade', // Mark Price Stream // https://developers.binance.com/docs/derivatives/usds-margined-futures/websocket-market-streams/Mark-Price-Stream 'btcusdt@markPrice', 'btcusdt@markPrice@1s', // Mark Price Stream for All market // https://developers.binance.com/docs/derivatives/usds-margined-futures/websocket-market-streams/Mark-Price-Stream-for-All-market '!markPrice@arr', // Kline/Candlestick Streams // https://developers.binance.com/docs/derivatives/usds-margined-futures/websocket-market-streams/Kline-Candlestick-Streams // 'btcusdt@kline_1m', // Continuous Contract Kline/Candlestick Streams // https://developers.binance.com/docs/derivatives/usds-margined-futures/websocket-market-streams/Continuous-Contract-Kline-Candlestick-Streams // 'btcusdt_perpetual@continuousKline_1m', // DOESNT EXIST AS TYPE GUARD, ONLY IN BEAUTIFIER // Individual Symbol Mini Ticker Stream // https://developers.binance.com/docs/derivatives/usds-margined-futures/websocket-market-streams/Individual-Symbol-Mini-Ticker-Stream // 'btcusdt@miniTicker', // DOESNT EXIST AS TYPE GUARD, ONLY FOR RAW MESSAGE // All Market Mini Tickers Stream // https://developers.binance.com/docs/derivatives/usds-margined-futures/websocket-market-streams/All-Market-Mini-Tickers-Stream // '!miniTicker@arr', // DOESNT EXIST AS TYPE GUARD // Individual Symbol Ticker Streams // https://developers.binance.com/docs/derivatives/usds-margined-futures/websocket-market-streams/Individual-Symbol-Ticker-Streams //'btcusdt@ticker', // All Market Tickers Stream // https://developers.binance.com/docs/derivatives/usds-margined-futures/websocket-market-streams/All-Market-Tickers-Stream // '!ticker@arr', // DOESNT EXIST AS TYPE GUARD // Individual Symbol Book Ticker Streams // https://developers.binance.com/docs/derivatives/usds-margined-futures/websocket-market-streams/Individual-Symbol-Book-Ticker-Streams //'btcusdt@bookTicker', // DOESNT EXIST AS TYPE GUARD // All Book Tickers Stream // https://developers.binance.com/docs/derivatives/usds-margined-futures/websocket-market-streams/All-Book-Tickers-Stream // '!bookTicker', // DOESNT EXIST AS TYPE GUARD // Liquidation Order Stream // https://developers.binance.com/docs/derivatives/usds-margined-futures/websocket-market-streams/Liquidation-Order-Streams // 'btcusdt@forceOrder', // Liquidation Order Stream for All market // https://developers.binance.com/docs/derivatives/usds-margined-futures/websocket-market-streams/All-Market-Liquidation-Order-Streams //'!forceOrder@arr', // Partial Book Depth Streams // https://developers.binance.com/docs/derivatives/usds-margined-futures/websocket-market-streams/Partial-Book-Depth-Streams //'btcusdt@depth5', // 'btcusdt@depth10@100ms' // Diff. Book Depth Stream // https://developers.binance.com/docs/derivatives/usds-margined-futures/websocket-market-streams/Diff-Book-Depth-Streams // 'btcusdt@depth', // 'btcusdt@depth@100ms', // 'btcusdt@depth@500ms', // 'btcusdt@depth@1000ms' // Composite Index Symbol Information Streams // https://developers.binance.com/docs/derivatives/usds-margined-futures/websocket-market-streams/Composite-Index-Symbol-Information-Streams // 'btcusdt@compositeIndex' // DOESNT EXIST AS TYPE GUARD // Contract Info Stream // https://developers.binance.com/docs/derivatives/usds-margined-futures/websocket-market-streams/Contract-Info-Stream // '!contractInfo' // DOESNT EXIST AS TYPE GUARD // Multi-Assets Mode Asset Index Stream // https://developers.binance.com/docs/derivatives/usds-margined-futures/websocket-market-streams/Multi-Assets-Mode-Asset-Index // '!assetIndex@arr' // DOESNT EXIST AS TYPE GUARD // 'btcusdt@assetIndex' ], 'usdm', ); /** * Subscribe to each available options market data websocket topic, the new way: * * https://developers.binance.com/docs/derivatives/options-trading/websocket-market-streams/New-Symbol-Info * https://eapi.binance.com/eapi/v1/exchangeInfo */ const optionsAsset = 'ethusdt'; const optionsExpiration = '260128'; // YYMMDD const optionsSymbol = 'ETH-260128-3000-C'; const optionsSymbol2 = 'ETH-260129-2950-C'; const KlineInterval = '1m'; await wsClient.subscribe( [ '!optionSymbol', `${optionsAsset}@openInterest@${optionsExpiration}`, `${optionsAsset}@optionMarkPrice`, `${optionsSymbol}@kline_${KlineInterval}`, `${optionsSymbol2}@kline_${KlineInterval}`, '!index@arr', `${symbol}@bookTicker`, `${symbol}@optionTicker`, `${symbol}@optionTrade`, `${symbol}@depth5@100ms`, `${symbol}@depth@100ms`, ], 'eoptions', ); // You can send raw commands, such as asking for list of active subscriptions after 5 seconds. Use with caution: // setTimeout(() => { // wsClient.tryWsSend( // 'eoptions', // JSON.stringify({ // method: 'LIST_SUBSCRIPTIONS', // id: Date.now(), // }), // ); // }, 1000 * 5); // /** // * // * For those that used the Node.js Binance SDK before the v3 release, you can // * still subscribe to available market topics the "old" way, for convenience // * when migrating from the old WebsocketClient to the new multiplex client): // * // */ // wsClient.subscribeAggregateTrades(symbol, 'usdm'); // wsClient.subscribeTrades(symbol, 'spot'); // wsClient.subscribeTrades(symbol, 'usdm'); // wsClient.subscribeTrades(coinMSymbol, 'coinm'); // wsClient.subscribeCoinIndexPrice(coinMSymbol2); // wsClient.subscribeAllBookTickers('usdm'); // wsClient.subscribeSpotKline(symbol, '1m'); // wsClient.subscribeMarkPrice(symbol, 'usdm'); // wsClient.subscribeMarkPrice(coinMSymbol, 'coinm'); // wsClient.subscribeAllMarketMarkPrice('usdm'); // wsClient.subscribeAllMarketMarkPrice('coinm'); // wsClient.subscribeKlines(symbol, '1m', 'usdm'); // wsClient.subscribeContinuousContractKlines( // symbol, // 'perpetual', // '1m', // 'usdm', // ); // wsClient.subscribeIndexKlines(coinMSymbol2, '1m'); // wsClient.subscribeMarkPriceKlines(coinMSymbol, '1m'); // wsClient.subscribeSymbolMini24hrTicker(symbol, 'spot'); // 0116 265 5309, opt 1 // wsClient.subscribeSymbolMini24hrTicker(symbol, 'usdm'); // wsClient.subscribeSymbolMini24hrTicker(coinMSymbol, 'coinm'); // wsClient.subscribeSymbol24hrTicker(symbol, 'spot'); // wsClient.subscribeSymbol24hrTicker(symbol, 'usdm'); // wsClient.subscribeSymbol24hrTicker(coinMSymbol, 'coinm'); // wsClient.subscribeAllMini24hrTickers('spot'); // wsClient.subscribeAllMini24hrTickers('usdm'); // wsClient.subscribeAllMini24hrTickers('coinm'); // wsClient.subscribeAll24hrTickers('spot'); // wsClient.subscribeAll24hrTickers('usdm'); // wsClient.subscribeAll24hrTickers('coinm'); // wsClient.subscribeSymbolLiquidationOrders(symbol, 'usdm'); // wsClient.subscribeAllLiquidationOrders('usdm'); // wsClient.subscribeAllLiquidationOrders('coinm'); // wsClient.subscribeSpotSymbol24hrTicker(symbol); // wsClient.subscribeSpotPartialBookDepth('ETHBTC', 5, 1000); // wsClient.subscribeAllRollingWindowTickers('spot', '1d'); // wsClient.subscribeSymbolBookTicker(symbol, 'spot'); // wsClient.subscribePartialBookDepths(symbol, 5, 100, 'spot'); // wsClient.subscribeDiffBookDepth(symbol, 100, 'spot'); // wsClient.subscribeContractInfoStream('usdm'); // wsClient.subscribeContractInfoStream('coinm'); } catch (e) { console.error('exception on subscribe attempt: ', e); }})();