Get HIP-4 instrument

{ "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, "first_seen_at": "2026-05-02T07:47:00Z", "last_updated_at": "2026-05-02T20:25:00Z" }, "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-4 coin id (e.g., 0 for outcome 0 Yes side, 1 for No side). The #-prefixed form (#0, #1) is also accepted.

Example:

"0"

Response

HIP-4 instrument detail

API response wrapping a single HIP-4 per-side instrument

success

boolean

Example:

true

data

object

HIP-4 per-side instrument metadata. One row per #N coin. Each outcome has two sides: side 0 (Yes) and side 1 (No). Public asset_id formula: 100_000_000 + 10*outcome_id + side. Coin format: #<10*outcome_id + side>.

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, the market is no longer subscribed by the ingester but historical data remains queryable.

Example:

false

data.first_seen_at

string<date-time> | null

Timestamp when the side was first ingested

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"