HIP-3 Builder Perps - Open Interest

Get HIP-3 open interest history

Get historical open interest data for a HIP-3 Builder Perps coin. Coverage is symbol-specific; inspect /v1/symbols coverage_by_type.oi before choosing a time range.

get/v1/hyperliquid/hip3/openinterest/{symbol}

Request

  • Base URL: https://api.0xarchive.io
  • URL: https://api.0xarchive.io/v1/hyperliquid/hip3/openinterest/{symbol}
  • Auth: API key in header X-API-Key

Path parameters

symbolstring required
Example:xyz:XYZ100

Trading pair symbol (e.g., km:US500, xyz:XYZ100). HIP-3 symbols are case-sensitive.

Query parameters

integer

Unix milliseconds.

OR
string date-time

RFC 3339 instant.

Example:1767225600000

Start timestamp. Defaults to 24h ago. Accepts Unix milliseconds or an RFC 3339 UTC string such as 2026-01-01T00:00:00Z.

integer

Unix milliseconds.

OR
string date-time

RFC 3339 instant.

Example:1767225600000

End timestamp. Defaults to now. Accepts Unix milliseconds or an RFC 3339 UTC string such as 2026-01-01T00:00:00Z.

cursorstring

Opaque pagination cursor: pass meta.next_cursor from the previous page unchanged, with the same filters. Omit it for the first page.

limitinteger

Maximum number of results (default: 100, max: 1000)

interval'1m' | '5m' | '15m' | '30m' | '1h' | '4h' | '1d'

Aggregation interval. When omitted, returns raw ~10 sec updates.

Response

Open interest data

successboolean

Example response

{
  "success": true,
  "data": [
    {
      "symbol": "BTC",
      "coin": "BTC",
      "timestamp": "2025-01-21T10:30:00.000Z",
      "open_interest": "500000.00",
      "mark_price": "42500.50",
      "oracle_price": "42498.25",
      "day_ntl_volume": "10000000.00",
      "prev_day_price": "42000.00",
      "mid_price": "42500.75"
    }
  ],
  "meta": {
    "symbol": "BTC",
    "venue": "hyperliquid"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.