> ## Documentation Index > Fetch the complete documentation index at: https://docs.adipredictstreet.com/llms.txt > Use this file to discover all available pages before exploring further. # Current auto-redeem opt-out state > Default `enabled=true`: the platform redeems your vault's positions on finished markets on your behalf, pays the gas and credits the payout to your vault — the refund on a voided market, and your winnings on a resolved market when they pay at least 1 USDC in total on that market. It checks every minute, so a position is normally redeemed within a few minutes of the market's final status. Winnings under 1 USDC are not redeemed automatically — claim them with `POST /api/me/positions/redeem`. An account that is paused or under another restriction is skipped until the restriction is lifted. With `enabled=false` nothing is redeemed automatically; use `POST /api/me/positions/redeem`. ## OpenAPI ````yaml /api-reference/openapi.json get /api/me/auto-redeem openapi: 3.1.0 info: title: PredictStreet API description: >- Client-facing HTTP API for the PredictStreet prediction-market platform. **Partner kinds.** Every authenticated endpoint except the partner-level platform reads (`/api/platform/status`, `/notices`, `/maintenance`) resolves a request's *effective wallet* from the partner row. `single_wallet` partners bind to one `associatedWallet` set at creation. `multi_wallet` partners declare the actor on every request via an `X-User-Wallet: 0x<40-hex>` header. See the [Partner kinds](/auth/api-keys#partner-kinds) doc for the full contract. version: '2026-06-16' contact: name: PredictStreet partners email: partners@predictstreet.com servers: - url: https://core-api.adipredictstreet.com description: Production — replace with the API host issued at partner onboarding. security: [] tags: - name: Deposits description: >- Gasless USDC deposit relay - submit a signed EIP-2612 permit and the platform broadcasts the on-chain deposit for you (no gas). - name: Events description: >- Polymarket-style event grouping with football metadata (group, stage, teams, tags). - name: Tags description: Curated tag taxonomy used to filter events. - name: Markets description: 'Public market data: list, detail, orderbook, trades, OHLC.' - name: Crypto description: >- Crypto price markets: the underlying-asset price curve and Up/Down series navigation. The markets themselves are ordinary binary markets — list them through /api/markets and /api/events. - name: Orders description: >- Signed-order place / cancel / read. Requires `X-Api-Key` with `orders:read` / `orders:write` scope; every write additionally requires an EIP-712 signature over the order. - name: Portfolio description: >- Balances, positions, trades, fees, vault info for the key's `associatedWallet`. Requires `X-Api-Key` with `portfolio:read` scope. - name: Matches description: >- A match groups several events into one fixture/card (1X2 + first-scorer + over-under under one matchup). - name: Vault description: >- Backend co-signatures for ERC-1155 split / merge, and recovery for off-chain locks when the corresponding chain tx never confirmed. Requires `X-Api-Key` with `vault:write` scope plus an EIP-712 signature over the operation. - name: Leaderboard description: Public ranked leaderboard across PnL / volume buckets. - name: Search description: Global search across users, events, and matches. - name: Withdrawal Security description: >- Self-service withdrawal 2FA (TOTP) and withdrawal-address whitelist. Same endpoints serve the web app (user sessions) and API-key integrators. Mutations need `vault:write`, reads `portfolio:read`. Both are opt-in per wallet and only gate withdrawals once the platform enables withdrawal-security enforcement. - name: Platform description: >- Platform reference data and state. The contract registry and the fee configuration are public and need no key. The freeze flag (`/status`), active notices (`/notices`) and maintenance windows (`/maintenance`) need a partner API key in `X-Api-Key`. paths: /api/me/auto-redeem: get: tags: - Portfolio summary: Current auto-redeem opt-out state description: >- Default `enabled=true`: the platform redeems your vault's positions on finished markets on your behalf, pays the gas and credits the payout to your vault — the refund on a voided market, and your winnings on a resolved market when they pay at least 1 USDC in total on that market. It checks every minute, so a position is normally redeemed within a few minutes of the market's final status. Winnings under 1 USDC are not redeemed automatically — claim them with `POST /api/me/positions/redeem`. An account that is paused or under another restriction is skipped until the restriction is lifted. With `enabled=false` nothing is redeemed automatically; use `POST /api/me/positions/redeem`. operationId: AutoRedeemController_get parameters: - $ref: '#/components/parameters/UserWalletHeader' responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/AutoRedeemStateDto' security: - ApiKey: - portfolio:read components: parameters: UserWalletHeader: name: X-User-Wallet in: header required: false description: >- **Required for `multi_wallet` partners on every authenticated request; ignored for `single_wallet`.** Declares the acting end-user wallet for this request — drives KYC checks, balances/positions/orders attribution, rate-limit buckets, and audit. Lower-cased server-side. Missing on a multi_wallet key → 401 `api_key_user_wallet_required`; malformed → 401 `api_key_user_wallet_invalid`. The on-chain `CTFExchange`/`Vault` contracts still verify EIP-712 signer ↔ vault binding, so loosening API-layer attribution is safe by construction. schema: $ref: '#/components/schemas/EthereumAddress' example: '0x1234567890abcdef1234567890abcdef12345678' schemas: AutoRedeemStateDto: type: object properties: enabled: type: boolean description: >- Your auto-redeem setting (default `true`). `true` = the platform redeems your positions on finished markets on your behalf (see `GET /api/me/auto-redeem`); `false` = opted out. updatedAt: type: string format: date-time nullable: true description: >- ISO-8601 — time of the last `PUT /api/me/auto-redeem`. null if it was never called. required: - enabled - updatedAt EthereumAddress: type: string pattern: ^0x[a-fA-F0-9]{40}$ example: '0x742d35Cc6634C0532925a3b844Bc9e7595f0bEb3' securitySchemes: ApiKey: type: apiKey in: header name: X-Api-Key description: >- Partner / integrator key — format `ps_live__`. Partner keys are issued by PredictStreet; a user can also create keys bound to their own wallet from their account settings in the web app. Never ship to a browser. `multi_wallet` partners must additionally send `X-User-Wallet: 0x<40-hex>` on every authenticated request to declare the acting wallet. See the [API keys guide](/auth/api-keys) for scope taxonomy, partner kinds, rate limits, and rotation procedure. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.