Get HIP-4 open interest history JSON Schema

Source OpenAPI: 0xArchive API 1.8.0; 227 paths; 217 component schemas. Get historical per-side open interest data for a HIP-4 outcome side. Mirrors HIP-3 OI shape plus outcome_id and side fields. Display/paired/parity aggregates (sum across both sides, paired-set supply, side-supply parity check) live on /outcomes/{outcome_id}.aggregated_oi, NOT on this endpoint. 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. Data available from May 2026.

Route Metadata

Field	Value
Method	`GET`
Path	`/v1/hyperliquid/hip4/openinterest/{symbol}`
operationId	`getHip4OpenInterest`
Tag	HIP-4 Outcomes - Open Interest
Family	HIP-4
Deprecated or legacy	no

Human endpoint reference

Open GET /v1/hyperliquid/hip4/openinterest/{symbol} for authentication, parameters, responses, and examples.

Request Parameters

Path Parameters

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

Query Parameters

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "getHip4OpenInterest 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"
    },
    "cursor": {
      "description": "Cursor for pagination",
      "type": "integer",
      "format": "int64",
      "x-parameter-location": "query"
    },
    "limit": {
      "description": "Maximum number of results (default: 100, max: 1000)",
      "type": "integer",
      "default": 100,
      "maximum": 1000,
      "x-parameter-location": "query"
    },
    "interval": {
      "description": "Aggregation interval. When omitted, returns raw ~10 sec outcome-side open-interest updates.",
      "type": "string",
      "enum": [
        "1m",
        "5m",
        "15m",
        "30m",
        "1h",
        "4h",
        "1d"
      ],
      "x-parameter-location": "query"
    }
  }
}

Response Contracts

Status 200

Open interest data

application/json

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "getHip4OpenInterest response 200",
  "description": "API response wrapping an array of HIP-4 per-side open-interest records",
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "description": "HIP-4 per-side open-interest record. Mirrors the HIP-3 OI shape and adds `outcome_id` and `side`. `oracle_price` is omitted for HIP-4 (outcomes have no oracle feed). Note: `mark_price` is an implied probability in [0,1], not a USD price; same field name as perps because Hyperliquid upstream uses `markPx` for both.",
        "type": "object",
        "required": [
          "coin",
          "open_interest",
          "outcome_id",
          "side",
          "symbol",
          "timestamp"
        ],
        "properties": {
          "coin": {
            "description": "`#`-prefixed per-side coin identifier",
            "type": "string",
            "example": "#0"
          },
          "mark_price": {
            "description": "Implied probability in [0,1], NOT a USD price. Same field name as perps because Hyperliquid upstream uses `markPx` for both.",
            "type": "string",
            "nullable": true,
            "example": "0.6502"
          },
          "mid_price": {
            "description": "Mid price (probability in [0,1])",
            "type": "string",
            "nullable": true,
            "example": "0.65038"
          },
          "open_interest": {
            "description": "Open interest in contracts (notional currency: USDH)",
            "type": "string",
            "example": "568048"
          },
          "outcome_id": {
            "description": "Numeric outcome identifier",
            "type": "integer",
            "format": "int64",
            "example": 0
          },
          "side": {
            "description": "Side index: 0 = Yes, 1 = No",
            "type": "integer",
            "enum": [
              0,
              1
            ],
            "example": 0
          },
          "symbol": {
            "description": "Same value as `coin`. Provided for consistency with other venues.",
            "type": "string",
            "example": "#0"
          },
          "timestamp": {
            "description": "Snapshot timestamp (UTC)",
            "type": "string",
            "format": "date-time",
            "example": "2026-05-02T20:27:21Z"
          }
        }
      }
    },
    "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 400

Invalid request

application/json

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

OpenAPI example

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

Status 401

Authentication required

application/json

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

application/json

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

Endpoint reference

Requests and responses

Datasets

Venues

OpenAPI and schemas

Guides

Get HIP-4 open interest history JSON Schema

Route Metadata

Human endpoint reference

Request Parameters

Path Parameters

Query Parameters

Response Contracts

Status 200

application/json

Status 400

application/json

OpenAPI example

Status 401

application/json

OpenAPI example

Status 429

application/json

OpenAPI example

​Route Metadata

​Human endpoint reference

​Request Parameters

​Path Parameters

​Query Parameters

​Response Contracts

​Status 200

​application/json

​Status 400

​application/json

OpenAPI example

​Status 401

​application/json

OpenAPI example

​Status 429

​application/json

OpenAPI example

Route Metadata

Human endpoint reference

Request Parameters

Path Parameters

Query Parameters

Response Contracts

Status 200

application/json

Status 400

application/json

Status 401

application/json

Status 429

application/json