Skip to main content
POST
Claim a settled position without paying gas

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"

Body

application/json
marketId
string
required

Market identifier of the position to redeem — the marketId field from the Position payload (GET /api/me/positions).

Required string length: 1 - 128
Example:

"PM-WC26-R16-USA-WC26-1910V2"

outcomeIndex
number
required

Outcome index of the held position (0 = YES, 1 = NO). For binary markets this scopes the CTF indexSets bitmask to the single side the user holds; for neg-risk it only disambiguates which Position row to read (the adapter burns both sides in one call regardless).

Required range: 0 <= x <= 255
Example:

0

auth
object

Owner-signed RedeemAuthorization. REQUIRED for API-key (partner) callers; IGNORED for web-app session (retail) callers (the session binds the wallet already). See RedeemAuthDto.

Response

200 - application/json
jobId
string
required

Submission job id (decimal string). Polling key.

Example:

"4210"

status
string
required

Live job status: pending | building | submitted | confirmed | failed_permanent | expired.

Example:

"pending"