Skip to main content
GET
Get A Bucketed OHLC Price Series For One Or More Assets

Query Parameters

assets
string[]

Assets in canonical : form (gateway.types.v1.AssetId), e.g. crypto:btc. Repeat the query parameter to request multiple, e.g. ?assets=crypto:btc&assets=crypto:eth. At most 10; duplicates are deduped server-side.

from
string<int64>

Unix-seconds start of the window. Required. Aligned down to the bucket, and raised when the window would exceed 3600 candles; the effective start is echoed in AssetPriceSeries.from.

to
string<int64>

Unix-seconds end of the window. 0 or a future value means now. The in-progress bucket is included. A past value is aligned up to 10 s for sub-minute buckets, or to one bucket otherwise; the effective end is echoed in AssetPriceSeries.to.

bucket
enum<string>

Candle width. Required; ASSET_PRICE_BUCKET_UNSPECIFIED is rejected.

Available options:
ASSET_PRICE_BUCKET_1S,
ASSET_PRICE_BUCKET_5S,
ASSET_PRICE_BUCKET_15S,
ASSET_PRICE_BUCKET_1M,
ASSET_PRICE_BUCKET_5M,
ASSET_PRICE_BUCKET_15M,
ASSET_PRICE_BUCKET_1H,
ASSET_PRICE_BUCKET_1D

Response

Asset price series

series
object[]

One series per distinct requested asset. Match by the asset field, never by position: the order is not guaranteed and REST returns the series sorted by symbol