Get instrument
Returns one instrument by its stable platform ID, regardless of catalogue status. No asset class is required. Available to authenticated users, API keys and services.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Instrument id
Response
Instrument found
One instrument as the catalogue holds it.
The identity itself is [Instrument] from rust_types, unchanged - the
same sum type the adapters and the order path work in, so a caller does not
have to reassemble an option from a bag of nullable fields to discover it
has a multiplier. Everything outside instrument is
catalogue bookkeeping rather than a property of the thing traded, which is
why it sits beside it rather than inside it.
When the platform first learned of this instrument.
What is traded, and the facts that make its price mean something.
Tagged by asset_class, so a consumer reads the class once and gets
only the fields that class actually has.
- Option 1
- Option 2
- Option 3
- Option 4
- Option 5
- Option 6
- Option 7
This platform's id for the instrument. Stable across a venue renaming the symbol, which is why the API pages and links on it rather than on the symbol.
When a venue refresh last confirmed the instrument still exists.
The staleness signal: a venue that stops listing a contract usually says nothing at all, so the only evidence is a row the sync stopped touching.
Whether an instrument can be traded now.
Rows are never deleted from the catalogue. An option that expired last month is still the instrument last month's fills refer to, so retirement is a status change and this is what carries it.
ACTIVE, INACTIVE, EXPIRED, DELISTED