Brokerages

Bybit

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.

Bybit was co-founded by Ben Zhou in March 2018 with the goal to offer a professional platform where Crypto traders can find an ultra-fast matching engine, excellent customer service, and multilingual community support. Bybit provides access to trading Crypto and Crypto Futures for clients outside of excluded jurisdictions with low minimum deposits to set up an account. For more information about Crypto and fiat deposits, see the Bybit documentation. Bybit also provides Crypto staking, initial DEX offerings, and community airdrops.

To view the implementation of the Bybit brokerage integration, see the Lean.Brokerages.Bybit repository.

Account Types

Bybit supports cash and margin accounts. To set the account type in an algorithm, see the Bybit brokerage model documentation.

Create an Account

Follow the How to Register an Account tutorial on the Bybit website to create a Bybit account.

You will need API credentials to deploy live algorithms. After you have an account, create API credentials and store them somewhere safe.

Paper Trading

Our integration doesn't support paper trading through the Bybit Demo Trading environment, but you can follow these steps to simulate it:

  1. In the Initialize method of your algorithm, set the Bybit brokerage model.
  2. Deploy your algorithm with the QuantConnect Paper Trading brokerage.

Asset Classes

Our Bybit integration supports trading Crypto and Crypto Futures.

Data Providers

The QuantConnect data provider provides Crypto data during live trading.

Orders

We model the Bybit API by supporting several order types, order properties, and 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 Bybit integration supports:

Order TypeCryptoCrypto Futures
MarketOrdergreen checkgreen check
LimitOrdergreen checkgreen check
StopMarketOrdergreen checkgreen check
StopLimitOrdergreen checkgreen check

Order Properties

We model custom order properties from the Bybit API. The following table describes the members of the BybitBrokerageModel object that you can set to customize order execution:

PropertyDescription
TimeInForce A TimeInForce instruction to apply to the order. The following instructions are supported:
  • Day
  • GoodTilCanceled
  • GoodTilDate
PostOnlyA 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. This order property is only available for limit orders.
ReduceOnlyA flag to signal that the order must only reduce your current position size. For more information about this order property, see Reduce-Only Order on the Bybit website.

Updates

We model the Bybit API by supporting order updates for Crypto Future assets that have one of the following order states:

  • OrderStatus.New
  • OrderStatus.PartiallyFilled
  • OrderStatus.Submitted
  • OrderStatus.UpdateSubmitted

In cases where you can't update an order, you can cancel the 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 Bybit trading fees, see the Trading Fees Schedule page on the Bybit website. To view how we model their fees, see Fees.

Margin

We model buying power and margin calls to ensure your algorithm stays within the margin requirements.

Slippage

Orders through Bybit do not experience slippage in backtests. In paper trading and live trading, your orders may experience slippage.

To view how we model Bybit slippage, see Slippage.

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 Bybit order fills, see Fills.

Settlements

Trades settle immediately after the transaction

To view how we model settlement for Bybit trades, see Settlement.

Security and Stability

When you deploy live algorithms with Bybit, we don't save your brokerage account credentials.

Deposits and Withdraws

You can deposit and withdraw cash from your brokerage account while you run an algorithm that's connected to the account. We sync the algorithm's cash holdings with the cash holdings in your brokerage account every day at 7:45 AM Eastern Time (ET).

Demo Algorithm

The following algorithm demonstrates the functionality of the Bybit brokerage:

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:

  1. Open the project you want to deploy.
  2. Click the Lightning icon Deploy Live icon.
  3. On the Deploy Live page, click the Brokerage field and then click Bybit Exchange from the drop-down menu.
  4. Enter your API key and secret.
  5. To generate your API credentials, see Account Types. Your account details are not saved on QuantConnect.

  6. Click the VIP Level field and then click your level from the drop-down menu.
  7. For more information about VIP levels, see FAQ — Bybit VIP Program on the Bybit website.

  8. Click the Node field and then click the live trading node that you want to use from the drop-down menu.
  9. If your brokerage account has existing position holdings, follow these steps (see video):
    1. In the Algorithm Holdings State section, click Show.
    2. Click Add Holding.
    3. Enter the symbol ID, symbol, quantity, and average price.
  10. (Optional) Set up notifications.
  11. Configure the Automatically restart algorithm setting.
  12. 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.

  13. Click Deploy.

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: