Error
errorError code
messageHuman-readable error message
MarketStatus
Status of a prediction market
TimeInForce
Order execution behavior:
good-til-cancel- Order remains active until filled or cancelled (default)immediate-or-cancel- Fill immediately or cancel remainingfill-or-kill- Fill entire order immediately or cancelmaker-or-cancel- Only add liquidity to the order book; if any part would fill immediately, the entire order is cancelled. Also known as "post-only".
Contract
idlabelHuman-readable label (e.g., "Yes", "No")
abbreviatedNameShort form label (e.g., ">$90")
descriptionRich text description
pricesCurrent bid/ask pricing for the contract
totalSharescolorstatusStatus of a prediction market
imageUrlcreatedAtexpiryDateresolutionSideThe outcome being traded (Yes or No)
resolvedAttermsAndConditionsUrltickerinstrumentSymboleffectiveDatemarketStateTrading state of the contract
sortOrderDisplay order within the event
Strike price information for Up/Down crypto contracts
sourceData source identifier for price observation (e.g., "GRR-KAIKO_BTCUSD_60S"). Present for crypto Up/Down contracts.
settlementValueThe observed settlement price. Only present after the contract is settled.
Strike
valueThe strike price value. Null for "reference" type strikes where the value is determined at availableAt time.
typeStrike type - "reference" for Up/Down contracts, "above" for Higher/Lower contracts
availableAtWhen the strike price becomes available
Event
idtitleslugdescriptionimageUrltypeType of prediction market
categoryseriestickerThe event ticker (e.g., "BTC100K2025")
statusStatus of a prediction market
resolvedAtcreatedAtTradeable contracts within this event
volumeTotal trading volume in USD
liquidityTotal liquidity in USD
tagseffectiveDateexpiryDatesubcategoryNested category information for the event
sourceData source identifier for price observation. Aggregated from contracts for crypto Up/Down events.
Settlement information for resolved events
Settlement
valueThe observed settlement value (e.g., the price at expiry for crypto contracts)
ContractMetadata
contractIdcontractNamecontractTickereventTickereventNamecategorycontractStatusimageUrlexpiryDateresolvedAtdescriptionOrderRequest
symbolContract instrument symbol
orderTypeOrder type (currently only limit orders are supported)
sidequantityNumber of contracts
priceLimit price (0-1 range)
outcomeThe outcome being traded (Yes or No)
timeInForceOrder execution behavior:
good-til-cancel- Order remains active until filled or cancelled (default)immediate-or-cancel- Fill immediately or cancel remainingfill-or-kill- Fill entire order immediately or cancelmaker-or-cancel- Only add liquidity to the order book; if any part would fill immediately, the entire order is cancelled. Also known as "post-only".
OrderResponse
orderIdhashOrderIdclientOrderIdglobalOrderIdstatussymbolsideoutcomeThe outcome being traded (Yes or No)
orderTypeOrder type (currently only limit orders are supported)
quantityOriginal order quantity
filledQuantityAmount filled so far
remainingQuantityAmount remaining to fill
priceLimit price
avgExecutionPriceAverage price of fills
createdAtupdatedAtcancelledAtPosition
symbolinstrumentIdtotalQuantityTotal position size
avgPriceAverage entry price
outcomeThe outcome being traded (Yes or No)
ContractShareVolume
symbolContract instrument symbol
totalQtyTotal taker volume across all participants (in shares)
userAggressorQtyThe authenticated user's taker (aggressor) volume (in shares)
userRestingQtyThe authenticated user's maker (resting) volume (in shares)

