🔥 Binance

Foundation Partner

Binance is an exchange partner of Hummingbot Foundation, so when you use Hummingbot to run bots on Binance, a portion of your fees goes to support the Foundation and our mission to democratize algo trading with open source software. To enable this, create an account using our Binance referral link and enter that account's API keys into Hummingbot and run bots! Thanks for your support! 🙏

🛠 Connector Info¶

Exchange Type: Centralized Exchange (CEX)
Market Type: Central Limit Order Book (CLOB)

Component	Status	Connector Version	V2 Strategies	Notes
🔀 Spot Connector	✅	v2.1	Yes	Supports `MARKET` order type
🔀 Perp Connector	✅	v2.1	Yes	Supports testnet
🕯 Spot Candles Feed	✅
🕯 Perp Candles Feed	✅
📓 Connector Guide	✅

ℹ️ Exchange Info¶

Website: https://www.binance.com
CoinMarketCap: https://coinmarketcap.com/exchanges/binance/
CoinGecko: https://www.coingecko.com/en/exchanges/binance
Fees: https://www.binance.com/en/fee/schedule
Supported Countries: https://www.binance.com/en/support/faq/115003824812
Binance referral link: https://accounts.binance.com/register?ref=CBWO4LU6

🔑 How to Connect¶

Tip

See the Binance Connector Guide for details on create API keys on Binance.

From inside the Hummingbot client, run connect binance:

>>> connect binance

Enter your binance API key >>>
Enter your binance secret key >>>

If connection is successful:

You are now connected to binance

🔀 Spot Connector¶

Integration to spot markets API endpoints

ID: binance
Connection Type: WebSocket
API Docs: https://binance-docs.github.io/apidocs/spot/en/
Github Folder

Order Types¶

This connector supports the following OrderType constants:

LIMIT
LIMIT_MAKER
MARKET

Paper Trading¶

Access the Paper Trade version of this connector by running connect binance_paper_trade instead of connect binance.

If this is not available by default, you can configure Hummingbot to add this paper trade exchange. See Adding Exchanges for more information.

🔀 Perp Connector¶

Integration to perpetual futures markets API endpoints

ID: binance_perpetual
Connection Type: WebSocket
Github Folder

Usage¶

From inside the Hummingbot client, run connect binance_perpetual:

>>> connect binance_perpetual

Enter your binance_perpetual API key >>>
Enter your binance_perpetual secret key >>>

If connection is successful:

You are now connected to binance_perpetual

Order Types¶

This connector supports the following OrderType constants:

LIMIT
LIMIT_MAKER
MARKET

Position Modes¶

This connector supports the following position modes:

One-way
Hedge

Paper Trading¶

This perp exchange offers a paper trading mode: https://testnet.binancefuture.com

Afer you create an account and create the API keys, you can enter them by using the connect binance_perpetual_testnet command within the Hummingbot client. Once connected, you should be able to use the testnet with the available perpetual strategies / scripts.

🕯 Spot Candles Feed¶

OHLCV candles data collector from spot markets

ID: binance
Supported Intervals: 1s | 1m | 3m | 5m | 15m | 30m | 1h | 2h | 4h | 6h | 8h | 12h | 1d | 3d | 1w | 1M
API Docs: https://binance-docs.github.io/apidocs/futures/en/
Github Folder

Usage¶

In a Hummingbot script, import CandlesFactory to create the candles that you want:

    from hummingbot.data_feed.candles_feed.candles_factory import CandlesFactory
    candles = CandlesFactory.get_candle(connector="binance",
                                        trading_pair="ETH-USDT",
                                        interval="1m", max_records=50)

See candles_example.py for more details.

🕯 Perp Candles Feed¶

OHLCV candles data collector from perpetual futures markets

ID: binance_perpetual
Supported Intervals: 1s | 1m | 3m | 5m | 15m | 30m | 1h | 2h | 4h | 6h | 8h | 12h | 1d | 3d | 1w | 1M
Github Folder

Usage¶

In a Hummingbot script, import CandlesFactory to create the candles that you want:

    from hummingbot.data_feed.candles_feed.candles_factory import CandlesFactory
    candles = CandlesFactory.get_candle(connector="binance_perpetual",
                                        trading_pair=trading_pair,
                                        interval="3m", max_records=50)

See candles_example.py for more details.