Documentation / New API reference / Price
Get Price OHLC
Last reviewed 2026-10-07
OHLC candles for an asset, aggregated by period.
Try it
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
asset | query | string | Yes | Asset symbol, e.g. TAO. Matched case-insensitively. |
period | query | string | Yes | Candle period: 1m, 1h or 1d. One of 1m, 1h, 1d. |
timestamp_start | query | integer (int64) | Range start, unix seconds (inclusive). | |
timestamp_end | query | integer (int64) | Range end, unix seconds (exclusive) — an observation recorded exactly at this second belongs to the next candle, so a range ending on a period boundary does not open a one-row candle beyond it. This matches the OLD API's /api/price/ohlc/v1, whose upper bound is also exclusive while /api/price/history/v1's is inclusive. | |
page | query | integer (int32) | Page number (1-indexed). Default: 1. Bounded window: (page − 1) × limit must be below 1,000,000. Deep OFFSET paging is linear in the offset, so a page past the window is rejected with a 400. Reach deeper history with timestamp_start / timestamp_end rather than a larger page. | |
limit | query | integer (int32) | Results per page. Default: 50. Max: 200. |
Responses
200 — Paginated OHLC candles, newest first
| Field | Type | Required | Description |
|---|---|---|---|
data | array | Yes | |
data[].asset | string | Yes | Asset symbol, echoed back. |
data[].close | string | Yes | Last price in the period (decimal string, four decimal places). |
data[].high | string | Yes | Highest price in the period (decimal string, four decimal places). |
data[].low | string | Yes | Lowest price in the period (decimal string, four decimal places). |
data[].open | string | Yes | First price in the period (decimal string, four decimal places). |
data[].period | string | Yes | The requested period: 1m, 1h or 1d. |
data[].timestamp | string | Yes | Start of the period (ISO 8601). |
data[].volume_24h | string | Yes | 24-hour volume reported by the period's closing observation (decimal string, four decimal places). |
pagination | object | Yes | Pagination metadata appended to collection responses. next_page / prev_page are explicitly required+nullable in the OpenAPI spec: per docs/api_standards.md we emit null rather than omitting the field, so the SDK should model them as Option/nullable types that are always present in the response. total_items is the exact number of matching rows on every route (issue #992). It used to stop at 1,000,000, which reported a million transfers when finney holds 7,513,252 and a million events when the real figure is 981,179,110; the cap was removed on 29 Sep 2026 and nothing may reintroduce one — crate::pagination::exact_count_sql is the only count form, and no_capped_count_reaches_the_api_surface in data-debug-scripts fails the build if a capped one comes back. total_pages is still bounded, to crate::pagination::max_reachable_page(per_page), because the page parameter is capped to a 1,000,000-row window: deep OFFSET paging reads every skipped row (24.7M rows / 36.6 GiB / 42 s measured on one endpoint, issue #413). So total_pages is exactly the last page this API will serve and next_page / prev_page stay coherent at the window edge, while total_items tells the caller how many rows there really are. History beyond the window is reached with each endpoint's range filters, not a larger page. |
pagination.current_page | integer (int32) | Yes | 1-indexed page that produced the rows in data. |
pagination.next_page | integer (int32), nullable | Yes | Next page number, or null if this is the last page. |
pagination.per_page | integer (int32) | Yes | Number of items requested per page. |
pagination.prev_page | integer (int32), nullable | Yes | Previous page number, or null if this is the first page. |
pagination.total_items | integer (int64) | Yes | Number of items matching the query across all pages. This is the exact count — every matching row, however many there are. It is not bounded by total_pages, so a listing can legitimately report far more items than total_pages × per_page. |
pagination.total_pages | integer (int32) | Yes | Number of pages at the current per_page that this API will serve: ceil(total_items / per_page), capped at ceil(1000000 / per_page) because the page parameter only reaches into the first 1,000,000 rows. When the cap bites, total_items is still the true total and this is the last page a request can ask for; reach deeper history with the endpoint's range filters instead of a larger page. |
400 — Invalid query parameter
| Field | Type | Required | Description |
|---|---|---|---|
message | string | Yes | Plain-english message describing the failure from the caller's perspective. |
status_code | integer (int32) | Yes | HTTP status code (mirrored in the response status line for convenience). |
500 — Internal server error
| Field | Type | Required | Description |
|---|---|---|---|
message | string | Yes | Plain-english message describing the failure from the caller's perspective. |
status_code | integer (int32) | Yes | HTTP status code (mirrored in the response status line for convenience). |
Every request needs an Authorization header holding your API key — see Getting started with the Taostats API.