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

# ApiResponseHip3Instrument Schema

> API response wrapping a single HIP-3 instrument. Includes generated fields, route metadata, response shapes, and implementation-safe 0xArchive contract details.

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

API response wrapping a single HIP-3 instrument

## 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": "ApiResponseHip3Instrument",
  "description": "API response wrapping a single HIP-3 instrument",
  "type": "object",
  "properties": {
    "data": {
      "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"
        }
      }
    },
    "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)
* [Hip3Instrument](/schemas/components/hip3-instrument)

## Referenced By

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


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