Skip to main content
GET
Indicative executable price for a size

Path Parameters

symbol
string
required

Market symbol, e.g. UAE-CUP-FINAL-20260425. Used by sub-resource endpoints (/orderbook, /trades, /ohlc, /traders). The root market-detail endpoint /api/markets/{slug} accepts the slug instead — see MarketSlug.

Query Parameters

side
enum<string>
required

BUY or SELL; anything else answers 400 invalid_side.

Available options:
BUY,
SELL
size
string
required

Positive decimal number of shares: at most 14 integer digits and 18 decimal places; no sign, exponent, spaces or leading zeros. Anything else, or zero, answers 400 invalid_size.

limitPrice
string

Decimal price strictly between 0 and 1 (0. and 1 to 18 decimal places). Levels beyond it are not used. Anything else answers 400 invalid_limit_price.

outcome
integer

Outcome index, digits only, as on /orderbook: anything else, or an index the market does not have, answers 400 invalid_outcome. Required on a market of more than two outcomes (400 outcome_required when omitted); on a two-outcome (binary) market an omitted outcome means 0.

Required range: x >= 0

Response

OK

executableQty
string
required

Quantity the visible book can fill now, at most the requested size and within the limit price (decimal string, exact over the served levels; "0" when nothing).

totalCost
string
required

Total paid for a BUY, or received for a SELL, for executableQty: USDC, 6 decimal places, rounded against the caller (a BUY's cost up, a SELL's proceeds down); "0.000000" when nothing is executable.

avgPrice
string | null
required

Volume-weighted average price per share: the exact cost over executableQty, 8 decimal places (the price grid), rounded to nearest with ties to even; null when nothing is executable.

levelsConsumed
object[]
required

The book levels used, best first, with the quantity taken from each.

bookEmpty
boolean
required

True when the side of the book being walked has no levels at all. A cut read that served no level (every level it returned was too small to show) is not empty: capped then says whether deeper levels may lie within the limit.

capped
boolean
required

True when size outlasted every level walked and the read of that side was cut (at its 100-level cap, or otherwise truncated), so deeper levels may exist within the limit price and more may be executable than executableQty. False when the size was filled, the limit price stopped the walk, the limit price is at or before the last price the cut read returned, the side holds no more levels (book exhausted), or the side has no levels at all (bookEmpty: the two are never both true).

tradable
boolean
required

True when the market is OPEN and trading on its contract generation is not halted, so an order can take the price now. False on any other status (PRE_MARKET, PAUSED, SUSPENDED, CLOSED, PENDING_RESOLUTION …) or while the market's contract generation is halted: the walk still reports the resting levels, but no order can take them (PRE_MARKET accepts only resting LIMIT GTC orders). The status can lag a status change by a few seconds.