Brokerages

Coinbase

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. Brokerages supply a connection to the exchanges so that you can automate orders using LEAN. You can use multiple data feeds in live trading algorithms.

Coinbase was founded by Brian Armstrong and Fred Ehrsam in 2012 with the goal to "increase economic freedom in the world". Coinbase provides access to trading Crypto for clients in over 100 countries with no minimum deposit. Coinbase also provides a self-hosted Crypto wallet, a Visa debit rewards card, and Bitcoin collateral-backed lines of credit.

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

Account Types

Coinbase supports cash accounts.

SetBrokerageModel(BrokerageName.GDAX, AccountType.Cash);
self.SetBrokerageModel(BrokerageName.GDAX, AccountType.Cash)

Create an Account

Follow the Create a Coinbase account tutorial on the Coinbase website to create an account.

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

Paper Trading

Coinbase supports paper trading through the Coinbase Sandbox. You need a Coinbase account to paper trade in the Sandbox.

To create API credentials, log in to your Sandbox account and then follow the instructions for creating credentials for Coinbase. As you create credentials, enable View and Trade permissions.

After you create API credentials for your Sandbox account, follow these steps to add capital to your account:

  1. In the top navigation bar of the Sandbox, click Portfolios.
  2. On the Portfolios page, click Deposit.
  3. In the Deposit window, click the asset that you want to deposit into your account.
  4. Click Coinbase.com.
  5. In the Amount field, enter the quantity of the asset to deposit.
  6. Click Deposit.
  7. Click Done.

Asset Classes

Coinbase supports trading Crypto.

AddCrypto("BTCUSD", Resolution.Minute, Market.GDAX);
self.AddCrypto("BTCUSD", Resolution.Minute, Market.GDAX)

If you call the SetBrokerageModel method with the correct BrokerageName, then you don't need to pass a Market argument to the AddCrypto method because the brokerage model has a default market.

Assets Available

Refer to the Coinbase Crypto Price Data dataset to see the assets available.

Orders

We model the Coinbase API 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 Coinbase supports:

Order TypeCrypto
MarketOrdergreen check
LimitOrdergreen check
StopMarketOrdergreen check
Supported after 2019-03-23 in backtests. For reference, see the Coinbase Market Structure Update on the Coinbase website.
StopLimitOrdergreen check
MarketOrder(_symbol, quantity);
LimitOrder(_symbol, quantity, limitPrice);
StopMarketOrder(_symbol, quantity, stopPrice);
StopLimitOrder(_symbol, quantity, stopPrice, limitPrice);
self.MarketOrder(self.symbol, quantity)
self.LimitOrder(self.symbol, quantity, limit_price)
self.StopMarketOrder(self.symbol, quantity, stop_price)
self.StopLimitOrder(self.symbol, quantity, stop_price, limit_price)

Order Properties

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

PropertyDescription
TimeInForceA TimeInForce instruction to apply to the order. The GoodTilCanceled TimeInForce is supported.
PostOnlyA flag that signals 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.
public override void Initialize()
{
    // Set the default order properties
    DefaultOrderProperties = new GDAXOrderProperties
    {
        TimeInForce = TimeInForce.GoodTilCanceled,
        PostOnly = false
    };
}

public override void OnData(Slice slice)
{
    // Use default order order properties
    LimitOrder(_symbol, quantity, limitPrice);
    
    // Override the default order properties
    LimitOrder(_symbol, quantity, limitPrice, 
               orderProperties: new GDAXOrderProperties
               { 
                   TimeInForce = TimeInForce.GoodTilCanceled,
                   PostOnly = true
               });
}
def Initialize(self) -> None:
    # Set the default order properties
    self.DefaultOrderProperties = GDAXOrderProperties()
    self.DefaultOrderProperties.TimeInForce = TimeInForce.GoodTilCanceled
    self.DefaultOrderProperties.PostOnly = False

def OnData(self, slice: Slice) -> None:
    # Use default order order properties
    self.LimitOrder(self.symbol, quantity, limit_price)
    
    # Override the default order properties
    order_properties = GDAXOrderProperties()
    order_properties.TimeInForce = TimeInForce.GoodTilCanceled
    order_properties.PostOnly = True
    self.LimitOrder(self.symbol, quantity, limit_price, orderProperties=order_properties)

Updates

We model the Coinbase API by not supporting order updates, but you can cancel an existing order and then create a new order with the desired arguments.

var ticket = LimitOrder(_symbol, quantity, limitPrice);
ticket.Cancel();
ticket = LimitOrder(_symbol, newQuantity, newLimitPrice);
ticket = self.LimitOrder(self.symbol, quantity, limit_price)
ticket.Cancel()
ticket = self.LimitOrder(self.symbol, new_quantity, new_limit_price)

Fees

We model the order fees of Coinbase at the $50K-100K pricing tier for all Crypto pairs, which is a 0.5% maker and taker fee for most pairs. The following table shows the Coinbase Stable Pairs, which charge a 0% maker fee and a 0.1% taker fee:

Stable Pairs
DAIUSDCDAIUSDGYENUSDPAXUSD
PAXUSDTMUSDUSDUSDCEURUSDCGBP
USDTEURUSDTGBPUSDTUSDUSDTUSDC
USTEURUSTUSDUSTUSDTWBTCBTC

If you add liquidity to the order book by placing a limit order that doesn't cross the spread, you pay maker fees. If you remove liquidity from the order book by placing an order that crosses the spread, you pay taker fees. Coinbase adjusts your fees based on your 30-day trading volume, but we don't currently model trading volume to adjust fees.

We model the adjustments Coinbase has made to their fees over time. The following table shows the fees for each time period:

Time Period (UTC)Maker Fee (%)Taker Fee (%)
Time < 3/23/2019 1:30AM00.3
3/23/2019 1:30AM <= Time < 10/8/2019 12:30AM0.150.25
10/8/2019 12:30AM <= Time0.50.5

To check the latest fees at all the fee levels, see the What are the fees on Coinbase? page on the Coinbase website.

For default backtest fee model, see Coinbase Supported Models.

Margin

Coinbase does not support margin trading.

Slippage

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

For default backtest slippage model, see Coinbase Supported Models.

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.

For default fill model, see Coinbase Supported Models.

Settlements

Trades settle immediately after the transaction

security.SettlementModel = new ImmediateSettlementModel();
security.SettlementModel = ImmediateSettlementModel()

For default settlement model, see Coinbase Supported Models.

Security and Stability

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

We call the Coinbase API to place live trades. Sometimes the API may be down. Check the Coinbase status page to see if the API is currently working.

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 Coinbase 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 Coinbase from the drop-down menu.
  4. Enter your Coinbase API key, API secret, and passphrase.
  5. To generate your API credentials, see the Create an Account section in the Account Types documentation. Your account details are not saved on QuantConnect.

  6. Click on the Environment field and then click one of the environments.
  7. The following table shows the supported environments:

    EnvironmentDescription
    LiveTrade with real money
    PaperTrade with paper money
  8. Click the Node field and then click the live trading node that you want to use from the drop-down menu.
  9. (Optional) Set up notifications.
  10. Configure the Automatically restart algorithm setting.
  11. 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.

  12. 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: