Retrieves the historical (time series) liquidations data for the specified futures instrument.


Time Range Limit

The maximum time range (difference between startDate and endDate) is 731 days (2 years).


Not specifying startDate and endDate

If the startDate and endDate query parameters are not provided, the API will return the data from the previous 24 hours.


Fields and paths are relative to the top-level payload field i.e. metadata.next is equivalent to payload.metadata.next.

JSON Field/PathValue TypeOptionalDescription
metadata.api-versionstringThe API version of this response.
data[index].instrumentarrayThe futures instrument whose liquidation data was requested for.
data[index].exchangestringThe exchange on which this liquidation data is from.
data[index].actionstringThis field will show as null for all exchanges except Bitmex
data[index].orderIdstringThis field will show as null for most exchanges except Deribit and Bitmex.
data[index].sidestringThe direction of the liquidation.
data[index].statusstringThe status of the liquidation.
data[index].typestringThe type of the liquidation.
data[index].pricenumberThe price of the instrument at the time of liquidation.
data[index].volumenumberThe volume at the time of the liquidation.
data[index].timeInForcestringHow long the order is to remain active before it is executed or expires, for example:
- IOC: immediate-or-cancel
- FOK: fill-or-kill
- GTC: good-until-canceled
data[index].unitstringThe units are for volume

Refer to Liquidations - Information for more detail on unit.

Click Try It! to start a request and see the response here!