`GET /v1/series`

Updated August 2026

What does GET /v1/series do?

One metric for one pair across a time range, at 5-minute, hourly or daily resolution. Returns a single metric for a single pair across a time window, as an ordered list of points. Use it to chart a column over time or to pull a range for analysis.

The interval sets the resolution: 5m is the native window; 1h and 1d are aggregates. The from and to bounds are ISO-8601 timestamps.

Each point carries the metric value plus the quality bitmask for that window, so a chart can grey out or drop windows whose measurement was contaminated.

Authentication

API key required. Set $BF to the API base and pass your key in $BLACKFORGE_API_KEY.

Parameters

Query parameters for /v1/series
Name	Type	Required	Description
`exchange`	string	Yes	The venue, e.g. binance.
`symbol`	string	Yes	The pair, in the venue’s own symbol form, e.g. BTCUSDT.
`metric`	string	Yes	The column key to return, e.g. price.
`from`	string	Yes
`to`	string	Yes
`interval`	string (5m \| 1h \| 1d)	Yes

Parameter shapes from the live OpenAPI document.

Example request

curl -H "x-api-key: $BLACKFORGE_API_KEY" \
  "$BF/v1/series?exchange=binance&symbol=BTCUSDT&metric=price&interval=5m&from=2026-08-23T04:47:12Z&to=2026-08-23T05:47:12Z"

Example response

Real response, captured 2026-08-23 (trimmed for reading; values move every window)

{
  "metric": "price",
  "exchange": "binance",
  "symbol": "BTCUSDT",
  "points": [
    {
      "ts": 1787460600000,
      "value": 76624,
      "quality": 6145,
      "qualityAll": 6145
    },
    {
      "ts": 1787460900000,
      "value": 76690.94,
      "quality": 6144,
      "qualityAll": 6144
    },
    {
      "ts": 1787461200000,
      "value": 76602,
      "quality": 2048,
      "qualityAll": 2048
    },
    {
      "ts": 1787461500000,
      "value": 76566.65,
      "quality": 2048,
      "qualityAll": 2048
    },
    "…"
  ]
}

Returns

A JSON object with the echoed metric, exchange and symbol, and a points array. Each point has ts (epoch milliseconds), value, and the window’s quality flags.

Responses and errors

Status codes for /v1/series
Status	When
`400`	A required parameter is missing, the metric is unknown, or the interval is not one of 5m, 1h, 1d.
`401`	The x-api-key header is missing or not a valid key.
`402`	No key and no x402 payment: the pay-per-call challenge is returned.

NoteThe reachable range depends on your plan’s history window, which is an entitlement, not retention: the archive is kept forever, but each plan can read back a fixed distance.

Columns it returns

Each column is defined on its own page. Last price, Resting-level lifetime. See the full metric reference.

← All endpoints · How the data is measured · Pricing