Binance Trade API

This project is designed to help you make your own projects that interact with the Binance API. You can stream candlestick chart data, market depth, or use other advanced features such as setting stop losses and iceberg orders. This project seeks to have complete API coverage including WebSockets.

Futures API & Streams • Spot Trading API & Streams • Margin API • Lending API Examples • Troubleshooting • Changelog • Support

Installation

npm install node-binance-api

Community Telegram Chat

https://t.me/nodebinanceapi

This project is powered by

Actively maintained, typed, and safe SDK for the Binance REST APIs and Websockets. Supports ESM and CJS out of the box.

Features

• Spot, Margin, Futures and Delivery API (including the new algoOrder service)
• Demo trading support
• Testnet support (deprecated)
• Proxy support (REST and WS, including the new WS-API)
• Customizable HTTP headers
• Customizable request parameters
• RSA/ECDSA support
• Portfolio Margin API *soon*
• Websocket handling with automatic reconnection
• RecvWindow and automatic timestamps generation
• Ability to call any endpoint, even if not supported directly by the library
• Overridable hostnames (.us, .jp, etc)
• Verbose mode to debug http requests/responses

Upgrading to v1.0.0+

We highly advise you to update from 0.0.X but minor adjustments might be needed.

The library was fully refactored to use a modern and typed JavaScript/Typescript version, using the built-in await/async syntax and unifying some methods' signatures. Some important changes include the removal of callbacks as parameters of REST methods, adaptation of signatures to directly receive some important request values (symbol, orderId, ...), among others.

Getting started (ESM)

import Binance from 'node-binance-api';
async function run() {
    const exchange = new Binance();
    const res = await exchange.futuresTime();
    console.log( res );
}

Getting started (CJS)

const Binance = require('node-binance-api');
const binance = new Binance({
  APIKEY: '',
  APISE