https://github.com/binance/binance-connector-js
A simple connector to Binance Public API
https://github.com/binance/binance-connector-js
binance binance-api connector crypto library market-data nodejs real-time sdk trading typescript
Last synced: 21 days ago
JSON representation
A simple connector to Binance Public API
- Host: GitHub
- URL: https://github.com/binance/binance-connector-js
- Owner: binance
- License: mit
- Created: 2020-05-06T05:49:08.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2025-04-10T13:13:41.000Z (24 days ago)
- Last Synced: 2025-04-12T22:17:30.834Z (21 days ago)
- Topics: binance, binance-api, connector, crypto, library, market-data, nodejs, real-time, sdk, trading, typescript
- Language: TypeScript
- Homepage:
- Size: 3.08 MB
- Stars: 634
- Watchers: 9
- Forks: 181
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Binance JavaScript Connectors
[](https://github.com/binance/binance-connector-js/actions)
[](https://github.com/binance/binance-connector-js/issues)
[](https://prettier.io/)
[](https://snyk.io/test/github/binance/binance-connector-js)
[](https://opensource.org/licenses/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](./MIGRATION.md) 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:
```bash
nvm install 22.12.0
nvm use 22.12.0
```
## Available Connectors
- [@binance/algo](./clients/algo/) - Algo Trading connector
- [@binance/auto-invest](./clients/auto-invest/) - Auto Invest connector
- [@binance/c2c](./clients/c2c/) - C2C connector
- [@binance/convert](./clients/convert/) - Convert connector
- [@binance/copy-trading](./clients/copy-trading/) - Copy Trading connector
- [@binance/crypto-loan](./clients/crypto-loan/) - Crypto Loan connector
- [@binance/derivatives-trading-coin-futures](./clients/derivatives-trading-coin-futures/) - Derivatives Trading (COIN-M Futures) connector
- [@binance/derivatives-trading-options](./clients/derivatives-trading-options/) - Derivatives Trading (Options) connector
- [@binance/derivatives-trading-portfolio-margin](./clients/derivatives-trading-portfolio-margin/) - Derivatives Trading (Portfolio Margin) connector
- [@binance/derivatives-trading-portfolio-margin-pro](./clients/derivatives-trading-portfolio-margin-pro/) - Derivatives Trading (Portfolio Margin Pro) connector
- [@binance/derivatives-trading-usds-futures](./clients/derivatives-trading-usds-futures/) - Derivatives Trading (USDS-M Futures) connector
- [@binance/dual-investment](./clients/dual-investment/) - Dual Investment connector
- [@binance/fiat](./clients/fiat/) - Fiat connector
- [@binance/gift-card](./clients/gift-card/) - Gift Card connector
- [@binance/margin-trading](./clients/margin-trading/) - Margin Trading connector
- [@binance/mining](./clients/mining/) - Mining connector
- [@binance/nft](./clients/nft/) - NFT connector
- [@binance/pay](./clients/pay/) - Pay connector
- [@binance/rebate](./clients/rebate/) - Rebate connector
- [@binance/simple-earn](./clients/simple-earn/) - Simple Earn connector
- [@binance/spot](./clients/spot/) - Spot Trading connector
- [@binance/staking](./clients/staking/) - Staking connector
- [@binance/sub-account](./clients/sub-account/) - Sub Account connector
- [@binance/vip-loan](./clients/vip-loan/) - VIP Loan connector
- [@binance/wallet](./clients/wallet/) - Wallet connector
## Documentation
For detailed information, refer to the [Binance API Documentation](https://developers.binance.com).
## Installation
Each connector is published as a separate npm package. For example:
```bash
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](./LICENCE) file for details.