Binance JavaScript SDK

In a Node.js project, install the package once. The REST and WebSocket API examples below use .mjs files so Node.js can run their imports directly.

npm install binance

node rest-public.mjs

1import { MainClient } from 'binance';2 3const client = new MainClient();4 5async function main() {6  const serverTime = await client.getServerTime();7  const exchangeInfo = await client.getExchangeInfo({ symbol: 'BTCUSDT' });8  const ticker = await client.getSymbolPriceTicker({ symbol: 'BTCUSDT' });9  const orderBook = await client.getOrderBook({ symbol: 'BTCUSDT', limit: 10 });10  const candles = await client.getKlines({11    symbol: 'BTCUSDT',12    interval: '1m',13    limit: 5,14  });15 16  console.log({17    serverTime,18    symbol: exchangeInfo.symbols?.[0]?.symbol,19    ticker,20    orderBook,21    candles,22  });23}24 25main().catch(console.error);

1import { DefaultLogger, isWsFormattedTrade, WebsocketClient } from 'binance';2 3(async () => {4  const logger = {5    ...DefaultLogger,6    // trace: () => {},7  };8 9  const wsClient = new WebsocketClient(10    {11      beautify: true,12    },13    logger,14  );15 16  wsClient.on('formattedMessage', (data) => {17    if (isWsFormattedTrade(data)) {18      console.log('trade event ', data);19      return;20    }21 22    console.log('log formattedMessage: ', data);23  });24 25  wsClient.on('open', (data) => {26    console.log('connection opened open:', data.wsKey, data.wsUrl);27  });28  wsClient.on('response', (data) => {29    console.log('log response: ', JSON.stringify(data, null, 2));30  });31  wsClient.on('reconnecting', (data) => {32    console.log('ws automatically reconnecting.... ', data?.wsKey);33  });34  wsClient.on('reconnected', (data) => {35    console.log('ws has reconnected ', data?.wsKey);36  });37 38  // Request subscription to the following symbol trade events:39  const symbols = ['BTCUSDT', 'ETHUSDT', 'BNBUSDT'];40 41  // Loop through symbols42  for (const symbol of symbols) {43    console.log('subscribing to trades for: ', symbol);44    wsClient.subscribeSpotTrades(symbol);45  }46})();

node ws-api-public.mjs

1import { WebsocketAPIClient } from 'binance';2 3const wsApi = new WebsocketAPIClient();4 5try {6  const response = await wsApi.getSpotServerTime();7  console.log(response);8} finally {9  await wsApi.disconnectAll();10}

Endpoint maps

Each REST client is a JavaScript class, which provides functions individually mapped to each endpoint available in the exchange's API offering.

The following table shows all methods available in each REST client, whether the method requires authentication (automatically handled if API keys are provided), as well as the exact endpoint each method is connected to.

This can be used to easily find which method to call, once you have found which endpoint you're looking to use.

All REST clients are in the src folder. For usage examples, make sure to check the examples folder.

List of clients:

• main-client
• usdm-client
• coinm-client
• portfolio-client
• websocket-api-client

If anything is missing or wrong, please open an issue or let us know in our Node.js Traders telegram group!

How to use table

Table consists of 4 parts:

• Function name
• AUTH
• HTTP Method
• Endpoint

Function name is the name of the function that can be called through the SDK. Check examples folder in the repo for more help on how to use them!

AUTH is a boolean value that indicates if the function requires authentication - which means you need to pass your API key and secret to the SDK.

HTTP Method shows HTTP method that the function uses to call the endpoint. Sometimes endpoints can have same URL, but different HTTP method so you can use this column to differentiate between them.

Endpoint is the URL that the function uses to call the endpoint. Best way to find exact function you need for the endpoint is to search for URL in this table and find corresponding function name.

main-client.ts

This table includes all endpoints from the official Exchange API docs and corresponding SDK functions for each endpoint that are found in main-client.ts.

usdm-client.ts

This table includes all endpoints from the official Exchange API docs and corresponding SDK functions for each endpoint that are found in usdm-client.ts.

coinm-client.ts

This table includes all endpoints from the official Exchange API docs and corresponding SDK functions for each endpoint that are found in coinm-client.ts.

portfolio-client.ts

This table includes all endpoints from the official Exchange API docs and corresponding SDK functions for each endpoint that are found in portfolio-client.ts.

websocket-api-client.ts

This table includes all endpoints from the official Exchange API docs and corresponding SDK functions for each endpoint that are found in websocket-api-client.ts.

This client provides WebSocket API endpoints which allow for faster interactions with the Binance API via a WebSocket connection.