List instruments
Lists the shared equity and option catalogue. Defaults to ACTIVE entries; catalogue status does not grant trading permission. Each instrument is tagged by asset_class. Text filters are trimmed and blank values are ignored. Continue with next_cursor until null, keeping filters and sort direction unchanged.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Query Parameters
EQUITY or OPTION. Other classes return 400.
The kind of thing an Instrument [blocked] is, without its payload.
Separate from the sum type because the discriminant travels where the
payload cannot: a column, a metric label, a capability check asking whether
this deployment is cleared to trade futures at all. It is Copy and
string-convertible for exactly those uses.
Unspecified is what an unset column reads back as, the same role it plays
on Feed [blocked] and
Broker [blocked].
Instrument::asset_class [blocked] never returns it.
UNSPECIFIED, EQUITY, FUTURE, OPTION, CURRENCY, CRYPTO, PERPETUAL, PREDICTION Catalogue status. Defaults to ACTIVE. 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 An equity's primary listing venue. Options carry none
The exact spelling of the instrument: a ticker, or an OCC symbol for an option
Exact underlying symbol for an option
Inclusive lower bound on expiry, RFC 3339
Exclusive upper bound on expiry, RFC 3339
Cursor from the previous page
Page size; defaults to 50 and is clamped to 1 through 500
x >= 0Direction to walk the symbol ordering; defaults to Asc. Lowercase asc and desc are also accepted
Asc, Desc