List HIP-3 instruments JSON Schema

{
  "$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"
        },
        "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. Currently used when the requested window ends before coverage begins for the symbol; may carry other advisories in future.",
          "type": "string"
        },
        "request_id": {
          "description": "Unique request ID for support",
          "type": "string",
          "format": "uuid"
        }
      }
    },
    "success": {
      "type": "boolean",
      "example": true
    }
  }
}

{
  "$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"
    },
    "request_id": {
      "description": "Unique request ID for support",
      "type": "string",
      "format": "uuid"
    }
  }
}

{
  "code": 401,
  "error": "Missing or invalid API key. Provide X-API-Key header."
}

{
  "$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"
    },
    "request_id": {
      "description": "Unique request ID for support",
      "type": "string",
      "format": "uuid"
    }
  }
}

{
  "code": 429,
  "error": "Rate limit exceeded"
}