Discovery and account data
Read the instrument catalog
instrument_type is 1 spot or 2 derivatives.
GET
Read canonical symbols/list
Preview contract. Production availability remains subject to activation and release qualification. Examples are synthetic; the documentation cannot submit requests.
Authorization
read; enumeration and exact selection respect instrument restrictions.
Behavior
instrument_type is 1 spot or 2 derivatives. Read data.all, optional selected, hash and expiration. Preserve opaque instrument IDs. Send the returned 64-character catalog hash on an equivalent refresh; 304 means the supplied catalog is current and has no new response body.Request example
Response and errors
The generated response schema below is the wire contract. Preserve fixed-point strings, nullable fields and endpoint-specific envelopes. Inspect HTTP status and Content-Type before decoding failures; reused trading routes may return JSON or plain text. Authentication, entitlement and exact link/instrument restrictions apply in addition to endpoint validation. See errors and recovery. Read the related guide for lifecycle, units and recovery semantics.Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Query Parameters
Required range:
1 <= x <= 9007199254740991Pattern:
^[a-f0-9]{64}$