GET /v1/latest
Updated
What does GET /v1/latest do?
The most recent closed five-minute row for one pair on one venue. Returns the wide row for the latest closed five-minute window for a single pair on a single venue: the price candle, taker trade flow, depth bands, order ladders, book churn and the per-coin and market-wide context columns, all measured from that venue’s own book and tape.
Pass columns to narrow the row to the fields you need. Columns outside your plan are omitted from the response and named in the X-BlackForge-Columns-Omitted header, so a request never silently drops a field without telling you.
This is the endpoint to poll for a current reading. For a range over time, use the series endpoint instead.
Authentication
API key required. Set $BF to the API base and pass your key in $BLACKFORGE_API_KEY.
Parameters
| 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. |
columns | string | No | Comma-separated metric keys to return. Columns outside your plan are omitted and named in the X-BlackForge-Columns-Omitted response header. |
Parameter shapes from the live OpenAPI document.
Example request
curl -H "x-api-key: $BLACKFORGE_API_KEY" \
"$BF/v1/latest?exchange=binance&symbol=BTCUSDT&columns=price,buyTradeVol,sellTradeVol,bidLiqAdded"Example response
{
"ts": 1787463600000,
"values": {
"price": 76229.64,
"buyTradeVol": 2451000.8676634203,
"sellTradeVol": 2157728.7544729924,
"bidLiqAdded": 305669783.99589294
}
}Returns
A JSON object with ts (the window-close time in epoch milliseconds), values (the requested columns), and quality (the row’s quality bitmask, its named flags, and which column families they contaminate).
Responses and errors
| Status | When |
|---|---|
400 | A required parameter is missing, or a named column or metric key is not in the catalog. |
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. |
Columns it returns
Each column is defined on its own page. Last price, Taker buy volume, Bid liquidity added. See the full metric reference.