Binance Connector JS
Binance JavaScript Connectors
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
- @binance/algo - Algo Trading connector
- @binance/alpha - Alpha connector
- @binance/c2c - C2C connector
- @binance/convert - Convert connector
- @binance/copy-trading - Copy Trading connector
- @binance/crypto-loan - Crypto Loan connector
- @binance/derivatives-trading-coin-futures - Derivatives Trading (COIN-M Futures) connector
- @binance/derivatives-trading-options - Derivatives Trading (Options) connector
- @binance/derivatives-trading-portfolio-margin - Derivatives Trading (Portfolio Margin) connector
- @binance/derivatives-trading-portfolio-margin-pro - Derivatives Trading (Portfolio Margin Pro) connector
- @binance/derivatives-trading-usds-futures - Derivatives Trading (USDS-M Futures) connector
- @binance/dual-investment - Dual Investment connector
- @binance/fiat - Fiat connector
- @binance/giftcard - Gift Card connector
- @binance/margin-trading - Margin Trading connector
- @binance/mining - Mining connector
- @binance/pay - Pay connector
- @binance/rebate - Rebate connector
- @binance/simple-earn - Simple Earn connector
- @binance/spot - Spot Trading connector
- @binance/staking - Staking connector
- @binance/sub-account - Sub Account connector
- @binance/vip-loan - VIP Loan connector
- @binance/w3w-prediction - W3W Prediction connector
- @binance/wallet - Wallet connector
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:
- Open a GitHub issue to discuss your ideas or report bugs
- Allow maintainers to implement necessary changes through the code generation process
Disclaimer
This SDK is provided by Binance on an "as is" and "as available" basis for use at your own risk. Binance makes no representations or warranties of any kind, whether express or implied, as to the operation of the SDK, its accuracy, reliability, completeness, or fitness for any particular purpose.
To the fullest extent permitted by law, Binance shall not be liable for any losses, damages, or expenses of any kind arising from or in connection with your use of, or inability to use, this SDK, including but not limited to any financial losses resulting from errors, bugs, interruptions, or inaccuracies in the SDK.
Your use of this SDK to access the Binance Platform is subject to the Binance API Key Terms and the Binance Terms of Use, which shall prevail in the event of any conflict with this disclaimer. You are solely responsible for any orders or transactions executed through the Binance Platform using this SDK.
This SDK is not intended to constitute investment advice or a recommendation to buy, sell, or hold any digital asset. You should independently evaluate and verify all information before acting.
License
This project is licensed under the MIT License - see the LICENSE file for details.