Skip to main content
GET
List instruments

Authorizations

Authorization
string
header
required

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

Query Parameters

asset_class
enum<string>

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.

Available options:
UNSPECIFIED,
EQUITY,
FUTURE,
OPTION,
CURRENCY,
CRYPTO,
PERPETUAL,
PREDICTION
status
enum<string>

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.

Available options:
ACTIVE,
INACTIVE,
EXPIRED,
DELISTED
venue
string

An equity's primary listing venue. Options carry none

symbol
string

The exact spelling of the instrument: a ticker, or an OCC symbol for an option

underlying
string

Exact underlying symbol for an option

expires_after
string<date-time>

Inclusive lower bound on expiry, RFC 3339

expires_before
string<date-time>

Exclusive upper bound on expiry, RFC 3339

next_cursor
string

Cursor from the previous page

limit
integer

Page size; defaults to 50 and is clamped to 1 through 500

Required range: x >= 0
sort_direction
enum<string>

Direction to walk the symbol ordering; defaults to Asc. Lowercase asc and desc are also accepted

Available options:
Asc,
Desc

Response

A page of instruments

data
object[]
required
next_cursor
string | null

Cursor for the next page, or null when the page just returned was the last one.