QuantLake
GitHub
Documentation

JSON output

The fields that each command prints with --json.

Every command prints JSON with --json. The keys are in English, and the format is the same whatever the language of the human-readable output. Dates are YYYY-MM-DD (to includes that day), and times are UTC in ISO 8601.

saved

[{ "source", "exchange", "data_type", "symbol",
   "ranges": [{ "from", "to", "days" }],
   "partitions", "rows", "size_bytes" }]

If some days are missing, ranges has more than one entry.

files

{ "root", "glob",
  "files": [{ "source", "exchange", "data_type", "symbol", "date", "path", "rows", "size_bytes" }] }

files lists only saved days. glob matches every saved day (date=*) and is not narrowed by --from and --to.

available

{ "exchanges": [{ "source", "exchange", "published_to", "refreshed_at" }],
  "ranges": [{ "source", "exchange", "data_type", "symbol", "symbol_type", "from", "to", "first_day_of_month_only" }] }

first_day_of_month_only is true when your Tardis.dev plan gives you only the free first day of each month.

status

{ "server": { "alive", "state", "pid", "started_at", "heartbeat_at", "message", "protection", "active_partitions", "disk_free_bytes" },
  "targets": [...],
  "pending_requests", "failed_partitions",
  "recent_failures": [{ "partition", "kind", "attempts", "message", "next_attempt_at" }],
  "spending": { "month", "databento_max_monthly_usd", "charges": [{ "source", "usd", "partitions" }] },
  "lake_root" }

Each entry of targets:

{ "id", "source", "exchange", "data_type", "symbol", "start_date", "end_date",
  "available", "available_from", "available_to", "first_day_of_month_only",
  "planned_days", "saved_days", "failed_days", "next_date" }
  • available_to is the last day you can download.
  • planned_days is the number of days that are in both the target's dates and the range you can download.
  • next_date is the next day to download, or null.
  • spending covers the current UTC month (YYYY-MM).

targets list --json prints the same targets array.

requests

[{ "id", "kind", "status", "message", "source", "exchange", "data_type", "symbol", "from", "to", "created_at", "updated_at" }]

verify

{ "checked_partitions",
  "issues": [{ "kind", "path", "partition", "detail" }],
  "recollect_requests" }

kind is missing, modified, uncataloged or unknown.

config list

[{ "key", "value", "default", "is_set", "secret", "description" }]

The value of a secret is always null.