Claim winnings

Some venues pay a settled position on their own. Others need a claim, and sufwan-local-test makes that claim for you by default. POST /execution/redeem claims the user's managed positions as USDC on demand. It needs no wallet prompt.

Automatic or manual, by venueCopy Anchor Link

Self-custody positions on Polymarket, Limitless, Predict and Myriad are redeemed with redeemSelfCustody (see Self-custody). This becomes available once sufwan-local-test enables it on the platform; until then the fill is refused with quote_self_custody_redeem_unsupported. On Polymarket it works only for shares in the user's Polymarket deposit wallet. On other venues the user claims them on the venue.

Opting out of automatic claims. Automatic claiming covers Polymarket, Limitless, Predict and Myriad, and is on for every app by default. To claim on your own schedule instead, turn off Settings → Auto-redeem winning positions in the sufwan-local-test dashboard, then use the steps below. Self-custody positions are never claimed automatically.

You do not need this table at run time. Read redeemStatus on each position instead.

1. Find claimable positionsCopy Anchor Link

GET /execution/positions returns one group per market. Claim the groups whose redeemStatus is eligible, using the winning outcome ids in venueBreakdown.

const positions = await client.getExecutionPositions();
const outcomeIds = positions.data
  .filter((p) => p.redeemStatus === "eligible")
  .flatMap((p) => p.venueMarket.venueMarketOutcomes)
  .filter((o) => o.winner === true)
  .flatMap((o) => o.venueBreakdown.map((leg) => leg.venueMarketOutcomeId));

Get user positions

A split or void can mark more than one outcome as a winner. Read Market resolution & voids before you show an amount.

2. RedeemCopy Anchor Link

if (outcomeIds.length > 0) {
  const { redeemId, results } = await client.redeem({ venueMarketOutcomeIds: outcomeIds });
  for (const r of results) console.log(redeemId, r.venueMarketOutcomeId, r.status, r.reason);
}

Redeem winnings for resolved positions

Send x-app-id and the user's access token. Send 1 to 20 ids per call. mode (live or paper) is optional and defaults to live. Claims, paper included, are refused with 403 and code: "geo_blocked" where your app's or the platform's region list blocks the user. The check is the same for every venue.

A 4xx means no claim started. After a timeout or 5xx, some outcomes may have been submitted: they are claimed one at a time. The claim shows in GET /users/activity?type=redeem before anything is sent on-chain. Resending the same ids is safe and is how you find out. An outcome already being claimed returns rejected with redeem in progress, and one already paid returns ineligible with already redeemed. A position is never paid twice.

3. Read the resultCopy Anchor Link

The call returns before an on-chain claim finishes. Each results[] entry has a status and a reason:

To see completion, read positions again until redeemStatus is redeemed, or listen for redeem_event on the WebSocket.

RelatedCopy Anchor Link

• Market resolution & voids
• Portfolio
• Execution