Historical Data Access Warning
Historical Data Access Warning
- REST APIs are optimized for recent, low-latency access to granular data. Using them for deep historical queries can lead to performance degradation, rate limiting, and an inconsistent experience. Bulk delivery options are purpose-built for large data pulls and are the best fit for these needs.
BitMEX Volume Calculation Warning
BitMEX Volume Calculation Warning
volume
field represents the number of contracts traded, not the volume in the base asset.To obtain the correct volume, users must adjust for contract size using the underlyingToPositionMultiplier
from our Reference endpoint.For details on this calculation and how to retrieve the correct values, see our Changelog Update.startDate
and endDate
) is 18 months.startDate
and endDate
query parameters are not provided, the API will return the data from the previous 24 hours.Authorizations
Path Parameters
The instrument for which to retrieve the requested data.
Query Parameters
The exchange for which data should be retrieved. Only 1 exchange is allowed.
[Optional] Payload only includes data after this date (inclusive). [Defaults] Beginning of the current minute (max time range is 10 minutes).
[Optional] Payload only includes data before this date (exclusive). [Defaults] Ten minutes after the beginning of the current hour (max time range is 10 minutes).
[Optional] The timestamp at which to return the order book information (closest match, lower or equal to the timestamp specified).
[Optional] Time format of the timestamps in the return payload. [Defaults] milliseconds | ms* | iso | iso8601 | hr | human_readable
[Optional] Specifies the direction in which the data is sorted (by timestamp). [Defaults] asc (ascending order). [Usage Conditions] This parameter can only be used if the startDate
and endDate
timeframe is within the most recent 24 hours, or if the startDate
and endDate
parameters are not used at all. [Examples] ascending | descending | asc | desc
The number of order book levels that should be returned.
Response
200
The response is of type object
.