Get HIP-3 open interest history

{ "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", "impact_bid_price": "<string>", "impact_ask_price": "<string>" } ], "meta": { "count": 123, "next_cursor": "<string>", "request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a" } }

Authorizations

X-API-Key

string

header

required

API key for authentication. Get yours at https://0xarchive.io/dashboard

Path Parameters

symbol

string

required

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

Example:

"xyz:XYZ100"

Query Parameters

start

integer<int64>

Start timestamp in Unix milliseconds. Defaults to 24h ago.

end

integer<int64>

End timestamp in Unix milliseconds. Defaults to now.

cursor

integer<int64>

Cursor for pagination

limit

integer

default:100

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

Required range: x <= 1000

interval

enum<string>

Aggregation interval. When omitted, returns raw ~1 min resolution data.

Available options:

5m,

15m,

30m,

1h,

4h,

1d

Response

Open interest data

success

boolean

Example:

true

data

object[]

Hide child attributes

data.symbol

string

required

Trading pair symbol

Example:

"BTC"

data.coin

string

required

deprecated

Trading pair symbol (deprecated, use symbol instead)

Example:

"BTC"

data.timestamp

string<date-time>

required

Snapshot timestamp (UTC)

Example:

"2025-01-21T10:30:00.000Z"

data.open_interest

string

required

Total open interest in contracts

Example:

"500000.00"

data.mark_price

string | null

Mark price used for liquidations

Example:

"42500.50"

data.oracle_price

string | null

Oracle price from external feed

Example:

"42498.25"

data.day_ntl_volume

string | null

24-hour notional volume

Example:

"10000000.00"

data.prev_day_price

string | null

Price 24 hours ago

Example:

"42000.00"

data.mid_price

string | null

Current mid price

Example:

"42500.75"

data.impact_bid_price

string | null

Impact bid price for liquidations

data.impact_ask_price

string | null

Impact ask price for liquidations