Skip to main content
POST
List instruments

Authorizations

Authorization
string
header
required

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

Body

application/json

Request for listing instruments.

Request for listing instruments.

pageSize
integer<int32>

Results per page (default: 50, max: 1000)

pageToken
string

Pagination cursor from previous response

symbols
string[]

Filter by specific instrument symbols

productId
string

Filter by product ID

tradableFilter
enum<string>

Filter tradable vs non-tradable instruments

Available options:
TRADABLE_FILTER_NON_TRADABLE,
TRADABLE_FILTER_TRADABLE
states
enum<string>[]

Filter by instrument states (e.g., INSTRUMENT_STATE_OPEN)

PENDING: Initial state for a newly created instrument which has not yet begun trading.

CLOSED: No order entry, modification, cancellation, or matching. Day orders expired.

OPEN: Continuous order entry and matching.

PREOPEN: Orders accepted, no matching. Dutch Auction on transition to OPEN.

MATCH_AND_CLOSE_AUCTION: Like PREOPEN, matches on transition out.

SUSPENDED: Cancel only. No entry, modification, or matching.

HALTED: Like SUSPENDED, no cancels allowed.

EXPIRED: All resting orders expired, no new orders.

TERMINATED: Order book removed, all orders and positions closed.

Available options:
INSTRUMENT_STATE_OPEN,
INSTRUMENT_STATE_PREOPEN,
INSTRUMENT_STATE_SUSPENDED,
INSTRUMENT_STATE_EXPIRED,
INSTRUMENT_STATE_TERMINATED,
INSTRUMENT_STATE_HALTED,
INSTRUMENT_STATE_MATCH_AND_CLOSE_AUCTION,
INSTRUMENT_STATE_PENDING
type
enum<string>

InstrumentType represents the type of instrument.

Available options:
INSTRUMENT_TYPE_DEFAULT,
INSTRUMENT_TYPE_FUTURE,
INSTRUMENT_TYPE_OPTION,
INSTRUMENT_TYPE_MULTILEG,
INSTRUMENT_TYPE_IRS,
INSTRUMENT_TYPE_FRA,
INSTRUMENT_TYPE_FSIRS,
INSTRUMENT_TYPE_BASIS,
INSTRUMENT_TYPE_EVENT,
INSTRUMENT_TYPE_OIS,
INSTRUMENT_TYPE_SPS,
INSTRUMENT_TYPE_NDF,
INSTRUMENT_TYPE_FOREX,
INSTRUMENT_TYPE_ZCIS,
INSTRUMENT_TYPE_XCCY
eventSeries
string

Filter by event series (e.g., "cbb", "nfl", "nba"). Matches instruments where metadata["event_series"] equals this value.

marketCategory
string

Filter by market category (e.g., "sports", "politics", "crypto").

marketType
string

Filter by market type (e.g., "moneyline", "spread", "over_under").

gameId
string

Filter by game ID (provider-specific game identifier).

clearingSym
string

Filter by clearing symbol prefix (e.g., "AEC-NFL", "AEC-NBA").

eventCategory
string

Filter by event category (e.g., "SPR" for sports, "POL" for politics). Matches instruments where metadata["event_category"] equals this value.

startTimeGte
string

Filter instruments with start_date >= this value (format: "2025-01-01" or timestamp). Returns instruments that start on or after this date.

startTimeLte
string

Filter instruments with start_date <= this value (format: "2025-01-01" or timestamp). Returns instruments that start on or before this date.

endTimeGte
string

Filter instruments with expiration_date >= this value (format: "2025-01-01" or timestamp). Returns instruments that expire on or after this date.

endTimeLte
string

Filter instruments with expiration_date <= this value (format: "2025-01-01" or timestamp). Returns instruments that expire on or before this date.

filter
object

Advanced filter with whereClause and/or fieldFilters (ANDed together if both provided)

Response

200 - application/json

A successful response.

Response with list of instruments.

instruments
object[]

List of matching instruments

nextPageToken
string

Token for fetching next page (empty if no more results)

eof
boolean

True when no more results available