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. Historical OHLCV candle data for a HIP-4 outcome side, derived from hip4_fills by the candle-builder cron and stored in archive.hip4_candles_1m_v2. Coverage from 2026-05-02 (HIP-4 mainnet launch). Build tier or higher. Note on HIP-4 prices: HIP-4 prices are implied probabilities (0..1), not USD. quote_volume is denominated in USDH (the collateral). The OHLCV shape is identical to perp candles so SDKs work unchanged. Available Intervals: 1m, 5m, 15m, 30m, 1h, 4h, 1d, 1w Pagination: Use the cursor parameter with the value from the previous response’s next_cursor.

​
Route Metadata

FieldValue
MethodGET
Path/v1/hyperliquid/hip4/candles/{symbol}
operationIdgetHip4Candles
TagHIP-4 Outcomes - Candles
FamilyHIP-4
Deprecated or legacyno

​
Request Parameters

​
Path Parameters

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "getHip4Candles path parameters",
  "type": "object",
  "required": [
    "symbol"
  ],
  "properties": {
    "symbol": {
      "description": "HIP-4 coin id (numeric `0`, `1`, `10`, `11`, ...) where id = `10*outcome_id + side`. The `#`-prefixed form (`#0`, `#10`) is also accepted.",
      "type": "string",
      "example": "0",
      "x-parameter-location": "path"
    }
  }
}

​
Query Parameters

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "getHip4Candles query parameters",
  "type": "object",
  "properties": {
    "start": {
      "description": "Start timestamp in Unix milliseconds. Defaults to 24h ago.",
      "type": "integer",
      "format": "int64",
      "x-parameter-location": "query"
    },
    "end": {
      "description": "End timestamp in Unix milliseconds. Defaults to now.",
      "type": "integer",
      "format": "int64",
      "x-parameter-location": "query"
    },
    "interval": {
      "description": "Candle interval (default: 1h)",
      "type": "string",
      "enum": [
        "1m",
        "5m",
        "15m",
        "30m",
        "1h",
        "4h",
        "1d",
        "1w"
      ],
      "default": "1h",
      "x-parameter-location": "query"
    },
    "cursor": {
      "description": "Cursor for pagination (use the value from previous response's `next_cursor`)",
      "type": "string",
      "x-parameter-location": "query"
    },
    "limit": {
      "description": "Maximum number of results (default: 100, max: 1000)",
      "type": "integer",
      "default": 100,
      "maximum": 1000,
      "x-parameter-location": "query"
    }
  }
}

​
Response Contracts

​
Status 200

List of OHLCV candles with cursor for next page

​
application/json

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "getHip4Candles response 200",
  "description": "API response containing an array of candle data",
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "description": "OHLCV candle data",
        "type": "object",
        "required": [
          "close",
          "high",
          "low",
          "open",
          "timestamp",
          "volume"
        ],
        "properties": {
          "close": {
            "description": "Closing price",
            "type": "number",
            "format": "double",
            "example": 42650.75
          },
          "high": {
            "description": "Highest price during interval",
            "type": "number",
            "format": "double",
            "example": 42750
          },
          "low": {
            "description": "Lowest price during interval",
            "type": "number",
            "format": "double",
            "example": 42300.25
          },
          "open": {
            "description": "Opening price",
            "type": "number",
            "format": "double",
            "example": 42500.5
          },
          "quote_volume": {
            "description": "Trading volume in quote asset (USD)",
            "type": "number",
            "format": "double",
            "example": 53187500
          },
          "timestamp": {
            "description": "Candle start timestamp (ISO 8601 UTC)",
            "type": "string",
            "format": "date-time",
            "example": "2026-01-01T12:00:00Z"
          },
          "trade_count": {
            "description": "Number of trades in interval",
            "type": "integer",
            "example": 4520
          },
          "volume": {
            "description": "Trading volume in base asset",
            "type": "number",
            "format": "double",
            "example": 1250.5
          }
        }
      }
    },
    "meta": {
      "type": "object",
      "properties": {
        "count": {
          "description": "Number of records returned",
          "type": "integer"
        },
        "next_cursor": {
          "description": "Cursor for pagination",
          "type": "string",
          "nullable": true
        }
      }
    },
    "success": {
      "type": "boolean",
      "example": true
    }
  }
}

​
Status 400

Invalid request

​
application/json

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