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
string

Narrow to one asset class. Worth passing whenever known: the catalogue is partitioned by class.

status
string

Tradability to list. Defaults to ACTIVE.

venue
string

Venue, in its own spelling

symbol
string

The venue's exact spelling of the instrument

root
string

Futures contract family

underlying
string

What an option is written on

base_asset
string

Asset being bought, for pairs

quote_asset
string

Asset it is priced in, for pairs

settlement
string

LINEAR or INVERSE, for perpetuals

expires_after
string

Inclusive lower bound on expiry, RFC 3339

expires_before
string

Exclusive upper bound on expiry, RFC 3339

next_cursor
string

Cursor from the previous page

limit
integer

Page size, clamped to 500

Required range: x >= 0
sort_direction
string

Direction to walk the symbol ordering

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.