Binance
Introduction
QuantConnect enables you to run your algorithms in live mode with real-time market data. We have successfully hosted more than 200,000 live algorithms and have had more than $22B in volume traded on our servers since 2015.
Binance was founded by Changpeng Zhao in 2017 with the goal to "increase the freedom of money globally". Binance provides access to trading Crypto through spot markets and perpetual Futures. They serve clients with no minimum deposit when depositing Crypto. Binance also provides an NFT marketplace, a mining pool, and services to deposit Crypto coins in liquidity pools to earn rewards.
To view the implementation of the Binance brokerage integration, see the Lean.Brokerages.Binance repository.
Account Types
Binance supports cash and margin accounts for spot trades, but only supports margin accounts for Futures trades. Binance US only supports cash accounts. To set the account type in an algorithm, see the Binance brokerage model documentation.
Create an Account
Follow the account creation wizard on the Binance.com or Binance.us website to create a Binance account.
You will need API credentials to deploy live algorithms with your brokerage account. After you open your account, create API credentials and store them somewhere safe. As you create credentials, make the following configurations:
- Select the Restrict access to trusted IPs only check box and then enter our IP address, 146.59.85.21.
- If you are going to trade Crypto Futures, select the Enable Futures check box.
Paper Trading
Binance supports paper trading through the Binance Spot Test Network. You don't need a Binance account to create API credentials for the Spot Test Network.
Follow these steps to set up paper trading with the Binance Spot Test Network:
- Log in to the Binance Spot Test Network with your GitHub credentials.
- In the API Keys section, click Generate HMAC_SHA256 Key.
- Enter a description and then click Generate.
- Store your API key and API key secret somewhere safe.
Paper trading Binance Crypto Futures or with Binance US isn't currently available.
Sub-Accounts
Our Binance and Binance US integrations don't support trading with sub-accounts. You must use your main account.
Orders
We model the Binance and Binance US APIs by supporting several order types, supporting order properties, and not supporting order updates. When you deploy live algorithms, you can place manual orders through the IDE.
Order Types
The following table describes the available order types for each asset class that our Binance and Binance US integrations support:
| Order Type | Crypto | Crypto Futures |
|---|---|---|
| Market |  | |
| Limit | | |
| Stop limit | |
Order Properties
We model custom order properties from the Binance and Binance US APIs. The following table describes the members of the BinanceOrderProperties object that you can set to customize order execution:
| Property | Data Type | Description | Default Value |
|---|---|---|---|
TimeInForcetime_in_force | TimeInForce | A TimeInForce instruction to apply to the order. The following instructions are supported:
| TimeInForce.GoodTilCanceledTimeInForce.GOOD_TIL_CANCELED |
PostOnlypost_only | bool | A flag to signal that the order must only add liquidity to the order book and not take liquidity from the order book. If part of the order results in taking liquidity rather than providing liquidity, the order is rejected without any part of it being filled. |
Updates
We model the Binance and Binance US APIs by not supporting order updates, but you can cancel an existing order and then create a new order with the desired arguments. For more information about this workaround, see the Workaround for Brokerages That Don’t Support Updates.
Fees
To view the Binance or Binance US trading fees, see the Trading Fees page on the Binance.com website or the Fee Structure page on the Binance.us website. To view how we model their fees, see Fees. The Binance Spot Test Network does not charge order fees.
Margin
We model buying power and margin calls to ensure your algorithm stays within the margin requirements. If you trade Crypto Perpetual Futures, we model the margin cost and payments of your Crypto Future holdings by directly adjusting your portfolio cash. For more information about Futures margin interest modeling, see the Binance Futures Model.
Fills
We fill market orders immediately and completely in backtests. In live trading, if the quantity of your market orders exceeds the quantity available at the top of the order book, your orders are filled according to what is available in the order book.
To view how we model Binance and Binance US order fills, see Fills.
Virtual Pairs
All fiat and Crypto currencies are individual assets. When you buy a pair like BTCUSD, you trade USD for BTC. In this case, LEAN removes some USD from your portfolio cashbook and adds some BTC. The virtual pair BTCUSD represents your position in that trade, but the virtual pair doesn't actually exist. It simply represents an open trade. When you deploy a live algorithm, LEAN populates your cashbook with the quantity of each currency, but it can't get your position of each virtual pair.
Deploy Live Algorithms
You must have an available live trading node for each live trading algorithm you deploy.
Follow these steps to deploy a live algorithm:
- Open the project you want to deploy.
- Click the
Deploy Live icon. - On the Deploy Live page, click the Brokerage field and then click Binance Exchange from the drop-down menu.
- Enter your API key and secret.
- Click on the Environment field and then click one of the environments.
- Click the Node field and then click the live trading node that you want to use from the drop-down menu.
- (Optional) In the Data Provider section, click Show and change the data provider or add additional providers.
- If your brokerage account has existing cash holdings, follow these steps (see video):
- In the Algorithm Cash State section, click Show.
- Click Add Currency.
- Enter the currency ticker (for example, USD or CAD) and a quantity.
- If your brokerage account has existing position holdings, follow these steps (see video):
- In the Algorithm Holdings State section, click Show.
- Click Add Holding.
- Enter the symbol ID, symbol, quantity, and average price.
- (Optional) Set up notifications.
- Configure the Automatically restart algorithm setting.
- Click Deploy.
To generate your API credentials, see Account Types. Your account details are not saved on QuantConnect.
The following table shows the supported environments:
| Environment | Description |
|---|---|
| Real | Trade with real money |
| Demo | Trade with paper money through the Binance Global brokerage |
By enabling automatic restarts, the algorithm will use best efforts to restart the algorithm if it fails due to a runtime error. This can help improve the algorithm's resilience to temporary outages such as a brokerage API disconnection.
The deployment process can take up to 5 minutes. When the algorithm deploys, the live results page displays. If you know your brokerage positions before you deployed, you can verify they have been loaded properly by checking your equity value in the runtime statistics, your cashbook holdings, and your position holdings.
You can also see our Videos. You can also get in touch with us via Discord.
Did you find this page helpful?
Contribute to the documentation: 
