Reference

Provides essential reference details for options contracts on supported exchanges, including contract symbols, underlying assets, strike prices, expiration dates, settlement types, price and volume limits, and precision requirements.

get/options/exchanges/reference

Request

Base URL
https://api.amberdata.com/markets
URL
https://api.amberdata.com/markets/options/exchanges/reference
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*.

sizeinteger

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

startDatestring date-time

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

endDatestring date-time

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

includeOriginalReferenceboolean

[Optional] If true, endpoint returns originalReference. [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/exchanges/reference?cursor=N4IglgdgxgNgrgEwKYEkIEMoBcwDckgBcAZujAM5IA0408yA8gE5gDmkZASksUk0tAIkylGpFiIkAVQjk4AB3kB7JliQIAogA8oAC3QRWSckVIVqIHAFskAMRVX0WIiCtgYMMJShKICEzTEDk4uAFbkviA08uhGRACMNORgAF5CAKwADJkAvkA",
      "api-version": "2023-09-30"
    },
    "data": [
      {
        "exchange": "bybit",
        "instrument": "BTC-16AUG24-50000-C",
        "baseSymbol": "BTC",
        "quoteSymbol": "USDC",
        "market": "options",
        "exchangeEnabled": true,
        "limitsPriceMin": 5,
        "limitsPriceMax": 10000000,
        "limitsMarketMin": 0.01,
        "limitsMarketMax": 500,
        "precisionPrice": 5,
        "precisionVolume": 0.01,
        "listingTimestamp": 1721894400000,
        "contractUnderlying": "BTC",
        "contractExpirationTimestamp": 1723795200000,
        "contractPeriod": "weekly",
        "contractSettleType": "option",
        "contractSettleSymbol": "USDC",
        "optionType": "call",
        "optionStrikePrice": 50000
      }
    ]
  }
}

Changes

No recorded changes to this operation across all 2 revisions of this API.