Sign in

v2

latestOpenAPI 3.0.32026-07-315724.4 KB
Market Data

List Instruments

Returns the list of tradeable instruments, including index_id and product_group, optionally filtered by base currency, instrument kind, and expiration status.

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 standard internet-accessible 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:

  • 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.
get/api/v2/public/get_instruments

Query parameters

currencystring

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

kind'perp_future' | 'option' | 'spot' | 'future_combo' | 'option_combo' | 'dated_future'

Filter by instrument kind. Case-insensitive.

expiredboolean

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

Response

List of instruments matching the supplied filters.

jsonrpc'2.0' required

The JSON-RPC version (2.0)

idinteger

The id that was sent in the request

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,
      "strike": 70000,
      "expiration_timestamp": 1779148800000,
      "creation_timestamp": 1747500000000
    }
  ]
}
All 5 operations