Skip to main content
GET
Get instrument

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

instrument_id
string<uuid>
required

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.

created_at
string<date-time>
required

When the platform first learned of this instrument.

instrument
object
required

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.

instrument_id
string<uuid>
required

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.

last_seen_at
string<date-time>
required

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.

status
enum<string>
required

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.

Available options:
ACTIVE,
INACTIVE,
EXPIRED,
DELISTED
updated_at
string<date-time>
required