Get HIP-3 instrument

{ "success": true, "data": { "symbol": "km:US500", "coin": "km:US500", "namespace": "km", "ticker": "US500", "mark_price": 5432.1, "open_interest": 1234567.89, "mid_price": 5432.05, "latest_timestamp": "2026-02-18T12:00:00.000Z" }, "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

HIP-3 symbol name (e.g., km:US500, xyz:XYZ100). Case-sensitive.

Response

HIP-3 instrument details

API response wrapping a single HIP-3 instrument

success

boolean

Example:

true

data

object

HIP-3 Builder Perps instrument with latest market data. Derived from live open interest data.

Hide child attributes

data.symbol

string

required

Trading pair symbol

Example:

"km:US500"

data.coin

string

required

deprecated

Full coin name (e.g., km:US500, xyz:XYZ100) (deprecated, use symbol instead)

Example:

"km:US500"

data.namespace

string

required

Builder namespace (e.g., km, xyz)

Example:

"km"

data.ticker

string

required

Ticker within the namespace (e.g., US500, XYZ100)

Example:

"US500"

data.mark_price

number | null

Latest mark price

Example:

5432.1

data.open_interest

number | null

Latest open interest

Example:

1234567.89

data.mid_price

number | null

Latest mid price

Example:

5432.05

data.latest_timestamp

string<date-time> | null

Timestamp of latest data point

Example:

"2026-02-18T12:00:00.000Z"