Sign in

v1

latestOpenAPI 3.0.02026-07-26117342409.6 KB
Pricing

List Historical Prices

Retrieves a set of average prices at a certain increment of time for the requested market. This endpoint is suitable for retrieving historical average price trends where price precision, execution, and other detailed information is not required. To control the count, use either increment or max_data_points. List Historical Prices returns an error when an unexpected value is given, or when increment and max_data_points are both given or omitted.

When range.begin is omitted, the first data point shows the mid price, the average of the order book best bid and ask price, or the earliest available date. It is possible to set range.begin to a future date without error.

When range.end is omitted, the last data point will display current mid price (average of order book best bid and best ask) at the request timestamp. It is possible to set range.end to a future date without error.

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

Time-series items are returned in chronological (ascending) order. All timestamps are in UTC.

get/markets/{market}/historical-prices

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 Order Book.

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 recording 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.

pagination.limitinteger

Number of results to return

pagination.offsetinteger

Number of results to skip

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 exclusive from range.begin and range.end. Do not use with max_data_points, as this results in an error.

Response

A successful response.

total_countinteger