Route Metadata
| Field | Value |
|---|---|
| Method | GET |
| Path | /v1/hyperliquid/hip3/instruments |
| operationId | listHip3Instruments |
| Tag | HIP-3 Builder Perps - Instruments |
| Family | HIP-3 |
| Deprecated or legacy | no |
Human endpoint reference
OpenGET /v1/hyperliquid/hip3/instruments for authentication, parameters, responses, and examples.
Response Contracts
Status 200
List of HIP-3 instrumentsapplication/json
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "listHip3Instruments response 200",
"description": "API response wrapping an array of HIP-3 instruments",
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"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
}
}
}
Status 401
Authentication requiredapplication/json
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "listHip3Instruments response 401",
"description": "Error response",
"type": "object",
"properties": {
"code": {
"description": "HTTP status code",
"type": "integer"
},
"error": {
"description": "Error message",
"type": "string"
},
"error_code": {
"description": "Machine-readable error code. Common values: `invalid_query_params` (a query parameter failed to parse or validate) and `invalid_path_params` (a path parameter failed to parse). Other endpoint-specific codes exist; treat unknown codes as generic errors of the given HTTP status.",
"type": "string"
},
"param": {
"description": "The parameter at fault, when the error is about one parameter.",
"type": "string"
},
"request_id": {
"description": "Unique request ID for support",
"type": "string",
"format": "uuid"
},
"success": {
"description": "Always false on an error.",
"type": "boolean",
"example": false
}
}
}
OpenAPI example
{
"code": 401,
"error": "Missing authentication credentials. Provide X-API-Key header or Bearer token.",
"error_code": "unauthorized",
"request_id": "71ed4b6f-63ef-4ae1-a123-07ffa47c1c14",
"success": false
}
Status 429
Rate limit exceededapplication/json
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "listHip3Instruments response 429",
"description": "Error response",
"type": "object",
"properties": {
"code": {
"description": "HTTP status code",
"type": "integer"
},
"error": {
"description": "Error message",
"type": "string"
},
"error_code": {
"description": "Machine-readable error code. Common values: `invalid_query_params` (a query parameter failed to parse or validate) and `invalid_path_params` (a path parameter failed to parse). Other endpoint-specific codes exist; treat unknown codes as generic errors of the given HTTP status.",
"type": "string"
},
"param": {
"description": "The parameter at fault, when the error is about one parameter.",
"type": "string"
},
"request_id": {
"description": "Unique request ID for support",
"type": "string",
"format": "uuid"
},
"success": {
"description": "Always false on an error.",
"type": "boolean",
"example": false
}
}
}
OpenAPI example
{
"code": 429,
"error": "Rate limit exceeded"
}