Retrieves reference information for each of the instruments.
Important Update
The old endpoint
https://api.amberdata.com/market/futures/exchanges/reference
has been updated tohttps://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 fieldinstrument
: New fieldmarket
: New fieldexchangeEnabled
: Replacesactive
limitsPriceMin
: Replaceslimits_price_min
limitsPriceMax
: Replaceslimits_price_max
limitsVolumeMin
: Replaceslimits_amount_min
limitsVolumeMax
: Replaceslimits_amount_max
limitsMarketMin
: Replaceslimits_market_min
limitsMarketMax
: Replaceslimits_market_max
limitsLeverageMin
: Replaceslimits_leverage_min
limitsLeverageMax
: Replaceslimits_leverage_max
limitsLeverageSuperMax
: New fieldlimitsCostMin
: Replaceslimits_cost_min
limitsCostMax
: Replaceslimits_cost_max
precisionVolume
: Replacesprecision_amount
listingTimestamp
: New fieldcontractUnderlying
: Replacesunderlying
contractExpirationTimestamp
: Replacesexpiration
contractPeriod
: ReplacescontractType
contractSettleType
: ReplacesmarginType
contractSettleSymbol
: ReplacessettleAsset
- 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 returning0
for the instrument's trade size precision.We have noticed this behavior with several instruments on Kraken.
RESPONSE DATA
Field | Type | Description |
---|---|---|
payload.metadata.next | string | Pagination |
payload.data.{exchange} | object | Exchange object, contains a list of instruments supported by the exchange. |
payload.data.{exchange}.{instrument} | object | Instrument object, contains information about the instrument. |
payload.data.{exchange}.{instrument}.contractType | string | Contract type for instrument |
payload.data.{exchange}.{instrument}.limits_price_max | number | Maximum price for instrument |
payload.data.{exchange}.{instrument}.limits_price_min | number | Minimum price for instrument |
payload.data.{exchange}.{instrument}.limits_amount_max | number | Maximum amount for instrument |
payload.data.{exchange}.{instrument}.limits_amount_min | number | Minimum amount for instrument |
payload.data.{exchange}.{instrument}.limits_market_max | number | Maximum market for instrument |
payload.data.{exchange}.{instrument}.limits_market_min | number | Minimum market for instrument |
payload.data.{exchange}.{instrument}.precision_base | number | precision base for instrument |
payload.data.{exchange}.{instrument}.precision_quote | number | Precision quote for instrument |
payload.data.{exchange}.{instrument}.precision_amount | number | Precision for the trade size |
payload.data.{exchange}.{instrument}.expiration | timestamp | The time when the instrument will expire |
payload.data.{exchange}.{instrument}.underlying | string | Underlying for instrument |
payload.data.{exchange}.{instrument}.nativeInstrument | string | The name of instrument |
payload.data.{exchange}.{instrument}.quoteAsset | string | Quote asset for instrument |
payload.data.{exchange}.{instrument}.contractSize | number | Contract size for instrument (also known as the contract multiplier) |
payload.data.{exchange}.{instrument}.marginType | string | Margin type for instrument |
payload.data.{exchange}.{instrument}.originalReference | object | The full payload from the exchanges directly for instrument |