Skip to main content
GET
/
options
/
liquidations
/
{instrument}
Historical
curl --request GET \
  --url https://api.amberdata.com/markets/options/liquidations/{instrument} \
  --compressed \
  --header 'Accept-Encoding: <accept-encoding>' \
  --header 'x-api-key: <api-key>'
{
  "status": 200,
  "title": "OK",
  "description": "Successful request",
  "payload": {
    "metadata": {
      "next": null,
      "api-version": "2023-09-30"
    },
    "data": [
      {
        "instrument": "BTC-29DEC23-30000-C",
        "exchange": "deribit",
        "exchangeTimestamp": 1691321498000,
        "exchangeTimestampNanoseconds": 0,
        "action": null,
        "orderId": "262149185",
        "side": "BUY",
        "status": null,
        "timeInForce": null,
        "type": null,
        "price": 0.0935,
        "volume": 2,
        "unit": "base_asset",
        "tickDirection": 2,
        "markPrice": 0.09432956,
        "indexPrice": 29033.78
      }
    ]
  }
}
The maximum time range (difference between startDate and endDate) is 365 days (1 year).

Authorizations

​
x-api-key
string
header
required

Headers

​
Accept-Encoding
string
default:gzip, deflate, br
required
​
api-version
string

Path Parameters

​
instrument
string
default:BTC-27DEC24-100000-C
required

The instrument for which to retrieve the requested data.

Query Parameters

​
exchange
string
default:deribit
required

The exchange(s) for which to retrieve the requested data (comma separated). [Defaults] All available exchanges.

​
startDate
string<date-time>
default:1691321498000

[Optional] Payload only includes data after this date (inclusive). [Formats] seconds | milliseconds | iso8601 [Examples] 1578531600 | 1578531600000 | 2020-09-01T01:00:00

​
endDate
string<date-time>

[Optional] Payload only includes data before this date (exclusive). [Formats] seconds | milliseconds | iso8601 [Examples] 1578531600 | 1578531600000 | 2020-09-01T01:00:00

​
timeFormat
string

[Optional] Time format of the timestamps in the return payload. [Defaults] milliseconds | ms* | iso | iso8601 | hr | human_readable

​
sortDirection
string

[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

Response

200 - application/json

200

​
status
integer
default:0
Example:

200

​
title
string
Example:

"OK"

​
description
string
Example:

"Successful request"

​
payload
object