Skip to main content
GET
Contract by id

Authorizations

X-Auth-Apikey
string
header
required

HMAC-signed API key. Send X-Auth-Apikey, X-Auth-Nonce and X-Auth-Signature.

Path Parameters

id
string
required

Response

avg_price
number
required

Volume-weighted average across fills.

Example:

0.6

created_at
string
required

ISO-8601.

Example:

"2026-08-07T10:00:00Z"

direction
enum<string>
required

Whether you bought or sold side on this contract. Always buy on a mint.

Available options:
buy,
sell
Example:

"buy"

event_slug
string | null
required

The parent event's slug — what a portfolio row links to.

Example:

"btc-updown-5m-1730"

event_title
string | null
required
Example:

"Bitcoin Up or Down 5m"

funds_spent
number
required

Cash paid, on a buy. 0 on a sell.

Example:

60

id
number
required
Example:

"usdc"

market_id
string
required

The market this position is in.

Example:

"12"

market_title
string
required
Example:

"Will BTC close above its open?"

match_type
enum<string>
required

mint creates a YES/NO pair from two buys; transfer moves an existing token from a seller to a buyer; merge redeems a YES and a NO from two sellers.

Available options:
mint,
transfer,
merge
Example:

"mint"

price
number
required

Fill price, a probability in (0,1).

Example:

0.6

proceeds
number
required

Cash received before fees, on a sell. 0 on a buy.

Example:

0

quote_currency
string
required
Example:

"usdc"

side
enum<string>
required

The outcome you traded on this contract. On an exit this is the outcome you sold or bought, not the book side.

Available options:
yes,
no
Example:

"yes"

state
enum<string>
required

Lifecycle. A settled contract names the winning side.

Available options:
active,
settled_yes,
settled_no,
voided
Example:

"active"

taker_fee_amount
string
required

The taker fee charged at trade time. Nothing further is taken at settlement — a winning share pays the full 1.00.

Example:

"0.17"

taker_fee_refunded
boolean
required

True when the market voided and the fee was returned.

Example:

false

volume
number
required

Shares held.

Example:

100

outcome_labels
string[]

The market’s YES and NO leg names, in that order. Absent on a market using the Yes/No default.

Example:
settled_at
string | null

When the market resolved. Null while the contract is open.

Example:

"2026-08-08T00:00:00Z"

settlement_status
enum<string> | null

The on-chain mint badge: pending until confirmed, reversed if the market voided.

Available options:
pending,
confirmed,
reversed
Example:

"confirmed"

settlement_status_raw
string

The internal state-machine value behind the badge.

Example:

"matched"