---
title: "List instruments"
method: POST
path: "/orders/v1/list_instruments"
tags: ["CLOB"]
---

# List instruments

`POST /orders/v1/list_instruments`

List all instruments available on the CLOB.

## Headers

- `X-SCX-SIGNED` string, required
- `X-SCX-TIMESTAMP` string, required

## Request body

- PostListInstrumentsRequest
  - `page_size` integer — The number of items to return per page
  - `page_token` string — The token for the next page of results
  - `product_id` string — The ID of the product to retrieve
  - `symbols` string[] — The array of symbols to subscribe to for market data

## Response `200`

A successful response

- PostListInstrumentsResponse
  - `instruments` object[]
    - `symbol` string — The trading pair symbol
    - `tick_size` number — The tick size for the trading pair
    - `base_currency` string — The base currency for the trading pair
    - `multiplier` number — The multiplier for the trading pair
    - `minimum_trade_qty` string — The minimum trade quantity for the trading pair
    - `start_date` object
      - `year` integer
      - `month` integer
      - `day` integer
    - `expiration_date` number — The expiration date of the instrument.
    - `termination_date` number — The termination date of the instrument.
    - `trading_schedule` unknown[] — The trading schedule for the instrument.
      - unknown
    - `description` string — A description of the instrument.
    - `clearing_house` string — The clearing house for the instrument.
    - `minimum_unaffiliated_firms` string — The minimum number of unaffiliated firms for the instrument.
    - `forex_attributes` object
      - `base_currency` string — The base currency for the trading pair
      - `quote_currency` string — The quote currency for the trading pair
    - `non_tradable` boolean — Indicates if the instrument is non-tradable.
    - `product_id` string — The product ID for the instrument.
    - `price_limit` object
      - `low` string — low price limit for the instrument
      - `high` string — high price limit for the instrument
      - `low_set` boolean — Indicates if the low price limit is set
      - `high_set` boolean — Indicates if the high price limit is set
      - `relative_low` string — relative low price limit for the instrument. The value is a percentage represented as a decimal (e.g. -0.1 for a 10% decrease) and is applied to the reference price to calculate if the entered order is outside of the price protection bands. The reference price is determined by the exchange and may be based on the settlement price during the given trading session, which is set daily at 14:00 EST.
      - `relative_high` string — relative high price limit for the instrument. The value is a percentage represented as a decimal (e.g. 0.1 for a 10% increase) and is applied to the reference price to calculate if the entered order is outside of the price protection bands. The reference price is determined by the exchange and may be based on the settlement price during the given trading session, which is set daily at 14:00 EST.
      - `relative_low_set` boolean — Indicates if the relative low price limit is active.
      - `relative_high_set` boolean — Indicates if the relative high price limit is active.
    - `order_size_limit` object
      - `low` string — low order size limit for the instrument. The quantity is scaled by the instrument's `fractional_qty_scale`
      - `high` string — high order size limit for the instrument. The quantity is scaled by the instrument's `fractional_qty_scale`
      - `low_set` boolean — Indicates if the low order size limit is set
      - `high_set` boolean — Indicates if the high order size limit is set
      - `total_notional_low` string — total notional low limit for the instrument.
      - `total_notional_high` string — total notional high limit for the instrument.
      - `total_notional_low_set` boolean — Indicates if the total notional low limit is set.
      - `total_notional_high_set` boolean — Indicates if the total notional high limit is set.
    - `cross_order_resting_duration` number
    - `expiration_time` number — The expiration time of the instrument in milliseconds since the Unix epoch. If null, the instrument does not expire.
    - `trade_settlement_period` string
    - `holiday_calendars` unknown[]
      - unknown
    - `fractional_qty_scale` string — Fractional quantity scale for the instrument used to interpret order quantities on order submission.
    - `metadata` object — A key-value map of additional information about the instrument.
    - `state` 'INSTRUMENT_STATE_CLOSED' | 'INSTRUMENT_STATE_OPEN' | 'INSTRUMENT_STATE_PREOPEN' | 'INSTRUMENT_STATE_SUSPENDED' | 'INSTRUMENT_STATE_EXPIRED' | 'INSTRUMENT_STATE_TERMINATED' | 'INSTRUMENT_STATE_HALTED' | 'INSTRUMENT_STATE_MATCH_AND_CLOSE_AUCTION' — The current state of the instrument.
    - `position_limit` string
    - `last_trade_date` number — The last trade date of the instrument. If null, the instrument does not have a last trade date.
    - `last_trade_time` number — The last trade time of the instrument. If null, the instrument does not have a last trade time.
    - `price_scale` string — Price scale for the instrument used to interpret order prices on order submission.
  - `next_page_token` string
  - `eof` boolean

## Other responses

- `default` — An error occurred

---

[API](https://skmtc.net/zerohash/apis/zerohash-api.md) · [All operations](https://skmtc.net/zerohash/apis/zerohash-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/zerohash/zerohash-api/revisions/8b647d934363/schema)