Available instruments
The pairs configured for request-for-stream, which of them are switched on, and which are streaming a price right now.
The set of pairs configured for request-for-stream trading, and their current state. Read it to populate an instrument picker, or to check a pair before subscribing.
enabled and active are different questions. A pair is enabled unless
it has been switched off by us; it is active only if a price is flowing for it
at the moment you ask. A pair that is enabled but not active is configured and
not currently quotable — subscribing to it is what produces
STREAM_UNAVAILABLE on the price channel.
Request
GET /zm/rest/available-instruments
No body, no query parameters. Note it is a GET — the only one on this
documentation, and unlike the /api/3 reads it does not take a signed body.
Response
| Field | Type | Notes |
|---|---|---|
instruments | AvailableInstrument[] | Every pair configured for request-for-stream, deduplicated and sorted by instrument |
AvailableInstrument
| Field | Type | Notes |
|---|---|---|
instrument | string | The pair, as TRADED.SETTLEMENT — for example BTC.USD |
settleDate | string | Always empty on this endpoint. Settlement dates come from the tenor you subscribe at, on the price channel |
levels | AvailableLevel[] | Always empty on this endpoint. It does not carry the size bands a subscription is priced against — a size no band covers is refused at subscribe instead |
enabled | boolean | Whether the pair is switched on. false means we have disabled it, not that you lack permission for it |
active | boolean | Whether a price is streaming for the pair as at this request. A pair can be enabled and not active |
AvailableLevel
Carried on levels, which this endpoint never populates. Documented because the
field names are part of the contract.
| Field | Type | Notes |
|---|---|---|
level | decimal | The size the band starts at |
available | boolean | Whether the band can be traded |