v1

get/api/v1/series

Request

  • Base URL: https://api.blackforge.so (the document declares no server; this is the origin it was published from)
  • URL: https://api.blackforge.so/api/v1/series
  • Auth: API key in header x-api-key

Query parameters

exchangestring required
symbolstring required
metricstring required
fromstring required
tostring required
interval'1m' | '5m' | '1h' | '1d' required

Response

Time-bucketed series of one metric for an exchange/symbol pair, gated by the key plan (venues, granularity, history, columns, rows). ROW QUALITY: every element of points carries two extra integers beside ts and value — quality, the row-quality bitmask ORed across the native 5-minute windows in that bucket (dirty if ANY window was), and qualityAll, the same bitmask ANDed (set only where EVERY window was). They are per point, not a parallel array. Decode them with the bits table on the qualityFlags entry of GET /v1/catalog. Nothing is ever hidden, filtered or nulled on account of quality: values are exactly as measured and these two integers tell you which to trust. A column a row never measured is null: a row rebuilt from the venue trade archive (TRADES_BACKFILLED) serves its book, enrichment and context columns as null, and coarser buckets average only the rows that measured them.

Changes

No recorded changes to this operation across all 1 revision of this API.