CLI Reference

This page provides documentation for our command line tools.

stocklake

Usage:

stocklake [OPTIONS] COMMAND [ARGS]...

Options:

  --help  Show this message and exit.

database

Manage database schemas.

Usage:

stocklake database [OPTIONS] COMMAND [ARGS]...

Options:

  --help  Show this message and exit.

autogenerate-revision

Usage:

stocklake database autogenerate-revision [OPTIONS]

Options:

  --message TEXT
  --url TEXT
  --help          Show this message and exit.

upgrade

Usage:

stocklake database upgrade [OPTIONS]

Options:

  --revision TEXT
  --url TEXT
  --help           Show this message and exit.

download

Download data to several stores from APIs.

e.g.

The following command downloads table data of Nasdaq API data into local csv file.

stocklake download nasdaqapi --exchange nasdaq

Usage:

stocklake download [OPTIONS] COMMAND [ARGS]...

Options:

  --help  Show this message and exit.

nasdaqapi

Usage:

stocklake download nasdaqapi [OPTIONS]

Options:

  --skip_download BOOLEAN  if true, downloading data will be skipped.
  --exchange TEXT          The exchange name that you want to download, should
                           be in `['amex', 'nasdaq', 'nyse']`.
  --store_type TEXT        The storege type, should be in `['local_artifact',
                           'postgresql']`.
  --artifact_format TEXT   The artifact file format, should be in `['csv']`
  --help                   Show this message and exit.

polygonapi

Usage:

stocklake download polygonapi [OPTIONS] COMMAND [ARGS]...

Options:

  --help  Show this message and exit.

aggregates-bars

Usage:

stocklake download polygonapi aggregates-bars [OPTIONS]

Options:

  --skip_download BOOLEAN  if true, downloading data will be skipped.
  --symbols TEXT           symbols split by comma. ex `MSFT,AAPL`.
  --store_type TEXT        The storege type, should be in `['local_artifact',
                           'postgresql']`.
  --artifact_format TEXT   The artifact file format, should be in `['csv']`
  --interval_sec INTEGER   The interval time in seconds to process each
                           symbols
  --help                   Show this message and exit.

stock-financials-vx

Usage:

stocklake download polygonapi stock-financials-vx [OPTIONS]

Options:

  --skip_download BOOLEAN  if true, downloading data will be skipped.
  --symbols TEXT           symbols split by comma. ex `MSFT,AAPL`.
  --store_type TEXT        The storege type, should be in `['local_artifact',
                           'postgresql']`.
  --artifact_format TEXT   The artifact file format, should be in `['csv']`
  --interval_sec INTEGER   The interval time in seconds to process each
                           symbols
  --help                   Show this message and exit.

wikisp500

Usage:

stocklake download wikisp500 [OPTIONS]

Options:

  --skip_download BOOLEAN  if true, downloading data will be skipped.
  --store_type TEXT        The storege type, should be in `['local_artifact',
                           'postgresql']`.
  --artifact_format TEXT   The artifact file format, should be in `['csv']`
  --help                   Show this message and exit.