Provides availability details for open interest data on options contracts, including contract symbols, underlying assets, and data coverage periods across supported exchanges.

get/options/open-interest/information

Request

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

Query parameters

exchangestring

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

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

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/open-interest/information?cursor=N4IglgdgxgNgrgEwKYEkIEMoBcwDckgBcAZujAM5IA0408yAqhOXAA6sD2ATlkggKIAPKAAt0EAOZJyRUhWogcAWyQAxbkvRYiIJWBgwwlKBwgIZNYhq06AVuVMgardFKIBGGuTAAvAoQBWAAYggF8gA",
      "api-version": "2023-09-30"
    },
    "data": [
      {
        "exchange": "bybit",
        "instrument": "BTC-24JUL24-62000-C",
        "underlying": "BTC",
        "startDate": 1721550049114,
        "endDate": 1721722822415
      }
    ]
  }
}

Changes