Skip to main content
GET
/
options
/
order-book-events
/
information
Events Information
curl --request GET \
  --url https://api.amberdata.com/markets/options/order-book-events/information \
  --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/information?cursor=N4IglgdgxgNgrgEwKYEkIEMoBcwDckgBcAZujAM5IA0408yAqhOXAA6sD2ATlkggKIAPKAAt0EAOZJyRUhWogcAWyQAxbkvRYiIJWBgwwlKBwgIZNYhq06AVuVMgardFKIBGGuTAAvAoQBWAAYggF8gA",
      "api-version": "2023-09-30"
    },
    "data": [
      {
        "exchange": "bybit",
        "instrument": "BTC-18SEP24-53000-C",
        "underlying": "BTC",
        "startDate": 1726446949183,
        "endDate": 1726611867867
      },
      {
        "exchange": "bybit",
        "instrument": "BTC-18SEP24-53000-P",
        "underlying": "BTC",
        "startDate": 1726446941517,
        "endDate": 1726611898406
      }
    ]
  }
}

Authorizations

​
x-api-key
string
header
required

Headers

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

Query Parameters

​
exchange
string

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

​
instrument
string

Only return data for the given pair.

​
includeInactive
boolean

[Optional] If true, endpoint returns all instruments, including delisted ones. [Defaults] false* | true

​
timeFormat
string

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

Response

200 - application/json

200

​
status
integer
​
title
string
​
description
string
​
payload
object