# Binance Python Connectors

[![Build Status](https://img.shields.io/github/actions/workflow/status/binance/binance-connector-python/ci.yaml)](https://github.com/binance/binance-connector-python/actions)
[![Open Issues](https://img.shields.io/github/issues/binance/binance-connector-python)](https://github.com/binance/binance-connector-python/issues)
[![Code Style: Black](https://img.shields.io/badge/code_style-black-black)](https://black.readthedocs.io/en/stable/)
[![Known Vulnerabilities](https://snyk.io/test/github/binance/binance-connector-python/badge.svg)](https://snyk.io/test/github/binance/binance-connector-python)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

Collection of auto-generated Python SDK for Binance APIs.

## Prerequisites

Before using the SDK, ensure you have:

- **Python** (version 3.10 or later)
- **pip** (Python package manager)
- **poetry** (Python package manager)


## Available SDK

- [binance-sdk-algo](./clients/algo) - Algo Trading connector (Pypi package: [`binance-sdk-algo`](https://pypi.org/project/binance-sdk-algo/))
- [binance-sdk-alpha](./clients/alpha/) - Alpha connector (Pypi package: [`binance-sdk-alpha`](https://pypi.org/project/binance-sdk-alpha/))
- [binance-sdk-c2c](./clients/c2c/) - C2C connector (Pypi package: [`binance-sdk-c2c`](https://pypi.org/project/binance-sdk-c2c/))
- [binance-sdk-convert](./clients/convert/) - Convert connector (Pypi package: [`binance-sdk-convert`](https://pypi.org/project/binance-sdk-convert/))
- [binance-sdk-copy-trading](./clients/copy_trading/) - Copy Trading connector (Pypi package: [`binance-sdk-copy-trading`](https://pypi.org/project/binance-sdk-copy-trading/))
- [binance-sdk-crypto-loan](./clients/crypto_loan/) - Crypto Loan connector (Pypi package: [`binance-sdk-crypto-loan`](https://pypi.org/project/binance-sdk-crypto-loan/))
- [binance-sdk-derivatives-trading-coin-futures](./clients/derivatives_trading_coin_futures/) - Coin Futures Trading connector (Pypi package: [`binance-sdk-derivatives-trading-coin-futures`](https://pypi.org/project/binance-sdk-derivatives-trading-coin-futures/))
- [binance-sdk-derivatives-trading-options](./clients/derivatives_trading_options/) - Options Trading connector (Pypi package: [`binance-sdk-derivatives-trading-options`](https://pypi.org/project/binance-sdk-derivatives-trading-options/))
- [binance-sdk-derivatives-trading-portfolio-margin](./clients/derivatives_trading_portfolio_margin/) - Portfolio Margin Futures Trading connector (Pypi package: [`binance-sdk-derivatives-trading-portfolio-margin`](https://pypi.org/project/binance-sdk-derivatives-trading-portfolio-margin/))
- [binance-sdk-derivatives-trading-portfolio-margin-pro](./clients/derivatives_trading_portfolio_margin_pro/) - Portfolio Margin Pro Trading connector (Pypi package: [`binance-sdk-derivatives-trading-portfolio-margin-pro`](https://pypi.org/project/binance-sdk-derivatives-trading-portfolio-margin-pro/))
- [binance-sdk-derivatives-trading-usds-futures](./clients/derivatives_trading_usds_futures/) - USDs Futures Trading connector (Pypi package: [`binance-sdk-derivatives-trading-usds-futures`](https://pypi.org/project/binance-sdk-derivatives-trading-usds-futures/))
- [binance-sdk-dual-investment](./clients/dual_investment/) - Dual Investment connector (Pypi package: [`binance-sdk-dual-investment`](https://pypi.org/project/binance-sdk-dual-investment/))
- [binance-sdk-fiat](./clients/fiat/) - Fiat connector (Pypi package: [`binance-sdk-fiat`](https://pypi.org/project/binance-sdk-fiat/))
- [binance-sdk-gift-card](./clients/gift_card/) - Gift Card connector (Pypi package: [`binance-sdk-gift-card`](https://pypi.org/project/binance-sdk-gift-card/))
- [binance-sdk-margin-trading](./clients/margin_trading/) - Margin Trading connector (Pypi package: [`binance-sdk-margin-trading`](https://pypi.org/project/binance-sdk-margin-trading/))
- [binance-sdk-mining](./clients/mining/) - Mining connector (Pypi package: [`binance-sdk-mining`](https://pypi.org/project/binance-sdk-mining/))
- [binance-sdk-nft](./clients/nft/) - NFT connector (Pypi package: [`binance-sdk-nft`](https://pypi.org/project/binance-sdk-nft/))
- [binance-sdk-pay](./clients/pay/) - Pay connector (Pypi package: [`binance-sdk-pay`](https://pypi.org/project/binance-sdk-pay/))
- [binance-sdk-rebate](./clients/rebate/) - Rebate connector (Pypi package: [`binance-sdk-rebate`](https://pypi.org/project/binance-sdk-rebate/))
- [binance-sdk-simple-earn](./clients/simple_earn/) - Simple Earn connector (Pypi package: [`binance-sdk-simple-earn`](https://pypi.org/project/binance-sdk-simple-earn/))
- [binance-sdk-spot](./clients/spot/) - Spot Trading connector (Pypi package: [`binance-sdk-spot`](https://pypi.org/project/binance-sdk-spot/))
- [binance-sdk-staking](./clients/staking/) - Staking connector (Pypi package: [`binance-sdk-staking`](https://pypi.org/project/binance-sdk-staking/))
- [binance-sdk-sub-account](./clients/sub_account/) - Sub Account connector (Pypi package: [`binance-sdk-sub-account`](https://pypi.org/project/binance-sdk-sub-account/))
- [binance-sdk-vip-loan](./clients/vip_loan/) - VIP Loan connector (Pypi package: [`binance-sdk-vip-loan`](https://pypi.org/project/binance-sdk-vip-loan/))
- [binance-sdk-wallet](./clients/wallet/) - Wallet connector (Pypi package: [`binance-sdk-wallet`](https://pypi.org/project/binance-sdk-wallet/))

## Documentation

For detailed information, refer to the [Binance API Documentation](https://developers.binance.com).

## Installation

Each connector is published as a separate Python package. You can install them via `pip` or `poetry`. For example:

```bash
pip install binance-sdk-spot
```

```bash
poetry add binance-sdk-spot
```

Or to install multiple connectors:

```bash
pip install binance-sdk-spot binance-sdk-margin-trading binance-sdk-staking
```

```bash
poetry add binance-sdk-spot binance-sdk-margin-trading binance-sdk-staking
```

## 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

## Code Style

This repository follows **PEP 8** standards and enforces **Black** for formatting. Before submitting a pull request, format your code:

```bash
black .
```

Run type checks:

```bash
mypy .
```

## 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.

## License

This project is licensed under the MIT License - see the [LICENSE](./LICENCE) file for details.