--- title: "Polygon" description: "Learn how to connect and feed data to a live algorithm from Polygon in Lean CLI." canonical: https://www.quantconnect.com/docs/v2/lean-cli/datasets/polygon markdown: https://www.quantconnect.com/docs/v2/lean-cli/datasets/polygon.md language: python source: https://github.com/QuantConnect/Documentation/tree/master/05%20Lean%20CLI/05%20Datasets/12%20Polygon modified: 2026-10-29 index: https://www.quantconnect.com/llms.txt --- # Polygon [Documentation](https://www.quantconnect.com/docs/v2.md) > [Lean CLI](https://www.quantconnect.com/docs/v2/lean-cli.md) > Datasets > Polygon > Code examples are shown in Python. Append `?lang=csharp` to this URL for the C# version of this page. ## Introduction Instead of using the data from QuantConnect or your brokerage, you can use data from [Polygon](https://polygon.io/) if you have an API key. To get an API key, see the [API Keys](https://polygon.io/dashboard/keys) page on the Polygon website To view the implementation of the Polygon integration, see the [Lean.DataSource.Polygon repository](https://github.com/QuantConnect/Lean.DataSource.Polygon). 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. ## Supported Datasets Our Polygon integration supports securities from the following asset classes: - [US Equity](https://www.quantconnect.com/docs/v2/writing-algorithms/securities/asset-classes/us-equity.md) - [US Equity Options](https://www.quantconnect.com/docs/v2/writing-algorithms/securities/asset-classes/equity-options.md) - [US Indices](https://www.quantconnect.com/docs/v2/writing-algorithms/securities/asset-classes/index.md) - [US Index Options](https://www.quantconnect.com/docs/v2/writing-algorithms/securities/asset-classes/index-options.md) The Polygon data provider serves raw data. To get adjusted Equity data in local deployments, [download the US Equity Security Master](https://www.quantconnect.com/datasets/quantconnect-us-equity-security-master/cli). ## Universe Selection In local deployments, [universe selection](https://www.quantconnect.com/docs/v2/writing-algorithms/universes/key-concepts.md) is available with the Polygon data provider if you download the data from the [Dataset Market](https://www.quantconnect.com/datasets). The dataset listings show how to download the universe selection data with the CLI. For live trading, you'll need to periodically download the new data from QuantConnect Cloud, which you can automate with Python scripts. For example, the following tutorials explain how to download historical data and download daily updates: - [US Equity Coarse Universe](https://www.quantconnect.com/docs/v2/lean-cli/datasets/quantconnect/us-equity-coarse-fundamental.md) - [US Equity Option Universe](https://www.quantconnect.com/docs/v2/lean-cli/datasets/quantconnect/equity-options.md#02-Prerequisites) - [US ETF Constituents](https://www.quantconnect.com/docs/v2/lean-cli/datasets/quantconnect/us-etf-constituents.md) - [US Index Option Universe](https://www.quantconnect.com/docs/v2/lean-cli/datasets/quantconnect/index-options.md#02-Prerequisites) In cloud deployments, QuantConnect Cloud provides the universe selection datasets. ## Alternative Data If you have licensed alternative data with QuantConnect, it works as expected with the Polygon data provider for research, backtesting, and live trading. ## Download To download Polygon data, open a terminal in your [organization workspace](https://www.quantconnect.com/docs/v2/lean-cli/initialization/organization-workspaces.md) and then run `lean data download --data-provider-historical Polygon --data-type --resolution --security-type --ticker --start --end --polygon-api-key `. ``` $ lean data download --data-provider-historical Polygon --data-type Trade --resolution Hour --security-type Equity --ticker SOFI,TSLA,NIO --start 20200101 --end 20240404 --polygon-api-key apiKey ``` If you provide your credentials, your [Lean configuration file](https://www.quantconnect.com/docs/v2/lean-cli/initialization/configuration.md#03-Lean-Configuration) saves them. ## Research To access Polygon data from the local Research Environment, open a terminal in your [organization workspace](https://www.quantconnect.com/docs/v2/lean-cli/initialization/organization-workspaces.md) and then run `lean research --data-provider-historical Polygon --polygon-api-key `. ``` $ lean research "My Project" --data-provider-historical Polygon --polygon-api-key apiKey ``` If you provide any of the preceding options, your [Lean configuration file](https://www.quantconnect.com/docs/v2/lean-cli/initialization/configuration.md#03-Lean-Configuration) saves them so that you only need to run `lean research ` to open the Research Environment with the same options. ## Backtesting To run a local backtest with Polygon data, open a terminal in your [organization workspace](https://www.quantconnect.com/docs/v2/lean-cli/initialization/organization-workspaces.md) and then run `lean backtest --data-provider-historical Polygon --polygon-api-key `. ``` $ lean backtest "My Project" --data-provider-historical Polygon --polygon-api-key apiKey ``` If you provide any of the preceding options, your [Lean configuration file](https://www.quantconnect.com/docs/v2/lean-cli/initialization/configuration.md#03-Lean-Configuration) saves them so that you only need to run `lean backtest ` to run another backtest with the same options. ## Optimization Follow these steps to run a local optimization job with Polygon data: 1. Add some [parameters](https://www.quantconnect.com/docs/v2/lean-cli/optimization/parameters.md) to your project. 2. Open a terminal in your [organization workspace](https://www.quantconnect.com/docs/v2/lean-cli/initialization/organization-workspaces.md). 3. Run `lean optimize --data-provider-historical Polygon --polygon-api-key `. ``` $ lean optimize "My Project" --data-provider-historical Polygon --polygon-api-key apiKey ``` 4. Follow [the steps in the interactive wizard](https://www.quantconnect.com/docs/v2/lean-cli/optimization/deployment.md#02-Run-Local-Optimizations) to configure your optimization job settings. The `lean optimize` command also accepts additional [options](https://www.quantconnect.com/docs/v2/lean-cli/api-reference/lean-backtest.md#04-Options) so that you can select Polgyon and run the command in non-interactive mode. If you provide any of the preceding options, your [Lean configuration file](https://www.quantconnect.com/docs/v2/lean-cli/initialization/configuration.md#03-Lean-Configuration) saves them so that you only need to run `lean optimize ` to run another optimization job with the same options. ## Live Trading To deploy a local live algorithm that uses Polygon as the data provider, open a terminal in your [organization workspace](https://www.quantconnect.com/docs/v2/lean-cli/initialization/organization-workspaces.md) and then run `lean live deploy --data-provider-live Polygon --polygon-api-key --brokerage `. ``` $ lean live deploy "My Project" --data-provider-live Polygon --polygon-api-key apiKey --brokerage "Paper Trading" ``` Depending on the brokerage you select, you may need to provide some [required brokerage options](https://www.quantconnect.com/docs/v2/lean-cli/api-reference/lean-live-deploy.md#02-Description). To use a different provider for historical data, include the `--data-provider-historical` option. If you provide any of the preceding options, your [Lean configuration file](https://www.quantconnect.com/docs/v2/lean-cli/initialization/configuration.md#03-Lean-Configuration) saves them so that you only need to run `lean live deploy --brokerage ` to deploy another live algorithm with the same options. To deploy the algorithm in QuantConnect Cloud while still using Polygon as the data provider, run `lean cloud live deploy --data-provider-live Polygon --polygon-api-key --brokerage --node --auto-restart --notify-order-events --notify-insights `. ``` $ lean cloud live deploy "My Project" --data-provider-live Polygon --polygon-api-key apiKey --brokerage "Paper Trading" --node "My Node" --auto-restart yes --notify-order-events no --notify-insights no ``` To deploy the live algorithm through the interactive mode of the CLI, see [Polygon](https://www.quantconnect.com/docs/v2/lean-cli/live-trading/data-providers/polygon.md). ## Pricing To view the prices of the Polygon API packages, see the [Simple Pricing](https://polygon.io/pricing) page on the Polygon website.