Skip to main content
POST
Place a signed order

Authorizations

X-Api-Key
string
header
required

Partner / integrator key — format ps_live_<keyId>_<secret>. Partner keys are issued by PredictStreet; a user can also create keys bound to their own wallet from their account settings in the web app. Never ship to a browser. multi_wallet partners must additionally send X-User-Wallet: 0x<40-hex> on every authenticated request to declare the acting wallet. See the API keys guide for scope taxonomy, partner kinds, rate limits, and rotation procedure.

Headers

X-User-Wallet
string

Required for multi_wallet partners on every authenticated request; ignored for single_wallet. Declares the acting end-user wallet for this request — drives KYC checks, balances/positions/orders attribution, rate-limit buckets, and audit. Lower-cased server-side. Missing on a multi_wallet key → 401 api_key_user_wallet_required; malformed → 401 api_key_user_wallet_invalid. The on-chain CTFExchange/Vault contracts still verify EIP-712 signer ↔ vault binding, so loosening API-layer attribution is safe by construction.

Pattern: ^0x[a-fA-F0-9]{40}$
Example:

"0x742d35Cc6634C0532925a3b844Bc9e7595f0bEb3"

Body

application/json
marketId
string
required

App-level market symbol. The platform resolves the on-chain tokenId for the chosen outcome automatically.

Example:

"NC26-BIN-83479265"

side
enum<string>
required
Available options:
buy,
sell
outcome
enum<string>
required

0 = YES, 1 = NO. Every market is a YES/NO market; for a multi-outcome (neg-risk) event, pick the market symbol of the outcome you want and trade its YES (0) or NO (1).

Available options:
0,
1
price
string
required

Limit price in USDC, decimal string. Tick size 0.01 (max 2dp), strictly between 0 and 1. Prices ≥ 1 or finer than the tick come back as status: REJECTED with code: invalid_amounts. A wider per-market tick may apply while a match is in-play (see in_play_tick_violation).

Example:

"0.42"

quantity
string
required

Outcome-token quantity, decimal string. Step 0.000001 (max 6dp). Minimum order size: price × quantity ≥ the platform minimum (default 1 USDC); MARKET SELL orders are measured by quantity in shares instead (their signed price is only a slippage floor). Smaller orders are rejected with order_too_small.

Example:

"2"

nonce
string
required

Decimal-string of the salt field used in the signed EIP-712 Order struct (uint256).

expiry
integer
required

Unix-seconds = Order.expiration in the signed struct. Recommended 0 (no on-chain expiry); a tight TTL races async settlement and surfaces as MatchFailed(OrderExpired) (selector 0xc56873ba).

Required range: x >= 0
Example:

0

maker
string
required

Your vault address (= VaultFactory.vaultOf(signer)) or your signer wallet. Any other address is rejected with code: maker_mismatch — HTTP 401 on POST /api/orders/place, or a per-entry REJECTED result in a batch. This field only authorizes the request: whichever of the two you send, the platform verifies your signature against Order.maker = your vault with signatureType = 1, so a struct signed with any other maker (including your wallet) comes back in the response body as status: REJECTED, code: bad_signature, not as an HTTP error.

Pattern: ^0x[a-fA-F0-9]{40}$
Example:

"0x742d35Cc6634C0532925a3b844Bc9e7595f0bEb3"

signature
string
required

EIP-712 signature over the full on-chain CTFExchange Order struct (11 fields). verifyingContract = the binary CTFExchange or neg-risk NegRiskCtfExchange for the market.

Pattern: ^0x[a-fA-F0-9]+$
clientOrderId
string

Idempotency key scoped per associatedWallet. A retry with the same (wallet, clientOrderId) returns the original response.

Maximum string length: 128
type
enum<string>
default:limit

Order type. limit rests in the book at price (or matches incoming counterparties at price-or-better). market consumes the best resting prices up to price as a slippage cap. market requires timeInForce ∈ {ioc, fok} — market + gtc is rejected with code: invalid_tif because a MARKET order cannot rest.

Available options:
limit,
market
timeInForce
enum<string>
default:gtc

Time-in-force. gtc (Good-Till-Cancelled) — the default; rests until filled, expired, or cancelled. ioc (Immediate-Or-Cancel) — match what is available at price-or-better, cancel any unfilled remainder immediately; partial fills are allowed. fok (Fill-Or-Kill) — on a limit order, fully fill or cancel without any partial fill; on a market order fok is accepted but executes like ioc (partial fills possible). Omitted ⇒ gtc for every order type, so a market order must set ioc or fok explicitly: market with gtc, or with no timeInForce, is not placed and comes back in the response body as status: REJECTED, code: invalid_tif (not an HTTP 400).

Available options:
gtc,
ioc,
fok
postOnly
boolean
default:false

Post-only: the order must only rest on the book and never match on entry (maker-side guarantee). Only valid for LIMIT orders with GTC time-in-force (optionally with expiry); combining postOnly with a MARKET type or an IOC/FOK time-in-force is rejected with code post_only_invalid_order_type: HTTP 400 on POST /api/orders/place, or a per-entry REJECTED result on POST /api/orders/place-batch. A post-only order whose price meets or crosses the opposite side of the book (at-touch equality included) is rejected with { "status": "REJECTED", "code": "post_only_would_cross" } instead of executing — reprice inside the spread and resubmit. If its price also reaches one of your own resting orders, it is rejected with self_cross_blocked instead (self-trade prevention is checked first). Omitted ⇒ false (unchanged behavior).

feeRateBps
integer

Optional echo of the feeRateBps you put in the signed Order struct. When present it must equal the market's current feeTakerBps; otherwise the order is rejected with code: stale_fee_quote — re-fetch the rate and re-sign. When omitted, the platform verifies your signature against the current rate, so a stale signed value comes back as bad_signature instead. Send it to get the explicit diagnostic.

Required range: x >= 0

Response

Order processed. HTTP 201 is returned for accepted orders and for most rejections, so always check the body's status — any value other than REJECTED means the order was accepted. REJECTED means it was not placed; the top-level code and message give the reason (e.g. bad_signature, vault_not_deployed, stale_fee_quote, insufficient_funds, market_not_open). Some codes also carry a top-level details object; for bad_signature it holds recovered, expected_signer and platform_canonical_struct. A few refusals return an HTTP error status with the standard error envelope instead, e.g. maker_mismatch (401), post_only_invalid_order_type (400), or order_already_placed (409) when a signed order that was already placed is sent again.

orderId
string
required

Server-side order id (UUID). Empty string when the order was rejected before it was recorded (validation, signature, fee or funds checks); an order the matching engine rejects after it was recorded comes back as REJECTED with its real id.

status
enum<string>
required

Lifecycle state at the moment of response. Note: a 201 response may carry status=REJECTED together with a populated code / message — partner SDKs MUST inspect the body, not just the HTTP code.

Available options:
PENDING,
OPEN,
FILLED,
CANCELLED,
REJECTED,
EXPIRED,
SETTLEMENT_FAILED
filledQty
string
required

Cumulative quantity filled at response time (decimal string).

remainingQty
string
required

quantity - filledQty (decimal string).

trades
object[]
required

Synchronous fills produced by IOC/FOK or aggressive LIMIT orders.

code
string

Reject reason code (insufficient_funds, invalid_amounts, market_not_open, bad_signature, order_signed_with_floor_notional, insufficient_position, …). Present when status=REJECTED. For order_signed_with_floor_notional the response body also carries a details object with signedMakerAmountWei + expectedCeilMakerAmountWei so the SDK can re-sign without recomputing the CEIL formula — see /errors/codes#order_signed_with_floor_notional-diagnostic-hints.

message
string

Human-readable explanation; pairs with code.

traceId
string

Correlation id for this request — quote it in support reports. On place-batch every entry carries the same value. Omitted (never null) when no trace is active. Error envelopes carry the same id as error.trace_id.

details
object

Structured rejection context; the shape depends on code. bad_signature carries recovered (the address your signature recovers to, null if it does not decode), expected_signer (the authenticated wallet) and platform_canonical_struct (the exact Order struct the platform hashed and verified) — diff it field by field against the struct you signed. order_signed_with_floor_notional carries signedMakerAmountWei + expectedCeilMakerAmountWei. Never rely on details being present — check before reading.

clientOrderId
string

Echo of the request clientOrderId (when supplied). Lets MM partners correlate the server-issued orderId to their own client-side handle without a follow-up GET /api/orders/{id}. Present on every shape (success, REJECTED, idempotent replay) when the request carried one. Also echoed on the order_placed and order_cancelled frames of the user_orders WebSocket channel.