---
title: "API Reference"
description: "API reference for command lines supported by Lean CLI."
canonical: https://www.quantconnect.com/docs/v2/lean-cli/api-reference
markdown: https://www.quantconnect.com/docs/v2/lean-cli/api-reference.md
language: python
source: https://github.com/QuantConnect/Documentation/tree/master/05%20Lean%20CLI/99%20API%20Reference
modified: 2026-10-29
index: https://www.quantconnect.com/llms.txt
---

# API Reference

[Documentation](https://www.quantconnect.com/docs/v2.md) > [Lean CLI](https://www.quantconnect.com/docs/v2/lean-cli.md) > API Reference

> Code examples are shown in Python. Append `?lang=csharp` to this URL for the C# version of this page.

The Lean CLI is a cross-platform CLI which makes it easier to develop with the LEAN engine locally and in the cloud. You can use any of the following commands. Click one to learn more.

- [lean backtest](https://www.quantconnect.com/docs/v2/lean-cli/api-reference/lean-backtest.md)
- [lean build](https://www.quantconnect.com/docs/v2/lean-cli/api-reference/lean-build.md)
- [lean cloud backtest](https://www.quantconnect.com/docs/v2/lean-cli/api-reference/lean-cloud-backtest.md)
- [lean cloud live](https://www.quantconnect.com/docs/v2/lean-cli/api-reference/lean-cloud-live.md)
- [lean cloud live broadcast](https://www.quantconnect.com/docs/v2/lean-cli/api-reference/lean-cloud-live-broadcast.md)
- [lean cloud live command](https://www.quantconnect.com/docs/v2/lean-cli/api-reference/lean-cloud-live-command.md)
- [lean cloud live deploy](https://www.quantconnect.com/docs/v2/lean-cli/api-reference/lean-cloud-live-deploy.md)
- [lean cloud live liquidate](https://www.quantconnect.com/docs/v2/lean-cli/api-reference/lean-cloud-live-liquidate.md)
- [lean cloud live stop](https://www.quantconnect.com/docs/v2/lean-cli/api-reference/lean-cloud-live-stop.md)
- [lean cloud object-store delete](https://www.quantconnect.com/docs/v2/lean-cli/api-reference/lean-cloud-object-store-delete.md)
- [lean cloud object-store get](https://www.quantconnect.com/docs/v2/lean-cli/api-reference/lean-cloud-object-store-get.md)
- [lean cloud object-store list](https://www.quantconnect.com/docs/v2/lean-cli/api-reference/lean-cloud-object-store-list.md)
- [lean cloud object-store ls](https://www.quantconnect.com/docs/v2/lean-cli/api-reference/lean-cloud-object-store-ls.md)
- [lean cloud object-store properties](https://www.quantconnect.com/docs/v2/lean-cli/api-reference/lean-cloud-object-store-properties.md)
- [lean cloud object-store set](https://www.quantconnect.com/docs/v2/lean-cli/api-reference/lean-cloud-object-store-set.md)
- [lean cloud optimize](https://www.quantconnect.com/docs/v2/lean-cli/api-reference/lean-cloud-optimize.md)
- [lean cloud pull](https://www.quantconnect.com/docs/v2/lean-cli/api-reference/lean-cloud-pull.md)
- [lean cloud push](https://www.quantconnect.com/docs/v2/lean-cli/api-reference/lean-cloud-push.md)
- [lean cloud status](https://www.quantconnect.com/docs/v2/lean-cli/api-reference/lean-cloud-status.md)
- [lean config get](https://www.quantconnect.com/docs/v2/lean-cli/api-reference/lean-config-get.md)
- [lean config list](https://www.quantconnect.com/docs/v2/lean-cli/api-reference/lean-config-list.md)
- [lean config set](https://www.quantconnect.com/docs/v2/lean-cli/api-reference/lean-config-set.md)
- [lean config unset](https://www.quantconnect.com/docs/v2/lean-cli/api-reference/lean-config-unset.md)
- [lean create-project](https://www.quantconnect.com/docs/v2/lean-cli/api-reference/lean-create-project.md)
- [lean data download](https://www.quantconnect.com/docs/v2/lean-cli/api-reference/lean-data-download.md)
- [lean data generate](https://www.quantconnect.com/docs/v2/lean-cli/api-reference/lean-data-generate.md)
- [lean decrypt](https://www.quantconnect.com/docs/v2/lean-cli/api-reference/lean-decrypt.md)
- [lean delete-project](https://www.quantconnect.com/docs/v2/lean-cli/api-reference/lean-delete-project.md)
- [lean encrypt](https://www.quantconnect.com/docs/v2/lean-cli/api-reference/lean-encrypt.md)
- [lean init](https://www.quantconnect.com/docs/v2/lean-cli/api-reference/lean-init.md)
- [lean library add](https://www.quantconnect.com/docs/v2/lean-cli/api-reference/lean-library-add.md)
- [lean library remove](https://www.quantconnect.com/docs/v2/lean-cli/api-reference/lean-library-remove.md)
- [lean live](https://www.quantconnect.com/docs/v2/lean-cli/api-reference/lean-live.md)
- [lean live add-security](https://www.quantconnect.com/docs/v2/lean-cli/api-reference/lean-live-add-security.md)
- [lean live cancel-order](https://www.quantconnect.com/docs/v2/lean-cli/api-reference/lean-live-cancel-order.md)
- [lean live command](https://www.quantconnect.com/docs/v2/lean-cli/api-reference/lean-live-command.md)
- [lean live deploy](https://www.quantconnect.com/docs/v2/lean-cli/api-reference/lean-live-deploy.md)
- [lean live liquidate](https://www.quantconnect.com/docs/v2/lean-cli/api-reference/lean-live-liquidate.md)
- [lean live stop](https://www.quantconnect.com/docs/v2/lean-cli/api-reference/lean-live-stop.md)
- [lean live submit-order](https://www.quantconnect.com/docs/v2/lean-cli/api-reference/lean-live-submit-order.md)
- [lean live update-order](https://www.quantconnect.com/docs/v2/lean-cli/api-reference/lean-live-update-order.md)
- [lean login](https://www.quantconnect.com/docs/v2/lean-cli/api-reference/lean-login.md)
- [lean logout](https://www.quantconnect.com/docs/v2/lean-cli/api-reference/lean-logout.md)
- [lean logs](https://www.quantconnect.com/docs/v2/lean-cli/api-reference/lean-logs.md)
- [lean object-store delete](https://www.quantconnect.com/docs/v2/lean-cli/api-reference/lean-object-store-delete.md)
- [lean object-store get](https://www.quantconnect.com/docs/v2/lean-cli/api-reference/lean-object-store-get.md)
- [lean object-store list](https://www.quantconnect.com/docs/v2/lean-cli/api-reference/lean-object-store-list.md)
- [lean object-store ls](https://www.quantconnect.com/docs/v2/lean-cli/api-reference/lean-object-store-ls.md)
- [lean object-store properties](https://www.quantconnect.com/docs/v2/lean-cli/api-reference/lean-object-store-properties.md)
- [lean object-store set](https://www.quantconnect.com/docs/v2/lean-cli/api-reference/lean-object-store-set.md)
- [lean optimize](https://www.quantconnect.com/docs/v2/lean-cli/api-reference/lean-optimize.md)
- [lean private-cloud add-compute](https://www.quantconnect.com/docs/v2/lean-cli/api-reference/lean-private-cloud-add-compute.md)
- [lean private-cloud start](https://www.quantconnect.com/docs/v2/lean-cli/api-reference/lean-private-cloud-start.md)
- [lean private-cloud stop](https://www.quantconnect.com/docs/v2/lean-cli/api-reference/lean-private-cloud-stop.md)
- [lean project-create](https://www.quantconnect.com/docs/v2/lean-cli/api-reference/lean-project-create.md)
- [lean project-delete](https://www.quantconnect.com/docs/v2/lean-cli/api-reference/lean-project-delete.md)
- [lean report](https://www.quantconnect.com/docs/v2/lean-cli/api-reference/lean-report.md)
- [lean research](https://www.quantconnect.com/docs/v2/lean-cli/api-reference/lean-research.md)
- [lean ui](https://www.quantconnect.com/docs/v2/lean-cli/api-reference/lean-ui.md)
- [lean whoami](https://www.quantconnect.com/docs/v2/lean-cli/api-reference/lean-whoami.md)

## Pages in This Section

- [lean backtest](https://www.quantconnect.com/docs/v2/lean-cli/api-reference/lean-backtest.md): API reference for the command `lean backtest` in command line console.
- [lean build](https://www.quantconnect.com/docs/v2/lean-cli/api-reference/lean-build.md): API reference for the command `lean build` in command line console.
- [lean cloud backtest](https://www.quantconnect.com/docs/v2/lean-cli/api-reference/lean-cloud-backtest.md): API reference for the command `lean cloud backtest` in command line console.
- [lean cloud live](https://www.quantconnect.com/docs/v2/lean-cli/api-reference/lean-cloud-live.md): API reference for the command `lean cloud live` in command line console.
- [lean cloud live broadcast](https://www.quantconnect.com/docs/v2/lean-cli/api-reference/lean-cloud-live-broadcast.md): API reference for the command `lean cloud live broadcast` in command line console.
- [lean cloud live command](https://www.quantconnect.com/docs/v2/lean-cli/api-reference/lean-cloud-live-command.md): API reference for the command `lean cloud live command` in command line console.
- [lean cloud live deploy](https://www.quantconnect.com/docs/v2/lean-cli/api-reference/lean-cloud-live-deploy.md): API reference for the command `lean cloud live deploy` in command line console.
- [lean cloud live liquidate](https://www.quantconnect.com/docs/v2/lean-cli/api-reference/lean-cloud-live-liquidate.md): API reference for the command `lean cloud live liquidate` in command line console.
- [lean cloud live stop](https://www.quantconnect.com/docs/v2/lean-cli/api-reference/lean-cloud-live-stop.md): API reference for the command `lean cloud live stop` in command line console.
- [lean cloud object-store delete](https://www.quantconnect.com/docs/v2/lean-cli/api-reference/lean-cloud-object-store-delete.md): API reference for the command `lean cloud object-store delete` in command line console.
- [lean cloud object-store get](https://www.quantconnect.com/docs/v2/lean-cli/api-reference/lean-cloud-object-store-get.md): API reference for the command `lean cloud object-store get` in command line console.
- [lean cloud object-store list](https://www.quantconnect.com/docs/v2/lean-cli/api-reference/lean-cloud-object-store-list.md): API reference for the command `lean cloud object-store list` in command line console.
- [lean cloud object-store ls](https://www.quantconnect.com/docs/v2/lean-cli/api-reference/lean-cloud-object-store-ls.md): API reference for the command `lean cloud object-store ls` in command line console.
- [lean cloud object-store properties](https://www.quantconnect.com/docs/v2/lean-cli/api-reference/lean-cloud-object-store-properties.md): API reference for the command `lean cloud object-store properties` in command line console.
- [lean cloud object-store set](https://www.quantconnect.com/docs/v2/lean-cli/api-reference/lean-cloud-object-store-set.md): API reference for the command `lean cloud object-store set` in command line console.
- [lean cloud optimize](https://www.quantconnect.com/docs/v2/lean-cli/api-reference/lean-cloud-optimize.md): API reference for the command `lean cloud optimize` in command line console.
- [lean cloud pull](https://www.quantconnect.com/docs/v2/lean-cli/api-reference/lean-cloud-pull.md): API reference for the command `lean cloud pull` in command line console.
- [lean cloud push](https://www.quantconnect.com/docs/v2/lean-cli/api-reference/lean-cloud-push.md): API reference for the command `lean cloud push` in command line console.
- [lean cloud status](https://www.quantconnect.com/docs/v2/lean-cli/api-reference/lean-cloud-status.md): API reference for the command `lean cloud status` in command line console.
- [lean config get](https://www.quantconnect.com/docs/v2/lean-cli/api-reference/lean-config-get.md): API reference for the command `lean config get` in command line console.
- [lean config list](https://www.quantconnect.com/docs/v2/lean-cli/api-reference/lean-config-list.md): API reference for the command `lean config list` in command line console.
- [lean config set](https://www.quantconnect.com/docs/v2/lean-cli/api-reference/lean-config-set.md): API reference for the command `lean config set` in command line console.
- [lean config unset](https://www.quantconnect.com/docs/v2/lean-cli/api-reference/lean-config-unset.md): API reference for the command `lean config unset` in command line console.
- [lean create-project](https://www.quantconnect.com/docs/v2/lean-cli/api-reference/lean-create-project.md): API reference for the command `lean create-project` in command line console.
- [lean data download](https://www.quantconnect.com/docs/v2/lean-cli/api-reference/lean-data-download.md): API reference for the command `lean data download` in command line console.
- [lean data generate](https://www.quantconnect.com/docs/v2/lean-cli/api-reference/lean-data-generate.md): API reference for the command `lean data generate` in command line console.
- [lean decrypt](https://www.quantconnect.com/docs/v2/lean-cli/api-reference/lean-decrypt.md): API reference for the command `lean decrypt` in command line console.
- [lean delete-project](https://www.quantconnect.com/docs/v2/lean-cli/api-reference/lean-delete-project.md): API reference for the command `lean delete-project` in command line console.
- [lean encrypt](https://www.quantconnect.com/docs/v2/lean-cli/api-reference/lean-encrypt.md): API reference for the command `lean encrypt` in command line console.
- [lean init](https://www.quantconnect.com/docs/v2/lean-cli/api-reference/lean-init.md): API reference for the command `lean init` in command line console.
- [lean library add](https://www.quantconnect.com/docs/v2/lean-cli/api-reference/lean-library-add.md): API reference for the command `lean library add` in command line console.
- [lean library remove](https://www.quantconnect.com/docs/v2/lean-cli/api-reference/lean-library-remove.md): API reference for the command `lean library remove` in command line console.
- [lean live](https://www.quantconnect.com/docs/v2/lean-cli/api-reference/lean-live.md): API reference for the command `lean live` in command line console.
- [lean live add-security](https://www.quantconnect.com/docs/v2/lean-cli/api-reference/lean-live-add-security.md): API reference for the command `lean live add-security` in command line console.
- [lean live cancel-order](https://www.quantconnect.com/docs/v2/lean-cli/api-reference/lean-live-cancel-order.md): API reference for the command `lean live cancel-order` in command line console.
- [lean live command](https://www.quantconnect.com/docs/v2/lean-cli/api-reference/lean-live-command.md): API reference for the command `lean live command` in command line console.
- [lean live deploy](https://www.quantconnect.com/docs/v2/lean-cli/api-reference/lean-live-deploy.md): API reference for the command `lean live deploy` in command line console.
- [lean live liquidate](https://www.quantconnect.com/docs/v2/lean-cli/api-reference/lean-live-liquidate.md): API reference for the command `lean live liquidate` in command line console.
- [lean live stop](https://www.quantconnect.com/docs/v2/lean-cli/api-reference/lean-live-stop.md): API reference for the command `lean live stop` in command line console.
- [lean live submit-order](https://www.quantconnect.com/docs/v2/lean-cli/api-reference/lean-live-submit-order.md): API reference for the command `lean live submit-order` in command line console.
- [lean live update-order](https://www.quantconnect.com/docs/v2/lean-cli/api-reference/lean-live-update-order.md): API reference for the command `lean live update-order` in command line console.
- [lean login](https://www.quantconnect.com/docs/v2/lean-cli/api-reference/lean-login.md): API reference for the command `lean login` in command line console.
- [lean logout](https://www.quantconnect.com/docs/v2/lean-cli/api-reference/lean-logout.md): API reference for the command `lean logout` in command line console.
- [lean logs](https://www.quantconnect.com/docs/v2/lean-cli/api-reference/lean-logs.md): API reference for the command `lean logs` in command line console.
- [lean object-store delete](https://www.quantconnect.com/docs/v2/lean-cli/api-reference/lean-object-store-delete.md): API reference for the command `lean object-store delete` in command line console.
- [lean object-store get](https://www.quantconnect.com/docs/v2/lean-cli/api-reference/lean-object-store-get.md): API reference for the command `lean object-store get` in command line console.
- [lean object-store list](https://www.quantconnect.com/docs/v2/lean-cli/api-reference/lean-object-store-list.md): API reference for the command `lean object-store list` in command line console.
- [lean object-store ls](https://www.quantconnect.com/docs/v2/lean-cli/api-reference/lean-object-store-ls.md): API reference for the command `lean object-store ls` in command line console.
- [lean object-store properties](https://www.quantconnect.com/docs/v2/lean-cli/api-reference/lean-object-store-properties.md): API reference for the command `lean object-store properties` in command line console.
- [lean object-store set](https://www.quantconnect.com/docs/v2/lean-cli/api-reference/lean-object-store-set.md): API reference for the command `lean object-store set` in command line console.
- [lean optimize](https://www.quantconnect.com/docs/v2/lean-cli/api-reference/lean-optimize.md): API reference for the command `lean optimize` in command line console.
- [lean private-cloud add-compute](https://www.quantconnect.com/docs/v2/lean-cli/api-reference/lean-private-cloud-add-compute.md): API reference for the command `lean private-cloud add-compute` in command line console.
- [lean private-cloud start](https://www.quantconnect.com/docs/v2/lean-cli/api-reference/lean-private-cloud-start.md): API reference for the command `lean private-cloud start` in command line console.
- [lean private-cloud stop](https://www.quantconnect.com/docs/v2/lean-cli/api-reference/lean-private-cloud-stop.md): API reference for the command `lean private-cloud stop` in command line console.
- [lean project-create](https://www.quantconnect.com/docs/v2/lean-cli/api-reference/lean-project-create.md): API reference for the command `lean project-create` in command line console.
- [lean project-delete](https://www.quantconnect.com/docs/v2/lean-cli/api-reference/lean-project-delete.md): API reference for the command `lean project-delete` in command line console.
- [lean report](https://www.quantconnect.com/docs/v2/lean-cli/api-reference/lean-report.md): API reference for the command `lean report` in command line console.
- [lean research](https://www.quantconnect.com/docs/v2/lean-cli/api-reference/lean-research.md): API reference for the command `lean research` in command line console.
- [lean ui](https://www.quantconnect.com/docs/v2/lean-cli/api-reference/lean-ui.md): API reference for the command `lean ui` in command line console.
- [lean whoami](https://www.quantconnect.com/docs/v2/lean-cli/api-reference/lean-whoami.md): API reference for the command `lean whoami` in command line console.