During development, you can use the developer endpoints
without an API key. For production use, you’ll need an
API key to avoid rate limits.
Check if Outcome Token is Redeemable
Use the
/api/v1/market/by-mint/{mint_address} endpoint to fetch market details and verify that the outcome token is redeemable. A token is redeemable when:- The market status is
"determined"or"finalized" - The redemption status for the settlement mint is
"open" - Either:
- The market result (
"yes"or"no") matches the user’s outcome token (the outcome mint must match theyesMintornoMintfor the determined side), OR - The market result is empty (
"") andscalarOutcomePctis defined (rare edge case - see note below)
- The market result (
Edge Case: Scalar Outcome PayoutsIn rare cases, a market may have
redemptionStatus = "open" but result = "" (no result defined). In this scenario, use scalarOutcomePct to determine the payout:scalarOutcomePctrepresents the payout percentage for YES tokens in basis points (0-10000, where 10000 = 100%)- YES token payout =
scalarOutcomePct / 10000 - NO token payout =
(10000 - scalarOutcomePct) / 10000
scalarOutcomePct = 5000, then:- YES tokens redeem for 50% (5000/10000 = 0.5)
- NO tokens redeem for 50% ((10000-5000)/10000 = 0.5)
Check Redemption Eligibility
Check Redemption Eligibility
Request Redemption Order
Use the Trade API
/order endpoint to request a redemption order. The redemption is treated as a trade where you swap your outcome token for the settlement stablecoin.Request Redemption Order
Request Redemption Order
Determine Event Outcome
Wait for the settlement authority to write the outcome into the
Market Ledger. You cannot redeem until the outcome is determined.

Check Outcome Status
Check Outcome Status
Fund Outcome
Wait for the settlement authority to fund redemption by moving
stablecoins from the Settlement Vault to the Redemption Vault.

Check Redemption Funding
Check Redemption Funding
Request Redemption Order
Redeem your expired outcome tokens into the settlement
stablecoin using the Trade API.

Request Redemption Order
Request Redemption Order
Sign and Submit the Transaction
Submit the redemption order transaction so the Trade API can execute the
payout onchain.
Sign and Submit the Transaction
Sign and Submit the Transaction