Skip to main content
GET
Open positions

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"

Query Parameters

status
enum<string>
Available options:
open,
won,
lost,
voided,
all
limit
integer

Page size; omit to receive the full list.

Required range: 1 <= x <= 50
cursor
string

Opaque cursor from a prior nextCursor.

marketId
string

Scope positions to a single market symbol. Pushes the filter into the analytics build (SQL) so an event/market page does not recompute the whole wallet. Combine with status=all to include that market's resolved positions (Claim CTA). Wallet-wide stats (e.g. realizedPnl) are not meaningful when scoped and are reported as zero.

category
string

Vertical slug (canonical form, e.g. football) — narrows the position LIST to that vertical only, applied before pagination. Wallet-wide stats stay whole-wallet regardless. 400 invalid_category if the slug cannot round-trip through the canonical vertical vocabulary.

Response

200 - application/json

OK

walletAddress
string
required
filter
enum<string>
required

Which slice the positions array was narrowed to — echoes the ?filter= query parameter, defaulting to open.

Available options:
open,
won,
lost,
voided,
all
stats
object
required
positions
object[]
required
nextCursor
string | null
required

Opaque cursor for the next page — pass back verbatim as ?cursor=. null when no further pages.

hasMore
boolean
required

true when there is at least one more page after this one.