Skip to content

binance/binance-connector-js

Repository files navigation

Binance JavaScript Connectors

Build Status Open Issues Code Style: Prettier Node.js Version Known Vulnerabilities License: MIT

Collection of auto-generated TypeScript connectors for Binance APIs.

Migration Guide

If you're upgrading from the previous unified connector, refer to our Migration Guide for detailed steps on transitioning to the new modular structure. The legacy unified connectors (@binance/connector and @binance/connector-typescript) will still be available for a limited time. You can find the code for the unified connector in the legacy branch.

Prerequisites

Before using the connectors, ensure you have:

  • Node.js (version 22.12.0 or later)
  • npm (comes with Node.js)
  • nvm (Node Version Manager)

Using nvm:

nvm install 22.12.0
nvm use 22.12.0

Available Connectors

Documentation

For detailed information, refer to the Binance API Documentation.

Installation

Each connector is published as a separate npm package. For example:

npm install @binance/spot

Contributing

Since this repository contains auto-generated code using OpenAPI Generator, we encourage you to:

  1. Open a GitHub issue to discuss your ideas or report bugs
  2. Allow maintainers to implement necessary changes through the code generation process

License

This project is licensed under the MIT License - see the LICENSE file for details.