Skip to main content
GET
Get instrument details

Path Parameters

instrumentId
null | string<decimal>
required

Instrument ID to fetch details for. When omitted, returns all indexed instruments (optionally narrowed by contractType / expiry / underlyingAsset). Cannot be combined with those filters. An instrument identifier (8-byte hash).

Example:

"42"

contractType
string
required

Optional contract type filter (comma-separated). Accepted values (case-insensitive): option, future, perp, spot. Ignored (and rejected) when instrumentId is set.

expiry
string | null
required

Optional expiry filter. Matches the instrument's formatted expiry (e.g. 28MAR25). Ignored (and rejected) when instrumentId is set.

underlyingAsset
string | null
required

Optional underlying asset ticker filter (e.g. BTC). Case-insensitive. Ignored (and rejected) when instrumentId is set.

Response

Instrument details

instruments
object[]
required

Live 24h volume and price change for the requested instrument(s).