Claim winnings

Some venues pay a settled position on their own. Others need a claim. POST /execution/redeem claims the user’s managed positions as USDC. It needs no wallet prompt.

Automatic or manual, by venue

Venue	Claim
Polymarket, Limitless, Predict, Myriad	Manual. Call `POST /execution/redeem`.
Kalshi, Hyperliquid, BetDEX, TipRun, PRED	Automatic. No call.
ProphetX direct accounts	Automatic, in the user’s own ProphetX account.
Opinion, Probable, Novig, ProphetX clearinghouse	No claim through AGG. The call returns `ineligible`.

Self-custody positions are never claimed through AGG. The user claims them on the venue. You do not need this table at run time. Read redeemStatus on each position instead.

1. Find claimable positions

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));

curl -s https://api.agg.market/execution/positions \
  -H "x-app-id: $AGG_APP_ID" -H "Authorization: Bearer $ACCESS_TOKEN" \
  | jq '[.data[] | select(.redeemStatus == "eligible") | .venueMarket.venueMarketOutcomes[]
         | select(.winner == true) | .venueBreakdown[].venueMarketOutcomeId]'

Get user positions

`redeemStatus`	Meaning
`eligible`	Claim it.
`pending`	A claim is in progress. Wait.
`redeemed`	Paid. Nothing to do.
`ineligible`	Nothing to claim through AGG: not settled yet, lost, settled by the venue, or self-custody.

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

2. Redeem

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);
}

curl -s -X POST https://api.agg.market/execution/redeem \
  -H "x-app-id: $AGG_APP_ID" -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H "content-type: application/json" \
  -d '{ "venueMarketOutcomeIds": ["OUTCOME_ID"] }'

Redeem winnings for resolved positions Send x-app-id and the user’s access token. mode (live or paper) is optional and defaults to live. Live claims are refused with 403 where trading is not available in the user’s region.

3. Read the result

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

`status`	Meaning	What to do
`submitted`	The claim is on its way.	Wait for completion (below).
`confirmed`	Done, or nothing was owed.	Nothing.
`ineligible`	Not claimable now. `reason` says why, for example `market not resolved`, `market winner not yet available`, `already redeemed`, or `venue ... does not support redeem`.	Retry later only for the first two.
`rejected`	Refused. `reason` says why, for example `not owned by user or unknown id`, `redeem in progress`, or `position reserved for execution`.	Fix the id, or retry after the other claim or sell finishes.

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

Start here

Core concepts

Account

Trading

Venues

Market data

Security

Real-time

Webhooks

Your users

UI Kit

Releases

Automatic or manual, by venue

1. Find claimable positions

2. Redeem

3. Read the result

​Automatic or manual, by venue

​1. Find claimable positions

​2. Redeem

​3. Read the result

​Related

Automatic or manual, by venue

1. Find claimable positions

2. Redeem

3. Read the result

Related