AMamberdata

Instruments

Changed on

Provides metadata for available options contracts on supported exchanges, including exchange names, contract symbols, and data types (Order Book Events, Ticker, Trades, etc.) with associated data coverage periods.

get/options/exchanges/information

Request

  • Base URL
    https://api.amberdata.com/markets
  • URL
    https://api.amberdata.com/markets/options/exchanges/information
  • Auth
    API key in header x-api-key

Query parameters

exchangestring

[Optional] Only return data for the given exchange(s) (comma separated)

instrumentstring

Only return data for the given pair.

includeInactiveboolean

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

timeFormatstring

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

sizeinteger

[Optional] The number of records per page (only available when includeInactive=true).

Headers

Accept-Encodingstring required
api-versionstring

Response

200

statusinteger
titlestring
descriptionstring

Example response

{
  "status": 200,
  "title": "OK",
  "description": "Successful request",
  "payload": {
    "metadata": {
      "next": "https://api.amberdata.com/markets/options/exchanges/information?cursor=N4IglgdgxgNgrgEwKYEkIEMoBcwDckgBcAZujAM5IA0408yAqhOXAA6sD2ATlkggKIAPKAAt0EAOZJyRUhWogcAWyQAxbkvRYiIJWBgwwlKBwgIZNYhq06AVuVMgardFKIBGGuTAAvAoQBWAAYggF8gA",
      "api-version": "2023-09-30"
    },
    "data": [
      {
        "exchange": "bybit",
        "instrument": "BTC-16AUG24-50000-C",
        "openInterest": {
          "startDate": 1721895646123,
          "endDate": 1722297559023
        },
        "orderBookSnapshot": {
          "startDate": 1721895180679,
          "endDate": 1722370735780
        },
        "orderBookEvent": {
          "startDate": 1721899231080,
          "endDate": 1721946070781
        },
        "ticker": {
          "startDate": 1721895381123,
          "endDate": 1722370799223
        }
      }
    ]
  }
}

Changes