List Instruments
Changed onReturns the list of tradeable instruments, including index_id and product_group, optionally filtered by base currency, instrument kind, expiration status, instrument id, product group, and lifecycle state.
This endpoint requires no authentication, but it is served by the Starbase REST gateway and is reachable only through hosted colocation, a cross-connect, or AWS Private Link. The internet-accessible classic JSON-RPC public/get_instruments method also documents index_id and product_group; backend rollout of those fields may temporarily differ between the two endpoints.
Filter semantics (supplied filters are combined):
- currency filters by the base currency of the instrument's currency pair (case-insensitive match).
- kind filters by instrument type (case-insensitive match against the kind value enum).
- expired = true returns only instruments whose expiration_timestamp is in the past; expired = false returns only non-expired instruments. Omit the parameter to get both.
- instrument_id returns the instrument with that numeric id.
- product_group filters by Starbase product group (case-insensitive match against BTC, ETH, TIER_2, TIER_3).
- state filters by instrument lifecycle state (case-insensitive). Values match SBE InstrumentStatus: open, inactive, settlement, delivered, locked, halted.
Request
- Base URLhttp://195.138.37.5:4410
- URLhttp://195.138.37.5:4410/api/v2/public/get_instruments
- Authnone required
Query parameters
Filter by the base currency of the instrument's currency pair (e.g. BTC, ETH, AVAX). Case-insensitive.
Filter by instrument kind. Case-insensitive.
When true, return only expired instruments. When false, return only currently-active (non-expired) instruments. Omit to return both.
Return the instrument with this numeric id.
Filter by Starbase product group. Case-insensitive.
Filter by instrument lifecycle state. Case-insensitive. Values match SBE InstrumentStatus.
Response
List of instruments matching the supplied filters.
Example response
{
"result": [
{
"instrument_id": 124942,
"instrument_name": "ETH-PERPETUAL",
"product_group": "ETH",
"base_currency": "ETH",
"quote_currency": "USDC",
"settlement_currency": "USDC",
"tick_size": 0.01,
"qty_tick_size": 0.1,
"strike": 70000,
"expiration_timestamp": 1779148800000,
"creation_timestamp": 1747500000000
}
]
}Changes
- info
added the new optional
queryrequest parameterinstrument_id - info
added the new optional
queryrequest parameterproduct_group - info
added the new optional
queryrequest parameterstate
- info
- info
added the optional property
//to the response with the status
- info