Skip to main content
POST
/
api
/
orders
/
place
Place a signed order
curl --request POST \
  --url https://core.api.dev.predictstreet.sde.adifoundation.ai/api/orders/place \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: <api-key>' \
  --data '
{
  "marketId": "NC26-BIN-83479265",
  "side": "buy",
  "outcome": "0",
  "price": "0.42",
  "quantity": "2",
  "nonce": "<string>",
  "expiry": 0,
  "maker": "0x742d35Cc6634C0532925a3b844Bc9e7595f0bEb3",
  "signature": "<string>",
  "clientOrderId": "<string>",
  "type": "limit",
  "timeInForce": "gtc"
}
'
{
  "orderId": "<string>",
  "status": "PENDING",
  "filledQty": "<string>",
  "remainingQty": "<string>",
  "trades": [
    {
      "id": "<string>",
      "orderId": "<string>",
      "userWallet": "<string>",
      "marketId": "<string>",
      "price": "<string>",
      "quantity": "<string>",
      "fee": "<string>",
      "side": "buy",
      "createdAt": "<string>"
    }
  ],
  "code": "<string>",
  "message": "<string>"
}

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
​
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 = first outcome (YES for binary), 1 = second outcome (NO for binary). Index into market.outcomes[] for N-ary.

Available options:
0,
1
​
price
string
required

Decimal USDC price per outcome token. Strictly between 0 and 1, max 6 decimals.

Example:

"0.42"

​
quantity
string
required

Decimal outcome-token quantity. Strictly > 0, max 6 decimals.

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

Vault address (= VaultFactory.vaultOf(signer)). Must equal Order.maker in the signed struct. The backend recomputes vaultOf(signer) and rejects mismatches with 400 bad_signature.

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 PredictStreetNegRiskCtfExchange 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>

Time-in-force. gtc (Good-Till-Cancelled) — default for limit; 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) — fully fill or cancel without any partial fill. Default for market is ioc; sending market + gtc returns 400 with code: invalid_tif.

Available options:
gtc,
ioc,
fok

Response

​
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.

​
code
string

Reject reason code (insufficient_balance, invalid_amounts, market_not_open, bad_signature, position_limit_breached, …). Present when status=REJECTED.

​
message
string

Human-readable explanation; pairs with code.