> ## Documentation Index
> Fetch the complete documentation index at: https://docs.agg.market/llms.txt
> Use this file to discover all available pages before exploring further.

> ## Agent Instructions
> To integrate AGG, start with Quickstart: REST (https://docs.agg.market/quickstart/rest), then Order lifecycle & statuses (https://docs.agg.market/concepts/order-lifecycle).
> Track every trade until it reaches a terminal status. Before retrying a failed or timed-out call, read Errors, retries & idempotency (https://docs.agg.market/concepts/errors).
> The API reference is generated from https://docs.agg.market/openapi/openapi.json.

# Redeem winnings for resolved positions

> Claims a user's settled positions as USDC: winning shares, and split payouts such as a Polymarket 50/50. EVM venue redemptions need no user wallet prompt and complete asynchronously; listen for redeem_event on the WebSocket. Venues that settle on their own need no redeem call, and their positions report redeemStatus ineligible or redeemed.



## OpenAPI

````yaml /openapi/openapi.json post /execution/redeem
openapi: 3.0.2
info:
  title: AGG API
  version: 1.0.0
  description: >-
    Prediction market aggregator REST API — authentication, users, venue events,
    venue markets, orderbooks, charts, and execution workflows.
servers:
  - url: https://api.agg.market
    description: Production
security: []
tags:
  - name: Authentication
    description: Sign users in and manage their session tokens.
  - name: Markets
    description: Find events, markets and outcomes to trade.
  - name: Market Data
    description: Live orderbooks, prices, charts and scores for those markets.
  - name: Trading
    description: Quote, place, sign, track and cancel orders.
  - name: Portfolio
    description: A user's orders, positions, balances and activity.
  - name: Funding
    description: Deposit addresses, withdrawals, balance refills and fiat on-ramp.
  - name: Users
    description: The signed-in user's profile, linked accounts, KYC and venue keys.
  - name: Hosted Venue Accounts
    description: Provision, fund and withdraw from venue accounts hosted for the user.
  - name: Webhooks
    description: Configure and operate webhook delivery to your server.
  - name: Partner Admin
    description: Server-side reads across your app's users, orders and analytics.
  - name: Paper Trading
    description: Simulated accounts and orders for testing without real funds.
  - name: News
    description: News feeds linked to markets.
  - name: Correlated Markets
    description: Markets related to a given market and the effect of its resolution.
paths:
  /execution/redeem:
    post:
      tags:
        - Trading
      summary: Redeem winnings for resolved positions
      description: >-
        Claims a user's settled positions as USDC: winning shares, and split
        payouts such as a Polymarket 50/50. EVM venue redemptions need no user
        wallet prompt and complete asynchronously; listen for redeem_event on
        the WebSocket. Venues that settle on their own need no redeem call, and
        their positions report redeemStatus ineligible or redeemed.
      operationId: redeem
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - venueMarketOutcomeIds
              properties:
                venueMarketOutcomeIds:
                  minItems: 1
                  maxItems: 20
                  type: array
                  items:
                    type: string
                mode:
                  type: string
                  enum:
                    - live
                    - paper
      responses:
        '200':
          description: '200'
          content:
            application/json:
              schema:
                type: object
                required:
                  - redeemId
                  - results
                properties:
                  redeemId:
                    description: Id of this claim request.
                    type: string
                  results:
                    description: One result per outcome.
                    type: array
                    items:
                      type: object
                      required:
                        - venueMarketOutcomeId
                        - status
                        - callsId
                        - pendingUserOpId
                        - txHash
                        - reason
                      properties:
                        venueMarketOutcomeId:
                          description: Outcome whose winnings were claimed.
                          type: string
                        status:
                          description: >-
                            `submitted`: the claim was sent and will confirm
                            later. `confirmed`: the claim landed. `ineligible`:
                            this outcome cannot be claimed through AGG; see
                            `reason`. `rejected`: the claim was refused; see
                            `reason`.
                          type: string
                          enum:
                            - submitted
                            - confirmed
                            - ineligible
                            - rejected
                        callsId:
                          description: Reference for a submitted on-chain claim.
                          type: string
                          nullable: true
                        pendingUserOpId:
                          description: Id to track a submitted claim until it confirms.
                          type: string
                          nullable: true
                        txHash:
                          description: Claim transaction, when known at response time.
                          type: string
                          nullable: true
                        reason:
                          description: Readable reason for `ineligible` or `rejected`.
                          type: string
                          nullable: true
        '400':
          description: '400'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessage'
        '401':
          description: '401'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessage'
        '403':
          description: '403'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessage'
      security:
        - appId: []
          bearerAuth: []
components:
  schemas:
    ErrorMessage:
      type: object
      required:
        - message
      properties:
        message:
          type: string
  securitySchemes:
    appId:
      type: apiKey
      in: header
      name: x-app-id
      description: Your application ID. Required for all app-tier and user-tier routes.
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        JWT access token returned by POST /auth/verify. Required for user-tier
        routes.

````