Series
One recurring market product — an asset paired with a cadence, e.g. “gold up/down, 5-minute”. Nine series trade in parallel. A series is identified on the API by itscategory. See
Series, assets, and categories.
category
Integer 1–9 on every round object and rounds WebSocket frame, naming the
series the round belongs to. Filters GET /v1/rounds?category=. 0 means
unclassified, never “all”.
feed
Integer 0–2 naming a price source: 0 = BTC, 1 = gold (XAU), 2 = WTI crude.
Scopes GET /v1/oracle/price?feed=, and appears on every oracle WebSocket
frame. Several series share a feed; each series has exactly one.
Round
One binary market on an asset’s price, running for its series’ cadence (60 seconds, 5 minutes, or 15 minutes). Each round has a strike (the price to beat), trades to the next cadence boundary, then freezes and settles. See Rounds and markets.round_number
Monotonic, never reused, the stable identity for a round. Key your own state
(open orders, positions, PnL history) on round_number, not market_id.
market_id
The venue’s slot identifier for the round currently bound to a market endpoint.
Drawn from a small recycled pool, the same market_id will refer to a
different round later. Always re-read the round before acting on a cached value.
generation
Optional exact-match epoch for a recycled market_id. Omit it (or send 0)
so the order binds to the current occupant. A non-zero value that does not
match the live gate epoch is rejected MARKET_STALE (519). Do not stamp a
cached WebSocket number or REST generation — those counters can disagree
with the gate.
Tick
Contract price as an integer pip from 1 to 9999 (0.01¢ = 1 = 10_000pips. Buying YES at tick4700costs 47.00¢ per contract and pays 10,000 pips ($1) if YES wins. Old1–99` ticks are rejected. See
Ticks, pips, and subcents.
Pip
Native cash and price unit. 1 pip = 0.01¢. Balances,max_cost, fees,
deposits, and withdrawals are pips (decimal strings). 10000 is $1.00.
tick_size
Advertised rest grid on market and orderbook snapshots: policy, mode,
tick_step, wing_lo, wing_hi. Live v1 is narrow (whole cents interior,
0.10¢ wings).
Outcome
yes or no, which side of the binary contract you are trading. Combined
with side (buy / sell), this determines book placement and settlement
direction.
client_order_id
Your idempotency key for order placement. You choose it; it must be unique per
order. On timeout, retry with the same client_order_id, at most one
order results.
as_of_seq
Sequencer position a read was computed at. Appears on every GET response. Restarts
from a low number after a venue restart, it is a session position, not a global
counter.
seq
On write responses, the sequencer stamp for the command, your audit join back
to canonical history. On WebSocket public channels, the per-subscription
envelope counter (contiguous from 1).
channel_seq
On the private user WebSocket channel, the per-user monotonic counter for
gap detection and replay. Pass last_channel_seq on subscribe to resume.
Distinct from the public per-subscription envelope seq.
Retention caps
Count limits on live listings (tape_cap, terminal_cap, reject_cap,
fill_cap). Discover via GET /v1/exchange/retention. See
Retention.
Dead-man
Gateway-side timer:POST /v1/portfolio/deadman arms; on timeout the gateway
issues one cancel-all and disarms. Not an order-group fill-velocity limit.
TWAP / settle_price
At freeze, the round’s settle price is a time-weighted average of the sequenced
oracle price for that round’s own feed over the last N seconds (default
N = 10, twap_window_secs on the round row). Stored as an integer in units
of 1e-8 USD.
cancel_on_pause
Order flag (default false). When set, resting orders are cancelled if the
round pauses or freezes, instead of surviving into the next phase.
Scope
Permission carried by the API key:read, trade, or withdraw. Bot keys are
read+trade only. See API keys and scopes.
Rate limits
Three token buckets per key: read (GETs and WS subscribe), write (places,
decrease, dead-man, withdrawals), cancel (cancel, cancel-batch, mass-cancel).
Write rate scales with trailing 30-day fill volume. Cost is 1 token per HTTP
request. See Rate limits.
Closed schema
Request bodies reject unknown fields with400 unknown_field. A typo’d field
name fails loudly instead of being silently ignored.