API Documentation

WebSocket stream of live market data, same origin as the site: wss://<your-domain>/ws. Open to everyone — it carries market data only. Account streams require sending your own userId after connecting.

Liveness probe. Cached market count, open WebSocket connections, upstream feed WS state.

Geo gate plus white-label brand resolution for the calling Host. The frontend calls it before render.

Upstream market-cache freshness: last and next sync time, cached market count, cache age against its TTL in seconds.

White-label brand config for the calling Host: platform name, colour theme, layout template. The only /api/partner/* path useful to a normal developer.

Main market list. Pinned custom and short-term markets are merged in as a prefix and are not affected by sort.

Same paging and filtering as /api/markets but a trimmed card payload: top two outcomes only, volume and liquidity floored. Cheaper for list views.

Single-call homepage bootstrap: the category list plus a first page of markets. Saves a round trip.

Full market detail including the complete outcome set, description and resolution text. Accepts the id or the slug.

Just the resolution rules text for a market, without the full detail payload.

Category list enriched with live marketCount and totalVolume. The `all` row carries the totals.

Sub-category tags with counts for one category. These tag values are exactly what /api/markets?tag= accepts.

Weighted full-text search across title, outcomes, tags, category and description. Results are split into events and markets.

Find markets related to news keywords.

Position holders for a long-form market, with the outcome each one holds.

Bid and ask ladder for one outcome of a long-form market.

Currently tradeable 5-minute up/down markets, de-duplicated to one per asset (the soonest that has not expired).

Currently tradeable 15-minute up/down markets, one per asset.

The single active 5m market for an asset. This is the auto-switch helper a bot should poll to know what to trade right now.

The single active 15m market for an asset.

Scheduled but not yet started 5m markets, so a bot can pre-position.

Scheduled but not yet started 15m markets.

Recent and resolved 5m markets with settlement data and an embedded price series. Heavy — every row carries priceHistory.

Resolved 15m market history with priceHistory, capped at 240 points per market.

Full 5m market detail with the quoted price, delta and time remaining. Accepts the id or the slug.

Full 15m market detail with the quoted price and time remaining.

Resting limit orders for a 5m market, aggregated per side plus the raw order rows.

Resting limit orders for a 15m market.

Live spot snapshot for every tracked asset, keyed by symbol.

Live spot snapshot for one asset.

OHLCV candles for an asset. Proxied live to an external price feed.

The candle series the short-term markets are settled against.

Aggregate traded volume and trade count for an asset.

Current holders for a short-term asset market, largest first.

Live trade tape for a short-term asset market. This is the read side of a copytrading loop.

Live trade tape for one long-form event, with the outcome traded on each row.

Ranked traders. Use it to pick a leader to copy.

One account’s standing without pulling the whole board.

Public profile card for any account: identity plus aggregate stats.

Trade history for any account. This is the feed a copytrading bot follows.

Open positions for any account, across every market type.

Real and demo balance for your own account.

Your open 15m positions, each enriched with the live market state. positionId for a claim comes from here.

Your open 5m positions, enriched with the live market state.

Your AMM order history.

Your 15m limit orders. The orderId a cancel needs comes from here.

Your 5m limit orders.

Your ledger: deposits, trades, settlements.

Your points balance, recent activity and achievements.

Create an API key. The plaintext key is returned exactly once, in this response, and is never recoverable afterwards — only its sha256 is stored.

List your API keys. Never returns key material — prefix only. Revoked keys stay visible with their revokedAt stamp, because they still explain trades in your history.

Revoke one of your API keys. Idempotent — revoking an already-revoked key returns 200.

Primary order placement route. Auto-detects the market timeframe from the id (tries 15m, then 5m, then long-form/event). Handles market and limit, buy and sell.

The older AMM order route. Still live and still reachable with a key. Same money path as /orders/place but a narrower body and stricter type checking. Prefer /orders/place for new integrations.

Buy UP or DOWN shares in a 15-minute market. Market order when you send amount; limit order when type is "limit" or when you send both price and shares. A 0.5% fee is charged on top of amount.

Sell shares back and close a 15m position. This is the correct way to close a position. A 0.5% fee is deducted from the proceeds.

Settle a position on a RESOLVED 15m market. A winning position pays shares x 1.00; a losing position is closed at 0. Both outcomes return 200 — read data.isWinner.

Buy UP or DOWN shares in a 5-minute market. Same contract as the 15m buy.

Sell shares back and close a 5m position. The supported way to close a 5m position.

Settle a position on a RESOLVED 5m market. Winning positions pay shares x 1.00; losing positions close at 0. Both return 200.

Cancel a resting 15m limit order and refund the unfilled stake.

Cancel a resting 5m limit order and refund the unfilled stake.

Second cancel path for a 5m limit order, addressed by market and order. Ownership is re-checked in the handler.

Best price for one side of an outcome, in the standard CLOB response shape.

Full ladder for an outcome in the CLOB shape, prices and sizes as strings.

Midpoint between best bid and best ask.

Absolute and percentage spread for an outcome.

Price series for a market in the CLOB shape.

Current maker and taker fee rates.

Dry-run an order: shares out, average price, price impact, fee and the resulting prices. Pure calculation — nothing is written and no balance moves.