Skip to main content
Use custom_bars_catalog before querying custom bars when you do not already know the exact stored threshold or date range.

Arguments

ArgumentTypeRequiredDescription
exchangestringNobinance or binance-futures
productstringNoInitially BTCUSDT
bar_typestringNodollar, volume, tick, or imbalance
limitintegerNoCatalog entries to return, from 1 to 5,000; default 500
cursorstringNoInteger offset returned by an earlier page

Example arguments

{
  "exchange": "binance-futures",
  "product": "BTCUSDT",
  "bar_type": "dollar",
  "limit": 100
}

Catalog entry

Each entry identifies a stored configuration:
{
  "exchange": "binance-futures",
  "product": "BTCUSDT",
  "bar_type": "dollar",
  "threshold_key": "...",
  "threshold": 5000000,
  "begin": "...",
  "end": "...",
  "row_count": 12345,
  "sources": ["binance_vision_aggtrades"],
  "provenance_types": ["native_backfilled"],
  "source_run_ids": ["..."]
}
The catalog is read-only. It does not download archives, build bars, or trigger a historical job.