Skip to main content

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.

Source OpenAPI: 0xArchive API 1.5.0; 116 paths; 90 component schemas. Get a combined market summary for a HIP-4 outcome side: latest mark price (implied probability in [0,1] for HIP-4, NOT USD), mid price, open interest, and 24h aggregates. Note: mark_price for HIP-4 outcomes is an implied probability in [0,1], not a USD price; same field name as perps because Hyperliquid upstream uses markPx for both. Requires Build tier or higher.

​
Route Metadata

FieldValue
MethodGET
Path/v1/hyperliquid/hip4/summary/{symbol}
operationIdgetHip4Summary
TagHIP-4 Outcomes - Convenience
FamilyHIP-4
Deprecated or legacyno

​
Request Parameters

​
Path Parameters

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "getHip4Summary path parameters",
  "type": "object",
  "required": [
    "symbol"
  ],
  "properties": {
    "symbol": {
      "description": "HIP-4 coin id (e.g., `0` for outcome 0 Yes side, `1` for No side). The `#`-prefixed form (`#0`, `#1`) is also accepted.",
      "type": "string",
      "example": "0",
      "x-parameter-location": "path"
    }
  }
}

​
Response Contracts

​
Status 200

Market summary for the coin

​
application/json

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "getHip4Summary response 200",
  "description": "API response wrapping a market summary",
  "type": "object",
  "properties": {
    "data": {
      "description": "Combined market summary including price, funding, OI, volume, and liquidation data",
      "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"
        },
        "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
        },
        "request_id": {
          "description": "Unique request ID for support",
          "type": "string",
          "format": "uuid"
        }
      }
    },
    "success": {
      "type": "boolean",
      "example": true
    }
  }
}

​
Status 400

Invalid request

​
application/json

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "getHip4Summary response 400",
  "description": "Error response",
  "type": "object",
  "properties": {
    "code": {
      "description": "HTTP status code",
      "type": "integer"
    },
    "error": {
      "description": "Error message",
      "type": "string"
    }
  }
}
OpenAPI example
{
  "code": 400,
  "error": "Invalid request parameters"
}

​
Status 401

Authentication required

​
application/json

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "getHip4Summary response 401",
  "description": "Error response",
  "type": "object",
  "properties": {
    "code": {
      "description": "HTTP status code",
      "type": "integer"
    },
    "error": {
      "description": "Error message",
      "type": "string"
    }
  }
}
OpenAPI example
{
  "code": 401,
  "error": "Missing or invalid API key. Provide X-API-Key header."
}

​
Status 429

Rate limit exceeded

​
application/json

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "getHip4Summary response 429",
  "description": "Error response",
  "type": "object",
  "properties": {
    "code": {
      "description": "HTTP status code",
      "type": "integer"
    },
    "error": {
      "description": "Error message",
      "type": "string"
    }
  }
}
OpenAPI example
{
  "code": 429,
  "error": "Rate limit exceeded"
}
Last modified on May 18, 2026