Skip to main content
POST
Place an order (consolidated)

Body

application/json
symbol
string
required

Venue-native outcome token id

side
required
Available options:
buy
type
required
Available options:
LIMIT
venue

Trading venue. Omitted = polymarket (backward compatible). predictfun requires the partner venue entitlement; LIMIT and MARKET only for now.

Available options:
polymarket
price
string

Decimal probability 0..1, e.g. "0.72" for 72¢ (NOT cents). Required for LIMIT / ICEBERG / TAKE_PROFIT / STOP_LOSS. Optional for TWAP (derived from the live top of book when omitted) and TRAILING_STOP (reference; execution.high_water_mark also works).

size
string

Shares. Required for LIMIT / ICEBERG / TAKE_PROFIT / STOP_LOSS / TRAILING_STOP and MARKET sell; for TWAP either size or quote_amount works.

quote_amount
string

US dollars. MARKET buy notional; TWAP: shares are derived from it at the limit price; PEGGED: accepted as an alias for budget_usdc.

time_in_force

LIMIT only. GTC (default) rests on the book (GTD when expiration is set). IOC fills whatever crosses immediately and cancels the remainder (Polymarket FAK) — the response reports the actual filled_size. FOK fills the full size instantly or cancels entirely. Incompatible with expiration. MARKET orders always behave as IOC/FAK.

Available options:
GTC
expiration
number
condition_id
string
outcome
Available options:
yes
offset_ticks
number

PEGGED: distance from the touch in CLOB ticks (1 tick = $0.001); 0 = passive at the touch.

budget_usdc
string

PEGGED buy budget in US dollars, top-level decimal string, e.g. "50". quote_amount is accepted as an alias.

price_floor
number

PEGGED: lowest chase price, decimal probability 0..1 (NOT cents).

price_ceiling
number

PEGGED: highest chase price, decimal probability 0..1 (NOT cents).

execution
object
take_profit
object
stop_loss
object
client_order_id
string
metadata
string

Response

200 - application/json

Default Response

type
string
required
order_id
string | null
required
record_id
string | null
required
status
string
required
side
string
required
price
string | null
required
size
string | null
required
filled_size
string | null
required
remaining_size
string | null
required
matched_amount
string | null
required
builder_code_used
string | null
required
created_at
number
required
brackets
object
warnings
string[]
message
string