Reference

Retrieves reference information for each of the instruments.

⚠️

Important Update

The old endpoint https://api.amberdata.com/market/futures/exchanges/reference has been updated to https://api.amberdata.com/markets/futures/exchanges/reference. The old endpoint will be deprecated on 2024-09-30. Please update your integrations accordingly.

See changes here
  • Endpoint URL Change:
    • Old: https://api.amberdata.com/market/futures/exchanges/reference
    • New: https://api.amberdata.com/markets/futures/exchanges/reference
  • 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 information
  • Field Value Changes:
    • exchange: New field
    • instrument: New field
    • market: New field
    • exchangeEnabled: Replaces active
    • limitsPriceMin: Replaces limits_price_min
    • limitsPriceMax: Replaces limits_price_max
    • limitsVolumeMin: Replaces limits_amount_min
    • limitsVolumeMax: Replaces limits_amount_max
    • limitsMarketMin: Replaces limits_market_min
    • limitsMarketMax: Replaces limits_market_max
    • limitsLeverageMin: Replaces limits_leverage_min
    • limitsLeverageMax: Replaces limits_leverage_max
    • limitsLeverageSuperMax: New field
    • limitsCostMin: Replaces limits_cost_min
    • limitsCostMax: Replaces limits_cost_max
    • precisionVolume: Replaces precision_amount
    • listingTimestamp: New field
    • contractUnderlying: Replaces underlying
    • contractExpirationTimestamp: Replaces expiration
    • contractPeriod: Replaces contractType
    • contractSettleType: Replaces marginType
    • contractSettleSymbol: Replaces settleAsset
  • Other
    • Include the Accept-Encoding: header in your API requests to take advantage of compressed responses.

📘

CME Data

Only tickers, trades and open-interest are supported for CME. Please access the information endpoints for those data types directly to discover the available CME instruments.

🚧

precision_amount

Occasionally, you may encounter a value of 0 for precision_amount. This is due to the underlying exchange returning 0 for the instrument's trade size precision.

We have noticed this behavior with several instruments on Kraken.

RESPONSE DATA
FieldTypeDescription
payload.metadata.nextstringPagination
payload.data.{exchange}objectExchange object, contains a list of instruments supported by the exchange.
payload.data.{exchange}.{instrument}objectInstrument object, contains information about the instrument.
payload.data.{exchange}.{instrument}.contractTypestringContract type for instrument
payload.data.{exchange}.{instrument}.limits_price_maxnumberMaximum price for instrument
payload.data.{exchange}.{instrument}.limits_price_minnumberMinimum price for instrument
payload.data.{exchange}.{instrument}.limits_amount_maxnumberMaximum amount for instrument
payload.data.{exchange}.{instrument}.limits_amount_minnumberMinimum amount for instrument
payload.data.{exchange}.{instrument}.limits_market_maxnumberMaximum market for instrument
payload.data.{exchange}.{instrument}.limits_market_minnumberMinimum market for instrument
payload.data.{exchange}.{instrument}.precision_basenumberprecision base for instrument
payload.data.{exchange}.{instrument}.precision_quotenumberPrecision quote for instrument
payload.data.{exchange}.{instrument}.precision_amountnumberPrecision for the trade size
payload.data.{exchange}.{instrument}.expirationtimestampThe time when the instrument will expire
payload.data.{exchange}.{instrument}.underlyingstringUnderlying for instrument
payload.data.{exchange}.{instrument}.nativeInstrumentstringThe name of instrument
payload.data.{exchange}.{instrument}.quoteAssetstringQuote asset for instrument
payload.data.{exchange}.{instrument}.contractSizenumberContract size for instrument (also known as the contract multiplier)
payload.data.{exchange}.{instrument}.marginTypestringMargin type for instrument
payload.data.{exchange}.{instrument}.originalReferenceobjectThe full payload from the exchanges directly for instrument
Language
Authorization
Header
Click Try It! to start a request and see the response here!