Get product candles
Historic rates for a product. Rates are returned in grouped buckets. Candle schema is of the form [timestamp, price_low, price_high, price_open, price_close]
- Historical rate data may be incomplete. No data is published for intervals where there are no ticks.
- Historical rates should not be polled frequently. For real-time info, use the trade and book endpoints in conjunction with the WebSocket feed.
Time Range
If the start or end fields are not provided, both fields are ignored. If a custom time range is not declared, then one ending now is selected.
The granularity field must be one of the following “second” values: {60, 300, 900, 3600, 21600, 86400}, or your request is rejected. These values correspond to timeslices representing one minute, five minutes, fifteen minutes, one hour, six hours, and one day, respectively.
If data points are readily available, your response may contain as many as VAR::REST_MAX_CANDLES_PER_REQUEST candles and some of those candles may precede your declared start value.
Max Candles
The maximum number of data points for a single request is VAR::REST_MAX_CANDLES_PER_REQUEST candles.
If your selection of start/end time and granularity results in more than VAR::REST_MAX_CANDLES_PER_REQUEST data points, your request is rejected. To retrieve fine granularity data over a larger time range, you must make multiple requests with new start/end ranges.
Response Items
Each bucket is an array of the following information:
timebucket start timelowlowest price during the bucket intervalhighhighest price during the bucket intervalopenopening price (first trade) in the bucket intervalcloseclosing price (last trade) in the bucket intervalvolumevolume of trading activity during the bucket interval
Path Parameters
Query Parameters
Timestamp for starting range of aggregations
Timestamp for ending range of aggregations
Response
The response is of type object[].