v1

latestOpenAPI 3.1.02026-07-241653251.3 MB

CLOB

List instruments

List all instruments available on the CLOB.

post/orders/v1/list_instruments

Headers

X-SCX-SIGNEDstring required

HMAC-SHA256 signature of the request, base64-encoded. See the Authentication guide for the exact signing formula.

X-SCX-TIMESTAMPstring required

Example:1678901234

Current Unix timestamp in seconds. Must be within 60 seconds of server time or the request is rejected.

Request body

page_sizeinteger

The number of items to return per page

page_tokenstring

The token for the next page of results

product_idstring

The ID of the product to retrieve

symbolsstring[]

The array of symbols to subscribe to for market data

Example request

{
  "page_size": 10,
  "page_token": "page-token",
  "product_id": "product-id",
  "symbols": [
    "BTC/USD"
  ]
}

Response

A successful response

next_page_tokenstring

eofboolean

Example response

{
  "instruments": [
    {
      "symbol": "BTC/USD",
      "tick_size": 0.01,
      "base_currency": "USD",
      "multiplier": 1,
      "minimum_trade_qty": "1",
      "start_date": {
        "year": 1970,
        "month": 1,
        "day": 1
      },
      "trading_schedule": [],
      "description": "Bitcoin USD Spot",
      "clearing_house": "firms/Zero-Hash-LLC",
      "minimum_unaffiliated_firms": "0",
      "forex_attributes": {
        "base_currency": "BTC",
        "quote_currency": "USD"
      },
      "product_id": "BTC",
      "price_limit": {
        "low": "0",
        "high": "0",
        "relative_low": "0.6",
        "relative_high": "0.6"
      },
      "order_size_limit": {
        "low": "0",
        "high": "0",
        "total_notional_low": "10000000000",
        "total_notional_high": "5000000000000000",
        "total_notional_low_set": true,
        "total_notional_high_set": true
      },
      "trade_settlement_period": "1",
      "holiday_calendars": [],
      "fractional_qty_scale": "100000000",
      "metadata": {},
      "state": "INSTRUMENT_STATE_OPEN",
      "position_limit": "0",
      "price_scale": "100"
    }
  ],
  "next_page_token": "643538bb35cbd2a93099ae14",
  "eof": true
}