> ## 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.

# Hip4AggregatedOi Schema

> Derived OI display fields combining both sides of a HIP-4 outcome. Includes route metadata, schemas, examples, and implementation notes.

Source OpenAPI: 0xArchive API 1.5.0; 140 paths; 119 component schemas.

Derived OI display fields combining both sides of a HIP-4 outcome. Currency is always `USDH` (Hyperliquid's stablecoin). Only populated on `/outcomes/{outcome_id}` (detail), NOT on `/outcomes` (list).

## Required Fields

| Field      | Type   | Description        |
| ---------- | ------ | ------------------ |
| `currency` | string | Notional currency. |

## JSON Schema

```json theme={"theme":"github-dark"}
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "Hip4AggregatedOi",
  "description": "Derived OI display fields combining both sides of a HIP-4 outcome. Currency is always `USDH` (Hyperliquid's stablecoin). Only populated on `/outcomes/{outcome_id}` (detail), NOT on `/outcomes` (list).",
  "type": "object",
  "required": [
    "currency"
  ],
  "properties": {
    "as_of": {
      "description": "Latest timestamp across both sides",
      "type": "string",
      "format": "date-time",
      "nullable": true,
      "example": "2026-05-02T20:27:21Z"
    },
    "currency": {
      "description": "Notional currency. Always `USDH` for HIP-4.",
      "type": "string",
      "enum": [
        "USDH"
      ],
      "example": "USDH"
    },
    "outcome_display_open_interest_contracts": {
      "description": "Display total: sum of side0 + side1 OI contracts. Use this for outcome-level OI dashboards.",
      "type": "number",
      "nullable": true,
      "example": 1136096
    },
    "paired_set_supply_contracts": {
      "description": "Paired-set supply: minimum of side0 and side1 OI contracts. Represents the count of fully collateralized Yes+No pairs in circulation.",
      "type": "number",
      "nullable": true,
      "example": 568048
    },
    "side0_as_of": {
      "description": "Timestamp of the side 0 OI sample",
      "type": "string",
      "format": "date-time",
      "nullable": true,
      "example": "2026-05-02T20:27:21Z"
    },
    "side0_open_interest_contracts": {
      "description": "Latest open-interest contracts for side 0 (Yes)",
      "type": "number",
      "nullable": true,
      "example": 568048
    },
    "side1_as_of": {
      "description": "Timestamp of the side 1 OI sample",
      "type": "string",
      "format": "date-time",
      "nullable": true,
      "example": "2026-05-02T20:27:21Z"
    },
    "side1_open_interest_contracts": {
      "description": "Latest open-interest contracts for side 1 (No)",
      "type": "number",
      "nullable": true,
      "example": 568048
    },
    "side_supply_parity": {
      "description": "True when side0 OI equals side1 OI within tolerance. Parity should hold for binary outcomes; a sustained false value indicates ingestion drift.",
      "type": "boolean",
      "nullable": true,
      "example": true
    }
  }
}
```

## Referenced By

Use this shared schema with the generated component index and route-specific endpoint pages during implementation.