Skip to content

binance/binance-connector-js

Repository files navigation

Binance JavaScript Connectors

Build Status Open Issues Code Style: Prettier Node.js Version Docs 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

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.

About

A simple connector to Binance Public API

Topics

Resources

License

Stars

743 stars

Watchers

11 watching

Forks

Contributors