Instruments

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.

⚠️ IMPORTANT UPDATE ⚠️

⚠️

Important Update

The old endpoint https://api.amberdata.com/market/options/exchanges/information has been updated to https://api.amberdata.com/markets/options/exchanges/information and is no longer being supported. Please update your integrations accordingly.

See changes here
  • Endpoint URL Change:
    • Old: https://api.amberdata.com/market/options/exchanges/information
    • New: https://api.amberdata.com/markets/options/exchanges/information
  • Metadata Changes:
    • api-version field added to the response
  • Data Structure Changes:
    • The old schema data structure was a nested JSON object with exchanges and instruments
    • The new schema data structure is an array of JSON objects, each representing an exchange and instrument with detailed date ranges for different data types
  • Field Value Changes:
    • open_interest renamed to openInterest
    • order_book_snapshot renamed to orderBookSnapshot
  • Other
    • Include the Accept-Encoding: header in your API requests to take advantage of compressed responses.
    • includeDates parameter is no longer supported as dates are always provided
RESPONSE DATA
FieldTypeDescription
payload.metadata.nextstringPagination
payload.data.{exchange}objectExchange object, contains a list of pairs supported by the exchange.
payload.data.{exchange}.{instrument}objectInstrument object, contains information about the instrument.
payload.data.{exchange}.{pair}.{feature}objectFeature object, contains information about this feature.
payload.data.{exchange}.{pair}.{feature}.startDatenumber | stringFirst available data point.
payload.data.{exchange}.{pair}.{feature}.endDatenumber | stringLast available data point.
payload.data.{exchange}.{pair}.{feature}.activebooleanFalse if the instrument is no longer active (only available when includeInactive=true).
Language
Credentials
Header
Click Try It! to start a request and see the response here!