Get instrument details
Live 24h volume, quote volume, trade count, and price change for one instrument or a filtered set.
Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
| instrumentId | yes | string (decimal) | Instrument ID to fetch details for. When omitted, returns all indexed instruments (optionally narrowed by contractType / expiry / underlyingAsset). Cannot be combined with those filters. |
| contractType | yes | string | Optional contract type filter (comma-separated). Accepted values (case-insensitive): option, future, perp, spot. Ignored (and rejected) when instrumentId is set. |
| expiry | yes | string | null |
| underlyingAsset | yes | string | null |
Response fields
| Parameter | Required | Type | Description |
|---|---|---|---|
instruments | yes | object[] | Live 24h volume and price change for the requested instrument(s). |
instruments[].change24hr | yes | string | Quote price change over the 24h window (decimal string). |
instruments[].instrumentId | yes | string (decimal) | An instrument identifier (8-byte hash). |
instruments[].quoteVolume | yes | string | — |
instruments[].tradeCount | yes | integer (int64) | — |
instruments[].volume24hr | yes | string | — |
Response example
A sample 200 response body is attached to this operation as an OpenAPI example — see the Example panel on this page.
Path Parameters
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).
"42"
Optional contract type filter (comma-separated). Accepted values
(case-insensitive): option, future, perp, spot. Ignored (and rejected)
when instrumentId is set.
Optional expiry filter. Matches the instrument's formatted expiry (e.g. 28MAR25).
Ignored (and rejected) when instrumentId is set.
Optional underlying asset ticker filter (e.g. BTC). Case-insensitive.
Ignored (and rejected) when instrumentId is set.
Response
Instrument details
Live 24h volume and price change for the requested instrument(s).