Skip to content

Latest commit

 

History

History
105 lines (65 loc) · 2.83 KB

MIGRATION.md

File metadata and controls

105 lines (65 loc) · 2.83 KB

Migration Guide: Transition from Monolithic Binance Connector

With the move towards modularization, Binance connectors are now split into smaller, product-specific libraries. This guide explains how to migrate from the monolithic binance-connector package to the new modular connectors.

Overview of Changes

Feature Monolithic Connector Modular Connector
Package Name binance-connector binance-sdk-<product>
API Coverage All Binance APIs Individual APIs (Spot, Wallet, Algo Trading, Mining, etc.)
Imports Single package import Separate package per product
Code Structure One large client Smaller, focused clients

Migration Steps

Step 1: Uninstall the Monolithic Connector

If you were using the old connector, remove it from your project:

pip uninstall binance-connector

Step 2: Install the New Modular Connectors

Install only the connector(s) you need. For example, to install the Spot Trading connector:

pip install binance-sdk-spot

To install multiple connectors:

pip install binance-sdk-spot binance-sdk-margin-trading binanc-sdk-wallet

Step 3: Update Imports

Update your import paths:

Old:

from binance.spot import Spot

New:

from binance_sdk_spot.spot import Spot

Step 4: Update Client Initialization

The new structure introduces a more modular approach to client initialization.

Old (Monolithic Connector):

from binance.spot import Spot

client = Spot(api_key, api_secret)
account_info = client.account()
print(account_info)

New (Modular Spot Connector):

from binance_common.configuration import ConfigurationRestAPI
from binance_sdk_spot.spot import Spot

configuration = ConfigurationRestAPI(api_key, api_secret)
client = Spot(config_rest_api=configuration)

account_info = client.rest_api.get_account()
print(account_info)

Step 5: Check for API Differences

Some function names or response structures may have changed. Refer to the modular connector's documentation for details.

Backward Compatibility

  • If a modular connector is not yet available for your use case, continue using the monolithic connector (binance-connector).
  • The monolithic connector will remain available, but it is recommended to migrate when modular versions are released.

FAQs

What if my product does not have a modular connector yet?

You can continue using binance-connector until the modular version is released.

Will the monolithic connector still receive updates?

Critical bug fixes will be provided, but feature updates will focus on the modular connectors.

Where can I find more examples?

Check the modular connector's documentation for detailed examples.