v1

latestOpenAPI 3.0.12026-07-2683220192.3 KB

ReferenceData

List instruments

Returns a list of instruments matching the request

post/v1/refdata/instruments

Request body

pageSizeinteger

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

pageTokenstring

Pagination cursor from previous response

symbolsstring[]

Filter by specific instrument symbols

productIdstring

Filter by product ID

tradableFilter'TRADABLE_FILTER_TRADABLE' | 'TRADABLE_FILTER_NON_TRADABLE' | 'TRADABLE_FILTER_ALL'

TradableFilter for filtering instruments by tradability. TRADABLE returns instruments where nonTradable=false. NON_TRADABLE returns instruments where nonTradable=true. ALL returns all instruments regardless of tradability.

statesInstrumentState[]

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

eventSeriesstring

Filter by event series (e.g., 'nfl', 'nba', 'cbb')

eventCategorystring

Filter by event category (e.g., 'SPR', 'POL', 'CRY')

clearingSymstring

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

startTimeGtestring

Filter instruments starting on or after this date (format: 'YYYY-MM-DD')

startTimeLtestring

Filter instruments starting on or before this date

endTimeGtestring

Filter instruments expiring on or after this date

endTimeLtestring

Filter instruments expiring on or before this date

Response

A successful response.

nextPageTokenstring

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

eofboolean

True when no more results available