> ## Documentation Index
> Fetch the complete documentation index at: https://docs.0xarchive.io/llms.txt
> Use this file to discover all available pages before exploring further.

# ApiResponseInstrument Schema

> ApiResponseInstrument JSON Schema for 0xArchive OpenAPI responses and field contracts. Includes route metadata, schemas, examples, and implementation notes.

Source OpenAPI: 0xArchive API 1.8.0; 227 paths; 217 component schemas.

Use the JSON Schema block below for field-level types, required fields, nested objects, and enum values.

## Required Fields

No required fields are declared on this component schema.

## JSON Schema

```json theme={"theme":"github-dark"}
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "ApiResponseInstrument",
  "type": "object",
  "properties": {
    "data": {
      "description": "Trading instrument specification (Hyperliquid)",
      "type": "object",
      "required": [
        "is_active",
        "name",
        "sz_decimals"
      ],
      "properties": {
        "instrument_type": {
          "description": "Type of instrument",
          "type": "string",
          "enum": [
            "perp",
            "spot"
          ],
          "nullable": true,
          "example": "perp"
        },
        "is_active": {
          "description": "Whether the instrument is currently tradeable",
          "type": "boolean",
          "example": true
        },
        "max_leverage": {
          "description": "Maximum leverage allowed",
          "type": "integer",
          "nullable": true,
          "example": 50
        },
        "name": {
          "description": "Instrument symbol",
          "type": "string",
          "example": "BTC"
        },
        "only_isolated": {
          "description": "If true, only isolated margin mode is allowed",
          "type": "boolean",
          "nullable": true
        },
        "sz_decimals": {
          "description": "Size decimal precision",
          "type": "integer",
          "example": 4
        }
      }
    },
    "meta": {
      "description": "Response metadata",
      "type": "object",
      "properties": {
        "count": {
          "description": "Number of records returned",
          "type": "integer"
        },
        "coverage_from": {
          "description": "Earliest coverage for the requested symbol and data type. Present only when the requested window ends before coverage begins.",
          "type": "string",
          "format": "date-time"
        },
        "has_more": {
          "description": "Present on cursor-paged routes: true when another page exists. `next_cursor` is present exactly when it is true.",
          "type": "boolean"
        },
        "next_cursor": {
          "description": "Cursor for pagination (timestamp). Use this value as the `cursor` parameter to fetch the next page of results.",
          "type": "string",
          "nullable": true
        },
        "notice": {
          "description": "Human-readable advisory about the response. Used when the requested window ends before coverage begins for the symbol, and on CVD responses that are one page of several; may carry other advisories in future.",
          "type": "string"
        },
        "request_id": {
          "description": "Unique request ID for support",
          "type": "string",
          "format": "uuid"
        },
        "symbol": {
          "description": "Present on per-symbol routes: the symbol the response covers.",
          "type": "string"
        },
        "venue": {
          "description": "Present on per-symbol routes: the venue the response covers, for example `hyperliquid` or `hip3`.",
          "type": "string"
        }
      }
    },
    "success": {
      "type": "boolean",
      "example": true
    }
  }
}
```

## Referenced components

* [ApiMeta](/schemas/components/api-meta)
* [Instrument](/schemas/components/instrument)

## Referenced By

* [`GET /v1/hyperliquid/instruments/{symbol}`](/schemas/operations/get-hyperliquid-instrument)
* [`GET /v1/instruments/{symbol}`](/schemas/operations/get-instrument)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.