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

# Hip3Instrument Schema

> HIP-3 Builder Perps instrument with latest market data. Includes parameters, response shapes, examples, and implementation notes from the 0xArchive contract.

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

HIP-3 Builder Perps instrument with latest market data. Derived from live open interest data.

## Required Fields

| Field       | Type   | Description                                                                  |
| ----------- | ------ | ---------------------------------------------------------------------------- |
| `coin`      | string | Full coin name (e.g., km:US500, xyz:XYZ100) (deprecated, use symbol instead) |
| `namespace` | string | Builder namespace (e.g., km, xyz)                                            |
| `symbol`    | string | Trading pair symbol                                                          |
| `ticker`    | string | Ticker within the namespace (e.g., US500, XYZ100)                            |

## JSON Schema

```json theme={"theme":"github-dark"}
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "Hip3Instrument",
  "description": "HIP-3 Builder Perps instrument with latest market data. Derived from live open interest data.",
  "type": "object",
  "required": [
    "coin",
    "namespace",
    "symbol",
    "ticker"
  ],
  "properties": {
    "coin": {
      "description": "Full coin name (e.g., km:US500, xyz:XYZ100) (deprecated, use symbol instead)",
      "type": "string",
      "deprecated": true,
      "example": "km:US500"
    },
    "latest_timestamp": {
      "description": "Timestamp of latest data point",
      "type": "string",
      "format": "date-time",
      "nullable": true,
      "example": "2026-02-18T12:00:00.000Z"
    },
    "mark_price": {
      "description": "Latest mark price",
      "type": "number",
      "nullable": true,
      "example": 5432.1
    },
    "mid_price": {
      "description": "Latest mid price",
      "type": "number",
      "nullable": true,
      "example": 5432.05
    },
    "namespace": {
      "description": "Builder namespace (e.g., km, xyz)",
      "type": "string",
      "example": "km"
    },
    "open_interest": {
      "description": "Latest open interest",
      "type": "number",
      "nullable": true,
      "example": 1234567.89
    },
    "symbol": {
      "description": "Trading pair symbol",
      "type": "string",
      "example": "km:US500"
    },
    "ticker": {
      "description": "Ticker within the namespace (e.g., US500, XYZ100)",
      "type": "string",
      "example": "US500"
    }
  }
}
```

## Referenced By

Use this shared schema with the generated component index and route-specific endpoint pages during implementation.