List HIP-4 instruments

curl --request GET \
  --url https://api.0xarchive.io/v1/hyperliquid/hip4/instruments \
  --header 'X-API-Key: <api-key>'

const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://api.0xarchive.io/v1/hyperliquid/hip4/instruments', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.0xarchive.io/v1/hyperliquid/hip4/instruments"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

{
  "success": true,
  "data": [
    {
      "outcome_id": 0,
      "side": 0,
      "asset_id": 100000000,
      "coin": "#0",
      "symbol": "#0",
      "name": "BTC ≥ 78213 by 2026-05-03 06:00 UTC — Yes",
      "description": "class:priceBinary|underlying:BTC|expiry:20260503-0600|targetPrice:78213|period:1d",
      "side_name": "Yes",
      "recurring_class": "priceBinary",
      "recurring_underlying": "BTC",
      "recurring_expiry": "2026-05-03T06:00:00Z",
      "recurring_target_px": 78213,
      "recurring_period": "1d",
      "builder_address": "0x0000000000000000000000000000000000000000",
      "is_settled": false,
      "settlement_value": 0,
      "settlement_at": "2026-05-03T06:00:05.149Z",
      "first_seen_at": "2026-05-02T07:47:00Z",
      "last_updated_at": "2026-05-02T20:25:00Z",
      "display_title": "BTC above 78,213 on May 3 at 06:00 UTC? — Yes",
      "slug": "btc-above-78213-yes-may-03-0600"
    }
  ],
  "meta": {
    "count": 123,
    "next_cursor": "<string>",
    "request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "coverage_from": "2023-11-07T05:31:56Z",
    "notice": "<string>"
  }
}

{
  "code": 401,
  "error": "Missing or invalid API key. Provide X-API-Key header."
}

{
  "code": 429,
  "error": "Rate limit exceeded"
}

GET

https://api.0xarchive.io

hyperliquid

hip4

instruments

List HIP-4 instruments

curl --request GET \
  --url https://api.0xarchive.io/v1/hyperliquid/hip4/instruments \
  --header 'X-API-Key: <api-key>'

const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://api.0xarchive.io/v1/hyperliquid/hip4/instruments', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.0xarchive.io/v1/hyperliquid/hip4/instruments"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

{
  "success": true,
  "data": [
    {
      "outcome_id": 0,
      "side": 0,
      "asset_id": 100000000,
      "coin": "#0",
      "symbol": "#0",
      "name": "BTC ≥ 78213 by 2026-05-03 06:00 UTC — Yes",
      "description": "class:priceBinary|underlying:BTC|expiry:20260503-0600|targetPrice:78213|period:1d",
      "side_name": "Yes",
      "recurring_class": "priceBinary",
      "recurring_underlying": "BTC",
      "recurring_expiry": "2026-05-03T06:00:00Z",
      "recurring_target_px": 78213,
      "recurring_period": "1d",
      "builder_address": "0x0000000000000000000000000000000000000000",
      "is_settled": false,
      "settlement_value": 0,
      "settlement_at": "2026-05-03T06:00:05.149Z",
      "first_seen_at": "2026-05-02T07:47:00Z",
      "last_updated_at": "2026-05-02T20:25:00Z",
      "display_title": "BTC above 78,213 on May 3 at 06:00 UTC? — Yes",
      "slug": "btc-above-78213-yes-may-03-0600"
    }
  ],
  "meta": {
    "count": 123,
    "next_cursor": "<string>",
    "request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "coverage_from": "2023-11-07T05:31:56Z",
    "notice": "<string>"
  }
}

{
  "code": 401,
  "error": "Missing or invalid API key. Provide X-API-Key header."
}

{
  "code": 429,
  "error": "Rate limit exceeded"
}

API key required. Send X-API-Key with this request. See REST authentication.

Shared request rules

Machine schema

Open the generated operation schema for machine-readable request and response details.

Authorizations

X-API-Key

string

header

required

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

Response

List of HIP-4 per-side instruments

API response wrapping an array of HIP-4 per-side instruments

success

boolean

Example:

true

data

object[]

Hide child attributes

data.outcome_id

integer<int64>

required

Numeric outcome identifier

Example:

0

data.side

enum<integer>

required

Side index: 0 = Yes, 1 = No

Available options:

0,

1

Example:

0

data.asset_id

integer<int64>

required

Public asset ID. Formula: 100_000_000 + 10*outcome_id + side.

Example:

100000000

data.coin

string

required

Coin identifier. Returned in #-prefixed form. REST paths accept either the bare numeric id (e.g. 0) or the #-prefixed form (e.g. #0). Format: 10*outcome_id + side.

Example:

"#0"

data.symbol

string

required

Same value as coin. Provided for consistency with other venues.

Example:

"#0"

data.name

string | null

Human-readable per-side market name

Example:

"BTC ≥ 78213 by 2026-05-03 06:00 UTC — Yes"

data.description

string | null

Pipe-delimited recurring-market metadata

Example:

"class:priceBinary|underlying:BTC|expiry:20260503-0600|targetPrice:78213|period:1d"

data.side_name

string | null

Human label for this side (typically Yes or No)

Example:

"Yes"

data.recurring_class

string | null

Recurring market class (e.g., priceBinary)

Example:

"priceBinary"

data.recurring_underlying

string | null

Underlying asset for recurring price-binary outcomes

Example:

"BTC"

data.recurring_expiry

string<date-time> | null

Settlement timestamp (UTC)

Example:

"2026-05-03T06:00:00Z"

data.recurring_target_px

number | null

Target price for the binary outcome

Example:

78213

data.recurring_period

string | null

Cadence of the recurring market (e.g., 1d, 1h)

Example:

"1d"

data.builder_address

string | null

Builder wallet address that deployed the outcome

Example:

"0x0000000000000000000000000000000000000000"

data.is_settled

boolean

Whether the outcome has settled. Once settled, live tracking ends for the market, but historical data remains queryable.

Example:

false

data.settlement_value

number | null

Settlement value once the outcome settles (0.0 or 1.0 for binary outcomes). Omitted while unsettled.

Example:

0

data.settlement_at

string<date-time> | null

Settlement timestamp (UTC). Omitted while unsettled.

Example:

"2026-05-03T06:00:05.149Z"

data.first_seen_at

string<date-time> | null

When this outcome side was first observed by 0xArchive (UTC)

Example:

"2026-05-02T07:47:00Z"

data.last_updated_at

string<date-time> | null

Timestamp when the side metadata was last updated

Example:

"2026-05-02T20:25:00Z"

data.display_title

string | null

Per-side human-readable title, deterministic from parsed metadata.

Example:

"BTC above 78,213 on May 3 at 06:00 UTC? — Yes"

data.slug

string | null

Per-side URL slug mirroring Hyperliquid's pattern.

Example:

"btc-above-78213-yes-may-03-0600"

API reference

SDKs & tooling

AI & agents

List HIP-4 instruments

Authorizations

Response