Skip to main content
List Instruments

Query Parameters

currency
string

Filter by the base currency of the instrument's currency pair (e.g. BTC, ETH, AVAX). Case-insensitive.

kind
enum<string>

Filter by instrument kind. Case-insensitive.

Available options:
perp_future,
option,
spot,
future_combo,
option_combo,
dated_future
expired
boolean

When true, return only expired instruments. When false, return only currently-active (non-expired) instruments. Omit to return both.

instrument_id
integer<int64>

Return the instrument with this numeric id.

product_group
enum<string>

Filter by Starbase product group. Case-insensitive.

Available options:
BTC,
ETH,
TIER_2,
TIER_3
state
enum<string>

Filter by instrument lifecycle state. Case-insensitive. Values match SBE InstrumentStatus.

Available options:
open,
inactive,
settlement,
delivered,
locked,
halted

Response

List of instruments matching the supplied filters.

jsonrpc
enum<string>
required

The JSON-RPC version (2.0)

Available options:
2.0
result
object[]
required

Array of instruments matching the supplied filters. May be empty.

id
integer

The id that was sent in the request