> ## 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.

# Get Hyperliquid instrument JSON Schema

> Get Hyperliquid instrument JSON Schema contract. Includes route metadata, request parameters, response statuses, examples, and JSON fields for implementation.

Source OpenAPI: 0xArchive API 1.5.0; 140 paths; 119 component schemas.

Get details for a specific Hyperliquid trading instrument.

## Route Metadata

| Field                | Value                                  |
| -------------------- | -------------------------------------- |
| Method               | `GET`                                  |
| Path                 | `/v1/hyperliquid/instruments/{symbol}` |
| operationId          | `getHyperliquidInstrument`             |
| Tag                  | Hyperliquid - Instruments              |
| Family               | Hyperliquid Core                       |
| Deprecated or legacy | no                                     |

## Request Parameters

### Path Parameters

```json theme={"theme":"github-dark"}
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "getHyperliquidInstrument path parameters",
  "type": "object",
  "required": [
    "symbol"
  ],
  "properties": {
    "symbol": {
      "description": "Trading pair symbol (e.g., BTC, ETH, SOL)",
      "type": "string",
      "example": "BTC",
      "x-parameter-location": "path"
    }
  }
}
```

## Response Contracts

### Status 200

Instrument details

#### application/json

```json theme={"theme":"github-dark"}
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "getHyperliquidInstrument response 200",
  "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"
        },
        "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
        },
        "request_id": {
          "description": "Unique request ID for support",
          "type": "string",
          "format": "uuid"
        }
      }
    },
    "success": {
      "type": "boolean",
      "example": true
    }
  }
}
```

### Status 400

Invalid request

#### application/json

```json theme={"theme":"github-dark"}
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "getHyperliquidInstrument response 400",
  "description": "Error response",
  "type": "object",
  "properties": {
    "code": {
      "description": "HTTP status code",
      "type": "integer"
    },
    "error": {
      "description": "Error message",
      "type": "string"
    }
  }
}
```

##### OpenAPI example

```json theme={"theme":"github-dark"}
{
  "code": 400,
  "error": "Invalid request parameters"
}
```

### Status 401

Authentication required

#### application/json

```json theme={"theme":"github-dark"}
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "getHyperliquidInstrument response 401",
  "description": "Error response",
  "type": "object",
  "properties": {
    "code": {
      "description": "HTTP status code",
      "type": "integer"
    },
    "error": {
      "description": "Error message",
      "type": "string"
    }
  }
}
```

##### OpenAPI example

```json theme={"theme":"github-dark"}
{
  "code": 401,
  "error": "Missing or invalid API key. Provide X-API-Key header."
}
```

### Status 404

Resource not found

#### application/json

```json theme={"theme":"github-dark"}
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "getHyperliquidInstrument response 404",
  "description": "Error response",
  "type": "object",
  "properties": {
    "code": {
      "description": "HTTP status code",
      "type": "integer"
    },
    "error": {
      "description": "Error message",
      "type": "string"
    }
  }
}
```

##### OpenAPI example

```json theme={"theme":"github-dark"}
{
  "code": 404,
  "error": "Resource not found"
}
```

### Status 429

Rate limit exceeded

#### application/json

```json theme={"theme":"github-dark"}
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "getHyperliquidInstrument response 429",
  "description": "Error response",
  "type": "object",
  "properties": {
    "code": {
      "description": "HTTP status code",
      "type": "integer"
    },
    "error": {
      "description": "Error message",
      "type": "string"
    }
  }
}
```

##### OpenAPI example

```json theme={"theme":"github-dark"}
{
  "code": 429,
  "error": "Rate limit exceeded"
}
```