v1

latestOpenAPI 3.1.02026-07-26399062.0 KB
api-gateway

get/instrument

Query parameters

symbolstring required

Response

Instrument details

additional_product_specsobject required
category'compute' | 'crypto' | 'energy' | 'energy_etfs' | 'equities' | 'fx' | 'metals' | 'treasuries' required
contract_mark_pricestring nullable
contract_sizestring nullable
descriptionstring nullable
estimated_funding_supportedboolean

Whether a live index feed is configured for this instrument, so an intraday funding-rate estimate can be produced. When false, the estimated-funding endpoint reports the symbol as unsupported and clients should not surface an estimate for it.

expirationstring date-time nullable

Absolute expiration time for dated contracts. None for perpetuals. Presence of a value is the discriminator between dated and perpetual contracts.

funding_rate_cap_lower_pctstring nullable
funding_rate_cap_upper_pctstring nullable
funding_schedule_calendar_descriptionstring nullable
funding_schedule_time_descriptionstring nullable
funding_settlement_currencystring required
initial_margin_pctstring required
maintenance_margin_pctstring required
minimum_order_sizestring required
multiplierstring required
price_band_lower_deviation_pctstring nullable
price_band_upper_deviation_pctstring nullable
price_bandsstring nullable
price_quotationstring nullable
price_scaleinteger required
productstring

Umbrella product this instrument belongs to (e.g. XAU for XAU-PERP, XAU-2026-SEP, XAU-2026-DEC). Instruments that share a product are the same underlying and can be grouped together in a product list.

quote_currencystring required
symbolstring required
tick_sizestring required
underlying_benchmark_pricestring nullable

Example response

{
  "funding_schedule": {
    "timezone": "Europe/London"
  }
}