API Reference

lean data download

Introduction

Purchase and download data from QuantConnect Datasets.

$ lean data download [options]

Description

Lets you purchase and download data from QuantConnect Datasets. This command performs the following actions:

  1. You are asked to select the organization which should be billed. This step is skipped if you are only a member of a single organization.
  2. An interactive wizard is shown allowing you to configure exactly which data you want to download.
  3. You are asked to accept the CLI API Access and Data Agreement in your web browser.
  4. You are asked to confirm the purchase one last time.
  5. The CLI downloads the requested files while charging the organization selected in step 1.

The available datasets and their pricing can be found in QuantConnect Datasets. Data is priced on a per-file per-download basis, meaning you pay a certain number of QuantConnect Credits (QCC) for each file you download. The required QCC is deducted from your organization's QCC balance when a file is downloaded. If you force-quit the command before it downloaded all requested files, you are not charged for the files you didn't download.

When --dataset is given the command runs in non-interactive mode and step 1, 2, and 4 of the list above are skipped. Instead, the command reads the downloading configuration from the given command-line options. In this mode --dataset and --organization are required options, as well as all options specific to the selected dataset.

Example non-interactive usage:

$ lean data download \
    --dataset "Crypto Price Data" \
    --organization "My Organization" \
    --data-type "Trade" \
    --market "Coinbase" \
    --ticker "BTCUSD" \
    --resolution "Daily"

In case the local data already exists a warning is logged and you are given the choice of whether you want to enable overwriting existing data or not. Use the --overwrite flag to override this behavior and enable overwriting existing data in all such cases.

Options

The lean data download command supports the following options:

OptionDescription
--dataset <value>The name of the dataset to download data from in non-interactive mode.
--organization <value>The name or id of the organization to purchase and download data with.
--overwriteOverwrite existing local data.
--verboseEnable debug logging.
--helpDisplay the help text of the lean data download command and exit.

You can also see our Videos. You can also get in touch with us via Chat.

Did you find this page helpful?

Contribute to the documentation: