Get instrument
Returns a single instrument by this platform’s id. The id is sufficient on its own - no asset class is required - and is stable across a venue renaming the symbol, which is why links and stored references use it rather than the symbol.
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 a futures contract 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. A future that expired last quarter is still the instrument last quarter's fills refer to, so retirement is a status change and this is what carries it.
ACTIVE, INACTIVE, EXPIRED, DELISTED