Get HIP-3 market summary JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "getHip3Summary path parameters",
  "type": "object",
  "required": [
    "symbol"
  ],
  "properties": {
    "symbol": {
      "description": "HIP-3 symbol (case-sensitive, e.g., km:US500)",
      "type": "string",
      "example": "km:US500",
      "x-parameter-location": "path"
    }
  }
}

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "getHip3Summary response 200",
  "description": "API response wrapping a market summary",
  "type": "object",
  "properties": {
    "data": {
      "description": "Shared market-summary shape. Route families omit unsupported optional fields; consult the operation description for family-specific applicability.",
      "type": "object",
      "required": [
        "coin",
        "symbol",
        "timestamp"
      ],
      "properties": {
        "coin": {
          "description": "Trading pair symbol (deprecated, use symbol instead)",
          "type": "string",
          "deprecated": true,
          "example": "BTC"
        },
        "funding_rate": {
          "description": "Current funding rate",
          "type": "string",
          "nullable": true,
          "example": "0.00025"
        },
        "liquidation_volume_24h": {
          "description": "Total 24h liquidation volume in USD",
          "type": "number",
          "nullable": true,
          "example": 2500000
        },
        "long_liquidation_volume_24h": {
          "description": "Long 24h liquidation volume in USD",
          "type": "number",
          "nullable": true,
          "example": 1500000
        },
        "mark_price": {
          "description": "Current mark price",
          "type": "string",
          "nullable": true,
          "example": "95000.50"
        },
        "mid_price": {
          "description": "Current mid price",
          "type": "string",
          "nullable": true,
          "example": "95000.00"
        },
        "open_interest": {
          "description": "Current open interest",
          "type": "string",
          "nullable": true,
          "example": "500000.00"
        },
        "oracle_price": {
          "description": "Current oracle price",
          "type": "string",
          "nullable": true,
          "example": "94998.25"
        },
        "premium": {
          "description": "Current premium",
          "type": "string",
          "nullable": true,
          "example": "0.0005"
        },
        "short_liquidation_volume_24h": {
          "description": "Short 24h liquidation volume in USD",
          "type": "number",
          "nullable": true,
          "example": 1000000
        },
        "symbol": {
          "description": "Trading pair symbol",
          "type": "string",
          "example": "BTC"
        },
        "timestamp": {
          "description": "Summary timestamp (UTC)",
          "type": "string",
          "format": "date-time",
          "example": "2026-02-23T12:00:00.000Z"
        },
        "volume_24h": {
          "description": "24-hour notional volume",
          "type": "string",
          "nullable": true,
          "example": "10000000.00"
        }
      }
    },
    "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
    }
  }
}

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "getHip3Summary response 400",
  "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
    }
  }
}

{
  "code": 400,
  "error": "Failed to deserialize query string: limit: invalid digit found in string",
  "error_code": "invalid_query_params",
  "param": "limit",
  "request_id": "3f2a9c71-5b0e-4d68-9a4c-7e1d2b6f8a05",
  "success": false
}

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "getHip3Summary 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
    }
  }
}

{
  "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
}

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "getHip3Summary 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
    }
  }
}

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