Sign in

v1

latestOpenAPI 3.0.02026-07-26117342409.6 KB
Pricing

List Historical Candles

Returns OHLCV Candlesticks data for the given market. To control the count, use either increment or max_data_points. List Historical Candles returns an error when an unexpected value is given, or when increment and max_data_points are both given or omitted.

When range.end is omitted, it will default to the current UTC timestamp. It is possible to set range.end to a future date without error.

Omitting range.begin defaults it to six months before range.end.

When limit is omitted, it will default to return the first 100 items. If limit is set, the API will return up to the limit in one response. The maximum limit is 1,000.

Time-series items are in descending order. All timestamps are in UTC.

Markets that are not yet available will return a 400 error.

get/markets/{market}/historical-candles

Path parameters

market'ETHEUR' | 'ETHUSD' | 'BTCEUR' | 'BTCUSD' | 'PAXGUSD' | 'BCHUSD' | 'LTCUSD' | 'ETHGBP' | 'BTCGBP' | 'LTCGBP' | 'BCHGBP' | 'USDPUSD' | 'ETHBRL' | 'BTCBRL' | 'LTCBRL' | 'BCHBRL' | 'USDPGBP' | 'USDPBRL' | 'LINKUSD' | 'AAVEUSD' | 'UNIUSD' | 'AAVEMXN' | 'BCHMXN' | 'BTCMXN' | 'ETHMXN' | 'LTCMXN' | 'USDPMXN' | 'AAVEEUR' | 'BCHEUR' | 'LTCEUR' | 'LINKEUR' | 'PAXGEUR' | 'SOLEUR' | 'USDPEUR' | 'UNIEUR' | 'PYUSDEUR' | 'PYUSDGBP' | 'PEPEUSD' | 'TRUMPUSD' | 'SHIBUSD' | 'ARBUSD' | 'BONKUSD' | 'ENAUSD' | 'MNTUSD' | 'ONDOUSD' | 'PENGUUSD' | 'QNTUSD' | 'RENDERUSD' | 'SKYUSD' | 'WIFUSD' | 'WLDUSD' | 'DOGEUSD' | 'AVAXUSD' | 'SUIUSD' | 'POLUSD' | 'XLMUSD' | 'BNBUSD' required

Market of candle.

Query parameters

max_data_pointsinteger

Maximum number of data points to return.

The time frame of the increments will be inferred by finding the most granular increment without breaching the max_data_points value based on a set of recorded data points.

range.beginstring date-time

Only return records after this timestamp, inclusive. RFC3339 format, like 2006-01-02T15:04:05Z.

range.endstring date-time

Only return records before this timestamp, inclusive. RFC3339 format, like 2006-01-02T15:04:05Z.

limitinteger

Number of results to return. Defaults to 100 if no limit is provided. Maximum 1000.

order'DESC' | 'ASC'

Results are ordered by timestamp. Specify the ordering of the results. Defaults to DESC.

page_cursorstring

Cursor for pagination

increment'ONE_MINUTE' | 'FIVE_MINUTES' | 'FIFTEEN_MINUTES' | 'THIRTY_MINUTES' | 'ONE_HOUR' | 'TWO_HOURS' | 'TWELVE_HOURS' | 'ONE_DAY' | 'ONE_WEEK' | 'TWO_WEEKS' | 'FOUR_WEEKS'

Time increment between prices. Returns data inclusive from range.begin and range.end. Do not use with max_data_points, as this results in an error.

Response

A successful response.

market'ETHUSD' | 'BTCUSD' | 'PAXGUSD' | 'BCHUSD' | 'LTCUSD' | 'USDPUSD' | 'LINKUSD' | 'AAVEUSD' | 'UNIUSD' | 'PEPEUSD' | 'TRUMPUSD' | 'SHIBUSD' | 'ARBUSD' | 'BONKUSD' | 'ENAUSD' | 'MNTUSD' | 'ONDOUSD' | 'PENGUUSD' | 'QNTUSD' | 'RENDERUSD' | 'SKYUSD' | 'WIFUSD' | 'WLDUSD' | 'DOGEUSD' | 'AVAXUSD' | 'SUIUSD' | 'POLUSD' | 'XLMUSD' | 'BNBUSD'
increment'ONE_MINUTE' | 'FIVE_MINUTES' | 'FIFTEEN_MINUTES' | 'THIRTY_MINUTES' | 'ONE_HOUR' | 'TWO_HOURS' | 'TWELVE_HOURS' | 'ONE_DAY' | 'ONE_WEEK' | 'TWO_WEEKS' | 'FOUR_WEEKS'
next_page_cursorstring

Cursor token required for fetching the next page.