Skip to main content
POST
Place a batch of signed orders (max 10)

Authorizations

X-Api-Key
string
header
required

Partner / integrator key — format ps_live_<keyId>_<secret>. Issued by PredictStreet ops via the admin panel; never self-service. 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
orders
object[]
required

1–10 orders, each identical in shape to the single POST /api/orders/place body. Processed sequentially in array order.

Required array length: 1 - 10 elements

Response

Per-order results, aligned to the request orders[] by index. Inspect each entry's success flag and status — a 200 batch can still contain REJECTED entries.

orderId
string
required

Server-side order id (UUID). Empty string when status=REJECTED.

status
enum<string>
required

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

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.

success
boolean
required

true when the order was accepted (status ≠ REJECTED); false for a per-order business reject. Convenience flag over status.

code
string

Reject reason code (insufficient_balance, invalid_amounts, market_not_open, bad_signature, order_signed_with_floor_notional, position_limit_breached, …). 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.

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 events.order_placed and events.order_cancelled WS frames.