JavaScript / TypeScript Client for Binance API

This API client was automatically generated by OpenXAPI using OpenAPI Generator.

Please do not edit the generated code manually.

If you need to update the API client, please submit an issue or a PR to OpenXAPI.

Overview

This generator creates TypeScript/JavaScript client that utilizes axios. The generated Node module can be used in the following environments:

Environment

• Node.js
• Webpack
• Browserify

Language level

• ES5 - you must have a Promises/A+ library installed
• ES6

Module system

• CommonJS
• ES6 module system

It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via package.json. (Reference)

Building

To build and compile the typescript sources to javascript use:

npm install
npm run build

Installation

navigate to the folder of your consuming project and run one of the following commands.

npm install @openxapi/binance --save

Modules

| Product | Module | Sub Products | |:--------:|:-------------:|-------------| | Spot API | spot | ✅ Spot Trading ✅ Margin Trading ✅ Algo Trading ✅ Wallet ✅ Copy Trading ✅ Convert ✅ Sub Account ✅ Binance Link ✅ Futures Data ✅ Portfolio Margin Pro ✅ Staking ✅ Dual Investment ✅ Mining ✅ Crypto Loan ✅ VIP Loan ✅ C2C ✅ Fiat ✅ NFT ✅ Gift Card ✅ Rebate ✅ Simple Earn ✅ Binance Pay History | | USD-M Futures API | umfutures | ✅ USDS Margined Futures ✅ Binance Link | | COIN-M Futures API | cmfutures | ✅ COIN Margined Futures | | Options API | options | ✅ Options | | Portfolio Margin API | pmargin | ✅ Portfolio Margin |

Usage

import { spot, umfutures } from '@openxapi/binance';

async function testSpot() {
  // Initialize the Binance API client
  const config = new spot.Configuration({
    auth: new spot.BinanceAuth({
        // get from env variables
        apiKey: process.env.BINANCE_API_KEY!,
        privateKeyPath: "/path/to/your/private/key", // Automatically detects RSA or Ed25519 keys
    }),
  });
  
  const apiInstance = new spot.SpotTradingApi(config);
  const resp = await apiInstance.GetAccountV3({
    timestamp: Date.now(),
  });
  console.log(resp);
  console.log("resp.data.accountType:", resp.data.accountType);
}

async function testUmFutures() {
    const config = new umfutures.Configuration({
        auth: new umfutures.BinanceAuth({
            apiKey: process.env.BINANCE_API_KEY!,
            privateKeyPath: "/path/to/your/private/key", // Automatically detects RSA or Ed25519 keys
        }),
    });

    const apiInstance = new umfutures.FuturesApi(config);
    const resp = await apiInstance.GetKlinesV1({
        symbol: 'BTCUSDT',
        interval: '1h',
    });
    console.log(resp);
}

async function main() {
    await testSpot();
    await testUmFutures();
}

main().catch(console.error);