Get HIP-4 outcome by slug

{ "success": true, "data": { "outcome_id": 0, "side_specs": [ { "side": 0, "name": "Yes", "coin": "#0", "asset_id": 100000000 } ], "is_settled": false, "name": "BTC ≥ 78213 by 2026-05-03 06:00 UTC", "description_raw": "class:priceBinary|underlying:BTC|expiry:20260503-0600|targetPrice:78213|period:1d", "class": "priceBinary", "underlying": "BTC", "expiry": "2026-05-03T06:00:00Z", "target_price": 78213, "period": "1d", "status": "live", "source_seen_at": "2026-05-02T20:25:00Z", "aggregated_oi": { "currency": "USDH", "side0_open_interest_contracts": 568048, "side1_open_interest_contracts": 568048, "outcome_display_open_interest_contracts": 1136096, "paired_set_supply_contracts": 568048, "side_supply_parity": true, "as_of": "2026-05-02T20:27:21Z", "side0_as_of": "2026-05-02T20:27:21Z", "side1_as_of": "2026-05-02T20:27:21Z" } }, "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://www.0xarchive.io/dashboard/

Path Parameters

slug

string

required

HIP-4 outcome or side slug.

Example:

"btc-above-78213-may-04-0600"

Response

HIP-4 outcome aggregate

API response wrapping a single HIP-4 outcome aggregate (with aggregated_oi populated on the detail endpoint)

success

boolean

Example:

true

data

object

Per-outcome aggregate (both sides combined). Returned by /outcomes (list, without aggregated_oi) and /outcomes/{outcome_id} (detail, with aggregated_oi populated).

Hide child attributes

data.outcome_id

integer<int64>

required

Numeric outcome identifier

Example:

0

data.side_specs

object[]

required

Per-side specs. Typically two elements: side 0 (Yes) and side 1 (No).

Hide child attributes

data.side_specs.side

enum<integer>

required

Side index: 0 = Yes, 1 = No

Available options:

0,

1

Example:

0

data.side_specs.name

string

required

Human label for this side

Example:

"Yes"

data.side_specs.coin

string

required

Coin identifier for this side. Returned in #-prefixed form. REST paths accept either the bare numeric id (e.g. 0) or the #-prefixed form (e.g. #0).

Example:

"#0"

data.side_specs.asset_id

integer<int64>

required

Public asset ID for this side

Example:

100000000

data.is_settled

boolean

required

Whether the outcome has settled

Example:

false

data.name

string | null

Human-readable outcome name (without per-side suffix)

Example:

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

data.description_raw

string | null

Pipe-delimited recurring-market metadata as emitted upstream

Example:

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

data.class

string | null

Outcome class (e.g., priceBinary)

Example:

"priceBinary"

data.underlying

string | null

Underlying asset for recurring price-binary outcomes

Example:

"BTC"

data.expiry

string<date-time> | null

Settlement timestamp (UTC)

Example:

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

data.target_price

number | null

Target price for the binary outcome

Example:

78213

data.period

string | null

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

Example:

"1d"

data.status

string | null

Lifecycle status (live, settled, ...)

Example:

"live"

data.source_seen_at

string<date-time> | null

Last time the outcome was seen upstream

Example:

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

data.aggregated_oi

object

Display/paired/parity OI aggregates. Populated ONLY on the /outcomes/{outcome_id} detail response. Omitted (or null) on the /outcomes list response.

Hide child attributes

data.aggregated_oi.currency

enum<string>

required

Notional currency. Always USDH for HIP-4.

Available options:

USDH

Example:

"USDH"

data.aggregated_oi.side0_open_interest_contracts

number | null

Latest open-interest contracts for side 0 (Yes)

Example:

568048

data.aggregated_oi.side1_open_interest_contracts

number | null

Latest open-interest contracts for side 1 (No)

Example:

568048

data.aggregated_oi.outcome_display_open_interest_contracts

number | null

Display total: sum of side0 + side1 OI contracts. Use this for outcome-level OI dashboards.

Example:

1136096

data.aggregated_oi.paired_set_supply_contracts

number | null

Paired-set supply: minimum of side0 and side1 OI contracts. Represents the count of fully collateralized Yes+No pairs in circulation.

Example:

568048

data.aggregated_oi.side_supply_parity

boolean | null

True when side0 OI equals side1 OI within tolerance. Parity should hold for binary outcomes; a sustained false value indicates ingestion drift.

Example:

true

data.aggregated_oi.as_of

string<date-time> | null

Latest timestamp across both sides

Example:

"2026-05-02T20:27:21Z"

data.aggregated_oi.side0_as_of

string<date-time> | null

Timestamp of the side 0 OI sample

Example:

"2026-05-02T20:27:21Z"

data.aggregated_oi.side1_as_of

string<date-time> | null

Timestamp of the side 1 OI sample

Example:

"2026-05-02T20:27:21Z"