API ReferenceMarketsMarket Groups

Redeem a full NO set for cash

Burn k NO shares in EVERY member and credit k·(N−1)·$1. Exactly one member wins, so a full NO set is a guaranteed claim on the N−1 losers — redeeming it early is a partial settlement drawn from the settlement pool. Behind MARKET_GROUP_CONVERSION_ENABLED.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

group_idstringRequiredformat: "uuid"

Headers

X-API-Keystring or nullOptional
Idempotency-KeystringOptional<=255 characters
Client-supplied key that makes this unsafe mutation retry-safe. Reusing a key with the same request replays the original result (the response then carries Idempotency-Replayed: true); reusing it with a different request returns 409. Optional but strongly recommended so a network retry cannot double-apply.

Request

This endpoint expects an object.
setsdouble or string or nullOptional

Sets to redeem; floored to whole cents. Omit to redeem the full holding.

Response

Successful Response
amount_creditedstringformat: "^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$"
group_idstringformat: "uuid"
members_reducedlist of objects
sets_redeemedstringformat: "^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$"

Errors

401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
409
Conflict Error
422
Unprocessable Entity Error
429
Too Many Requests Error
500
Internal Server Error