Skip to main content
POST
Cancel all open orders

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"

Response

Sweep answered. Ids that were not cancelled are listed in notCancelled with a reason; repeat the call while any is not_attempted.

cancelled
string[]
required

Ids (from the snapshot taken when the request arrived) whose cancellation was accepted. Acceptance and effect are separate moments: a read of the order taken right after this response can still show the pre-cancel status — poll the order rather than assuming. This is the array of cancelled order ids. Use cancelled.length for the count.

notCancelled
object
required

Map of orderId → reason for every snapshot order that was not cancelled. Same reason vocabulary as POST /api/orders/cancel-batch; not_attempted means this call stopped before reaching the id — repeat the call to cover it.

remainingQty
object
required

Map of orderId → quantity still unfilled when that order was cancelled (decimal string), for exactly the ids in cancelled. An upper bound, not a traded quantity: size a replacement quote from it, and book fills from the order read.