Skip to main content
GET
Order detail

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"

Path Parameters

id
string
required

Response

OK

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

"0x742d35Cc6634C0532925a3b844Bc9e7595f0bEb3"

maker
string

On-chain Order.maker: your vault (VaultFactory.vaultOf(signer)).

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

"0x742d35Cc6634C0532925a3b844Bc9e7595f0bEb3"

signer
string

Wallet (EOA) that signed the EIP-712 order.

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

"0x742d35Cc6634C0532925a3b844Bc9e7595f0bEb3"

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

Decimal number encoded as a string to preserve precision (e.g. '100.5').

quantity
string

Decimal number encoded as a string to preserve precision (e.g. '100.5').

filledQty
string

Decimal number encoded as a string to preserve precision (e.g. '100.5').

remainingQty
string

Decimal number encoded as a string to preserve precision (e.g. '100.5').

expiration
integer

Unix seconds, equal to the signed Order.expiration (sent as expiry when placing). 0 = no expiry.

orderType
enum<string>

Order type (uppercase, unlike the lowercase type request field).

Available options:
LIMIT,
MARKET
timeInForce
enum<string>

Time-in-force (uppercase, unlike the lowercase request field).

Available options:
GTC,
IOC,
FOK
status
enum<string>

Order status. PARTIAL = partly filled, the rest still open.

Available options:
PENDING,
OPEN,
PARTIAL,
FILLED,
CANCELLED,
REJECTED,
EXPIRED,
SETTLEMENT_FAILED
clientOrderId
string
orderHash
string | null

EIP-712 digest of the signed order, lowercase 0x + 64 hex. The same hash the exchange contract emits in OrderFilled, and one you can compute before sending; look an order up by it with GET /api/orders/lookup?orderHash=. null only on a record that never stored one.

Example:

"0x84a930f9e902ae9133b85e4e6c4bde91f2bdc2f0a8e1c9e7b5d6a4f3c2b1a0e9"

createdAt
string<date-time>
updatedAt
string<date-time>