QuantLake
GitHub
Documentation

Command reference

Every quantlake command and its options.

All commands accept --json for machine-readable output and --help for details. Dates are YYYY-MM-DD, and --to includes that day.

CommandWhat it does
quantlake statusShows whether the server is running, the progress of each target, pending requests, recent failures and this month's Databento spending
quantlake targets add / list / update / removeManages what to collect
quantlake availableShows what your plans let you download
quantlake savedShows the saved date ranges, with row counts and sizes
quantlake filesPrints the paths of saved files, and a wildcard pattern for reading them all at once
quantlake deleteDeletes saved data
quantlake recollectDownloads saved days again and replaces the files
quantlake requestsShows the results of recent delete, recollect and refresh requests
quantlake verifyChecks every saved file against the catalog
quantlake config list / get / set / unset / pathShows and changes the settings

Commands that read the lake accept --lake-root to use a lake other than the default. Without it, QuantLake uses $QUANTLAKE_HOME, or ~/.local/share/quantlake.

Filters

available, saved, files, delete, recollect and verify take the same filters. Each one narrows the result; leave it out to include everything.

OptionMeaning
--exchangeExchange or Databento dataset, such as binance-futures or glbx.mdp3
--data-typeData type, such as trades
--symbolSymbol, such as BTCUSDT or ES.c.0
--from, --toFirst and last day (not for available and verify)
--sourcetardis or databento. Needed only when QuantLake cannot tell the provider from the exchange

Collection targets

quantlake targets add --exchange binance-futures --data-type trades,derivative_ticker --symbol BTCUSDT --from 2026-10-01 [--to 2026-10-31] [--source tardis]
quantlake targets list
quantlake targets update --id N [--from 2026-09-01] [--to 2026-12-31 | --clear-to]
quantlake targets remove --id N
  • targets add takes several data types and symbols, separated by commas, and registers one target for each combination. Without --to, the target keeps collecting new days.
  • targets update --clear-to removes the end date.
  • targets remove stops collection, but keeps the saved data.

What you can download

quantlake available [filters] [--refresh --wait]

--refresh asks the server to update the list for an exchange, so --exchange is required with it. --wait waits until the update has finished. For Databento, QuantLake looks up only the symbols that you collect or name with --symbol.

What is saved

quantlake saved [filters]
quantlake files [filters]

saved shows the saved date ranges, with the number of days, rows and the size. files prints the path of each saved file in the range, and a wildcard pattern for all days. See Read data.

Delete and download again

quantlake delete --exchange binance-futures [--data-type trades] [--symbol BTCUSDT] [--from …] [--to …] --wait
quantlake recollect --exchange binance-futures [--data-type trades] [--symbol BTCUSDT] [--from …] [--to …] --wait
quantlake requests [--limit 20]
  • delete refuses ranges that a collection target still covers, because the server would download them again. Remove the target or shorten its dates first. --force deletes them anyway, and the server downloads them again.
  • recollect downloads the saved days in the range again and replaces the files. It also clears the failure records in the range, so failed days are tried again right away.
  • delete, recollect and available --refresh are carried out by the server. Add --wait to wait until they finish. If the server is not running, the requests wait until it starts.
  • requests shows the results of recent requests.

Check the files

quantlake verify [--exchange …] [--data-type …] [--symbol …] [--quick] [--recollect]

verify compares the files with the catalog and reports changed, missing and unexpected files. It only reads. It exits with code 2 if it finds a problem.

  • --quick checks only that each file exists and has the right size, without computing hashes.
  • --recollect asks the server to download again the days whose files were changed or are missing.

Settings

quantlake config list
quantlake config get server.concurrency
quantlake config set server.concurrency 8
quantlake config set secrets.tardis_api_key --stdin
quantlake config unset server.concurrency
quantlake config path

config commands accept --config to use a configuration file other than the default. Without it, QuantLake uses $QUANTLAKE_CONFIG, or ~/.config/quantlake/config.toml. See Configuration.