GET
/
options
/
order-book-events
/
{instrument}
Events Historical
curl --request GET \
  --url https://api.amberdata.com/markets/options/order-book-events/{instrument} \
  --compressed \
  --header 'Accept-Encoding: <accept-encoding>' \
  --header 'x-api-key: <api-key>'
{
  "status": 200,
  "title": "OK",
  "description": "Successful request",
  "payload": {
    "metadata": {
      "next": "https://api.amberdata.com/markets/options/order-book-events/BTC-18SEP24-60000-C?cursor=N4IgpgHgxgFghgOwOZhALhAIwJ6YJYAuIANCFAK4BOAzgPaXoLkA2zp1BclBAInAajQBGAOwAmAGwBWAMySAnEPnyppMAgAmfAelGSJQsVIAcU%2BTIAspPAijNyGsAFUE1cgAd39ARoCi0eGQwanQAMzhmajBSAjwAWzAAMXo4-nQQOLxWPCioWk0Q0lCUtIwAKzoEEhA6bgBpMGx0vWk5CUVlKQB9AAYunHwCLoV5CzF5CRl5MS6AIQAVAGEAWiFjAGVfAAUxC2WJHsOe5cWusDAJOGMZUNCQAF8gA",
      "api-version": "2023-09-30"
    },
    "data": [
      {
        "instrument": "BTC-18SEP24-60000-C",
        "exchange": "bybit",
        "exchangeTimestamp": 1726526186266,
        "exchangeTimestampNanoseconds": 0,
        "sequence": "26992247584",
        "ask": [
          {
            "price": 95,
            "volume": 3.92,
            "numOrders": null
          },
          {
            "price": 100,
            "volume": 26.97,
            "numOrders": null
          }
        ],
        "bid": []
      }
    ]
  }
}
The maximum time range (difference between startDate and endDate) is 1 hour.
If the startDate and endDate query parameters are not provided, the API will return the data from the previous 10 minutes.

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
required

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

​
startDate
string<date-time>

[Optional] Payload only includes data after this date (inclusive). [Defaults] Beginning of the current hour (max time range is 1 hour).

​
endDate
string<date-time>

[Optional] Payload only includes data before this date (exclusive). [Defaults] One hour after the beginning of the current hour (max time range is 1 hour).

​
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

The response is of type object.