# Get instruments

Query for instruments available on the exchange by specific instrument ID or symbol.  If no query parameters are supplied than ALL available instruments will be returned.

Endpoint: GET /api/v1/instruments
Version: v1.0.3

## Query parameters:

  - `id` (string)
    ID of instrument to query for.

  - `symbol` (string)
    Filters instruments by symbol. Returns instruments where the symbol is an exact match or contains the provided substring. Matching is case-sensitive.

## Response 200 fields (application/json):

  - `id` (string)
    Exchange assigned ID of the instrument.
    Example: "78901949723181070"

  - `status` (string)
    Current instrument state.
    Enum: "DISABLED", "OPENING", "ACTIVE", "HALTED"

  - `info` (object)

  - `info.symbol` (string)
    Human readable representation of the instrument.
    Example: "BTC-PYUSD"

  - `info.reference_price` (string)
    Price used for initial price limit/band calcuations.
    Example: "75000.50"

  - `info.base_asset_id` (string)
    ID of the base asset.
    Example: "78901949718265865"

  - `info.quote_asset_id` (string)
    ID of the quote asset.
    Example: "78901949717282824"

  - `info.price_limit_window_secs` (string)
    Number of seconds in the price limit's sliding window.
    Example: "3600"

  - `info.price_limit_percent` (string)
    Specifies the percentage threshold for price movement beyond a reference price (e.g., the midpoint or previous close) at which the exchange will take action. If the price of a trade or order breaches this threshold, the exchange may halt trading, trigger a circuit breaker, or initiate other predefined actions to ensure market stability.
    Example: "0.015"

  - `info.price_bands_percent` (string)
    Defines the acceptable price range for order validation within the market. The price bands ensure that orders are priced within a range around the market's midpoint, adjusted for increments and thresholds.
    Example: "0.025"

  - `stats` (object)

  - `stats.last_24hr_notional` (string)
    The notional (quantity * price) amount of REFERENCE_ASSET traded over the last 24hr period.
    Example: "4325606.30380"

  - `stats.last_24hr_quantity` (string)
    The quantity traded over the last 24 hour period.
    Example: "123754.234598480"

## Response 400 fields (application/problem+json):

  - `type` (string, required)
    A URI reference that identifies the problem type.
    Example: "about:blank"

  - `title` (string, required)
    A short, human-readable summary of the problem type.
    Example: "An Error Occured"

  - `status` (integer, required)
    The HTTP status code generated by the origin server.
    Example: 400

  - `detail` (string)
    A human-readable explanation specific to this occurrence of the problem.
    Example: "A more detailed sentence about the error"

  - `instance` (string)
    A URI reference that identifies the specific occurrence of the problem.
    Example: "/api/v1/endpoint"

  - `extensions` (object)
    A map for extension members (custom fields not defined by the RFC).

## Response 500 fields (application/problem+json):

  - `type` (string, required)
    A URI reference that identifies the problem type.
    Example: "about:blank"

  - `title` (string, required)
    A short, human-readable summary of the problem type.
    Example: "An Error Occured"

  - `status` (integer, required)
    The HTTP status code generated by the origin server.
    Example: 400

  - `detail` (string)
    A human-readable explanation specific to this occurrence of the problem.
    Example: "A more detailed sentence about the error"

  - `instance` (string)
    A URI reference that identifies the specific occurrence of the problem.
    Example: "/api/v1/endpoint"

  - `extensions` (object)
    A map for extension members (custom fields not defined by the RFC).

## Response 503 fields (application/problem+json):

  - `type` (string, required)
    A URI reference that identifies the problem type.
    Example: "about:blank"

  - `title` (string, required)
    A short, human-readable summary of the problem type.
    Example: "An Error Occured"

  - `status` (integer, required)
    The HTTP status code generated by the origin server.
    Example: 400

  - `detail` (string)
    A human-readable explanation specific to this occurrence of the problem.
    Example: "A more detailed sentence about the error"

  - `instance` (string)
    A URI reference that identifies the specific occurrence of the problem.
    Example: "/api/v1/endpoint"

  - `extensions` (object)
    A map for extension members (custom fields not defined by the RFC).