--- title: "lean cloud live deploy" description: "API reference for the command `lean cloud live deploy` in command line console." canonical: https://www.quantconnect.com/docs/v2/lean-cli/api-reference/lean-cloud-live-deploy markdown: https://www.quantconnect.com/docs/v2/lean-cli/api-reference/lean-cloud-live-deploy.md language: python source: https://github.com/QuantConnect/Documentation/tree/master/05%20Lean%20CLI/99%20API%20Reference/07%20lean%20cloud%20live%20deploy modified: 2026-10-28 index: https://www.quantconnect.com/llms.txt --- # lean cloud live deploy [Documentation](https://www.quantconnect.com/docs/v2.md) > [Lean CLI](https://www.quantconnect.com/docs/v2/lean-cli.md) > [API Reference](https://www.quantconnect.com/docs/v2/lean-cli/api-reference.md) > lean cloud live deploy > Code examples are shown in Python. Append `?lang=csharp` to this URL for the C# version of this page. ## Introduction Start live trading for a project in the cloud. ``` $ lean cloud live deploy [OPTIONS] PROJECT ``` To use the CLI, you must be a member in an [organization](https://www.quantconnect.com/docs/v2/cloud-platform/organizations/tier-features.md) on a paid tier. ## Description Starts live trading for a cloud project. Before starting live trading, the CLI shows an interactive wizard letting you configure the brokerage, data provider, live node, and notifications. After starting live trading, the CLI displays a URL to the live results. You can use the `--open` flag to automatically open this URL in the browser once the deployment starts. If you specify the `--brokerage` and `--data-provider-live` options, the interactive wizard is skipped and the command runs in non-interactive mode. In this mode, the command doesn't prompt for input or confirmation and reads all configuration from the provided command-line options. In non-interactive mode, all options specific to the selected brokerage become required, as well as `--node`, `--auto-restart`, `--notify-order-events`, and `--notify-insights`. In case a required option has not been provided, the command falls back to the property with the same name in your [Lean configuration file](https://www.quantconnect.com/docs/v2/lean-cli/initialization/configuration.md#03-Lean-Configuration). The command aborts if this property also hasn't been set. The following options are required for each brokerage in non-interactive mode: | `--brokerage` | Required Options | | --- | --- | | `"Paper Trading"` | N/A | | `Alpaca` | `--alpaca-environment` | | `Alpaca` | `--alpaca-api-key` | | `Alpaca` | `--alpaca-api-secret` | | `Binance` | `--binance-exchange-name` | | `Binance` | `--binance-api-key` or `--binanceus-api-key` | | `Binance` | `--binance-api-secret` or `--binanceus-api-secret` | | `Binance` | `--binance-use-testnet` | | `Bitfinex` | `--bitfinex-api-key` | | `Bitfinex` | `--bitfinex-api-secret` | | `Bybit` | `--bybit-api-key` | | `Bybit` | `--bybit-api-secret` | | `Bybit` | `--bybit-vip-level` | | `"Coinbase Advanced Trade"` | `--coinbase-api-name` | | `"Coinbase Advanced Trade"` | `--coinbase-api-private-key` | | `"Interactive Brokers"` | `--ib-user-name` | | `"Interactive Brokers"` | `--ib-account` | | `"Interactive Brokers"` | `--ib-password` | | `Kraken` | `--kraken-api-key` | | `Kraken` | `--kraken-api-secret` | | `Kraken` | `--kraken-verification-tier` | | `Oanda` | `--oanda-account-id` | | `Oanda` | `--oanda-access-token` | | `Oanda` | `--oanda-environment` | | `Samco` | `--samco-client-id` | | `Samco` | `--samco-client-password` | | `Samco` | `--samco-year-of-birth` | | `Samco` | `--samco-product-type` | | `Samco` | `--samco-trading-segment` | | `TDAmeritrade` | `--tdameritrade-api-key` | | `TDAmeritrade` | `--tdameritrade-access-token` | | `TDAmeritrade` | `--tdameritrade-account-number` | | `"Quant Bridge"` | `--quant-bridge-server-auth-id` | | `"Quant Bridge"` | `--quant-bridge-environment` | | `"Quant Bridge"` | `--quant-bridge-server-host` | | `"Quant Bridge"` | `--quant-bridge-server-port` | | `"Quant Bridge"` | `--quant-bridge-emsx-account` | | `"Quant Bridge"` | `--quant-bridge-emsx-broker` | | `"Quant Bridge"` | `--quant-bridge-openfigi-api-key` | | `TradeStation` | `--trade-station-environment` | | `TradeStation` | `--trade-station-account-type` | | `Tradier` | `--tradier-account-id` | | `Tradier` | `--tradier-access-token` | | `Tradier` | `--tradier-environment` | | `"Trading Technologies"` | `--tt-user-name` | | `"Trading Technologies"` | `--tt-session-password` | | `"Trading Technologies"` | `--tt-account-name` | | `"Trading Technologies"` | `--tt-rest-app-key` | | `"Trading Technologies"` | `--tt-rest-app-secret` | | `"Trading Technologies"` | `--tt-rest-environment` | | `"Trading Technologies"` | `--tt-order-routing-sender-comp-id` | | `Zerodha` | `--zerodha-api-key` | | `Zerodha` | `--zerodha-access-token` | | `Zerodha` | `--zerodha-product-type` | | `Zerodha` | `--zerodha-trading-segment` | | `Zerodha` | `--zerodha-history-subscription` | The `--data-provider-live` option is required. The following table shows the available live data providers and their required options in non-interactive mode. To select multiple data providers, seperate them with a comma. The order you select them in defines the order of precedence. | `--data-provider-live` | Required Options | | --- | --- | | `Alpaca` | All options required by `--brokerage Alpaca`. | | `Binance` | `--binance-exchange-name` | | `Binance` | `--binance-api-key` or `--binanceus-api-key` | | `Binance` | `--binance-api-secret` or `--binanceus-api-secret` | | `Bitfinex` | All options required by `--brokerage Bitfinex`. | | `Bybit` | All options required by `--brokerage Bybit`. | | `CoinApi` | `--coinapi-api-key` | | `CoinApi` | `--coinapi-product` | | `"Coinbase Advanced Trade"` | `--coinbase-api-name` | | `"Coinbase Advanced Trade"` | `--coinbase-api-private-key` | | `IEX` | `--iex-cloud-api-key` | | `IEX` | `--iex-price-plan` | | `"Interactive Brokers"` | All options required by `--brokerage "Interactive Brokers"`. | | `Kraken` | All options required by `--brokerage Kraken`. | | `Oanda` | `--oanda-account-id` | | `Oanda` | `--oanda-access-token` | | `Polygon` | `--polygon-api-key` | | `QuantConnect` | N/A | | `Samco` | All options required by `--brokerage Samco`. | | `TDAmeritrade` | All options required by `--brokerage TDAmeritrade`. | | `"Quant Bridge"` | All options required by `--brokerage "Quant Bridge"`. | | `TradeStation` | All options required by `--brokerage TradeStation`. | | `Tradier` | `--tradier-account-id` | | `Tradier` | `--tradier-access-token` | | `"Trading Technologies"` | `--tt-user-name` | | `"Trading Technologies"` | `--tt-session-password` | | `"Trading Technologies"` | `--tt-account-name` | | `"Trading Technologies"` | `--tt-rest-app-key` | | `"Trading Technologies"` | `--tt-rest-app-secret` | | `"Trading Technologies"` | `--tt-rest-environment` | | `"Trading Technologies"` | `--tt-order-routing-sender-comp-id` | | `Zerodha` | All options required by `--brokerage Zerodha`. | | `Zerodha` | `--zerodha-history-subscription` | If you omit some of the required options when running in non-interactive mode, the CLI uses the option values in your [LEAN configuration file](https://www.quantconnect.com/docs/v2/lean-cli/initialization/configuration.md#03-Lean-Configuration). Example non-interactive usage: ``` $ lean cloud live deploy "My Project" \ --brokerage "Paper Trading" \ --data-provider-live QuantConnect \ --node "My Node" \ --auto-restart yes --notify-order-events no \ --notify-insights no \ --push \ --open ``` If you have a local copy of the cloud project, you can use the `--push` option to push local modifications to the cloud before starting live trading. ## Arguments The `lean cloud live deploy` command expects the following arguments: | Argument | Description | | --- | --- | | `` | The name or Id of the project to start live trading. | ## Options The `lean cloud live deploy` command supports the following options: | Option | Description | | --- | --- | | `--brokerage ` | The brokerage to use | | `--data-provider-live ` | The live data provider to use | | `--ib-user-name ` | Your Interactive Brokers username | | `--ib-account ` | Your Interactive Brokers account id | | `--ib-password ` | Your Interactive Brokers password | | `--ib-host ` | External Interactive Brokers Gateway Host (Optional) | | `--ib-port ` | External Interactive Brokers Gateway Port (Optional) | | `--ib-weekly-restart-utc-time ` | Weekly restart UTC time (hh:mm:ss). Each week on Sunday your algorithm is restarted at this time, and will require 2FA verification. This is required by Interactive Brokers. Use this option explicitly to override the default value. (Optional) | | `--ib-financial-advisors-group-filter ` | Use this field to filter data by a specific financial advisor group within your Interactive Brokers account. Leave blank to include all groups. (Optional) | | `--tradier-account-id ` | Your Tradier account id | | `--tradier-access-token ` | Your Tradier access token | | `--tradier-environment ` | Whether the developer sandbox should be used | | `--oanda-account-id ` | Your OANDA account id | | `--oanda-access-token ` | Your OANDA API token | | `--oanda-environment ` | The environment to run in, Practice for fxTrade Practice, Trade for fxTrade | | `--bitfinex-api-key ` | Your Bitfinex API key | | `--bitfinex-api-secret ` | Your Bitfinex API secret | | `--coinbase-api-name ` | Your Coinbase Advanced Trade API name from file | | `--coinbase-api-private-key ` | Your Coinbase Advanced Trade API private key from file | | `--binance-exchange-name ` | Binance exchange name [Binance, BinanceUS, Binance-USDM-Futures, Binance-COIN-Futures] | | `--binance-api-key ` | Your Binance API key | | `--binanceus-api-key ` | Your Binance API key | | `--binance-api-secret ` | Your Binance API secret | | `--binanceus-api-secret ` | Your Binance API secret | | `--binance-use-testnet ` | Whether the testnet should be used | | `--zerodha-api-key ` | Your Kite Connect API key | | `--zerodha-access-token ` | Your Kite Connect access token | | `--zerodha-product-type ` | MIS if you are targeting intraday products, CNC if you are targeting delivery products, NRML if you are targeting carry forward products | | `--zerodha-trading-segment ` | EQUITY if you are trading equities on NSE or BSE, COMMODITY if you are trading commodities on MCX | | `--zerodha-history-subscription ` | Whether you have a history API subscription for Zerodha | | `--samco-client-id ` | Your Samco account Client ID | | `--samco-client-password ` | Your Samco account password | | `--samco-year-of-birth ` | Your year of birth (YYYY) registered with Samco | | `--samco-product-type ` | MIS if you are targeting intraday products, CNC if you are targeting delivery products, NRML if you are targeting carry forward products | | `--samco-trading-segment ` | EQUITY if you are trading equities on NSE or BSE, COMMODITY if you are trading commodities on MCX | | `--quant-bridge-server-auth-id ` | The Auth ID of the QuantBridge server | | `--quant-bridge-environment ` | The environment to run in | | `--quant-bridge-server-host ` | The host of the EMSX API Server | | `--quant-bridge-server-port ` | The port of the EMSX API Server | | `--quant-bridge-emsx-broker ` | The EMSX broker to use (Optional) | | `--quant-bridge-emsx-account ` | The EMSX account to use (Optional) | | `--quant-bridge-emsx-team ` | The EMSX team to receive order events from (Optional) | | `--quant-bridge-openfigi-api-key ` | The Open FIGI API key to use for mapping options | | `--tt-user-name ` | Your Trading Technologies username | | `--tt-session-password ` | Your Trading Technologies session password | | `--tt-account-name ` | Your Trading Technologies account name | | `--tt-rest-app-key ` | Your Trading Technologies REST app key | | `--tt-rest-app-secret ` | Your Trading Technologies REST app secret | | `--tt-rest-environment ` | The REST environment to run in | | `--tt-order-routing-sender-comp-id ` | The order routing sender comp id to use | | `--kraken-api-key ` | Your Kraken API key | | `--kraken-api-secret ` | Your Kraken API secret | | `--kraken-verification-tier ` | Your Kraken Verification Tier | | `--charles-schwab-user-name ` | Your Charles Schwab login ID | | `--charles-schwab-account-number ` | The CharlesSchwab account number | | `--bybit-api-key ` | Your Bybit API key | | `--bybit-api-secret ` | Your Bybit API secret | | `--bybit-vip-level ` | Your Bybit VIP Level | | `--bybit-use-testnet ` | Whether the testnet should be used | | `--trade-station-environment ` | Whether Live or Paper environment should be used | | `--trade-station-account-id ` | The TradeStation account Id | | `--alpaca-environment ` | Whether Live or Paper environment should be used | | `--tastytrade-account-number ` | The Tastytrade account number | | `--eze-domain ` | Examples (broker provided): LIGHTSPEED, LIGHTSPEEDDELAY | | `--eze-locale ` | Examples (broker provided): GLOBAL, AMERICAS, LIVE, DELAYED | | `--eze-user-name ` | Your Eze Brokers username | | `--eze-password ` | Your Eze Brokers password | | `--eze-trading-account ` | Format: BANK;BRANCH;CUSTOMER;DEPOSIT | | `--dydx-private-key-hex ` | Your dYdX API private key in hex format | | `--dydx-address ` | Your dYdX wallet address | | `--dydx-subaccount-number ` | Your dYdX subaccount number | | `--dydx-environment ` | Whether the developer sandbox should be used | | `--webull-environment ` | Whether Live or Paper environment should be used | | `--webull-app-key ` | Your Webull App Key | | `--webull-app-secret ` | Your Webull App Secret | | `--webull-account-id ` | Your Webull account id | | `--webull-use-2fa ` | Whether two-factor authentication (2FA) should be used (Optional) | | `--public-secret-key ` | Your Public.com API secret key | | `--public-account-number ` | Your Public.com account number. Public lets you have more than one account, so this picks which one to trade | | `--clearstreet-access-token ` | Your Clear Street API access token | | `--clearstreet-account-id ` | Your Clear Street account id, the numeric id of the account the algorithm trades | | `--polygon-api-key ` | Your Polygon.io API Key | | `--polygon-license-type ` | Select your Polygon.io subscription plan (Optional) | | `--coinapi-api-key ` | Your coinapi.io Api Key | | `--coinapi-product ` | CoinApi pricing plan (https://www.coinapi.io/market-data-api/pricing) | | `--alpaca-api-key ` | Your Alpaca Api Key | | `--alpaca-api-secret ` | Your Alpaca Api Secret | | `--node ` | The name or id of the live node to run on | | `--auto-restart ` | Whether automatic algorithm restarting must be enabled | | `--notify-order-events ` | Whether notifications must be sent for order events | | `--notify-insights ` | Whether notifications must be sent for emitted insights | | `--notify-emails ` | A comma-separated list of 'email:subject' pairs configuring email-notifications. Wrap a subject containing ',' in double quotes, e.g. 'a@x.com:"Fills, orders"' | | `--notify-webhooks ` | A comma-separated list of 'url:HEADER_1=VALUE_1:HEADER_2=VALUE_2:etc' pairs configuring webhook-notifications. Wrap a url (with ',' or a ':' outside its scheme and port) or a header (with ':' or ',') in double quotes, e.g. '"https://x.com/hook?t=1:2":"Auth=Bearer a:b"' | | `--notify-sms ` | A comma-separated list of phone numbers configuring SMS-notifications | | `--notify-telegram ` | A comma-separated list of 'user/group Id:token(optional)' pairs configuring telegram- notifications. Wrap a token containing ',' in double quotes | | `--live-cash-balance ` | A comma-separated list of currency:amount pairs of initial cash balance | | `--live-holdings ` | A comma-separated list of symbol:symbolId:quantity:averagePrice of initial portfolio holdings | | `--push` | Push local modifications to the cloud before starting live trading | | `--open` | Automatically open the live results in the browser once the deployment starts | | `--show-secrets` | Show secrets as they are input | | `--no-browser` | Display OAuth URL without opening the browser | | `--verbose` | Enable debug logging | | `--help` | Display the help text of the `lean cloud live deploy` command and exit |