> ## Documentation Index > Fetch the complete documentation index at: https://docs.testnet.dev.adipredictstreet.com/llms.txt > Use this file to discover all available pages before exploring further. # List matches > Returns all currently READY matches (the admin.matches aggregate that groups several events into a single 'card' — e.g. 'BRA vs ARG' wraps the 1X2 event + first-scorer event + over-under event). Each match nests its child events with their public-status markets. Empty matches (no public-status market on any child event) are filtered out. ## OpenAPI ````yaml /api-reference/openapi.json get /api/matches openapi: 3.1.0 info: title: PredictStreet core-api description: >- Client-facing HTTP gateway for the PredictStreet prediction-market platform. This spec is hand-written against the NestJS controllers and DTOs in core-api/src/modules/. For the source-of-truth live spec, run `./scripts/pull-openapi.sh` against a running core-api (NestJS exposes it at /api/docs-json). **Partner kinds.** Every authenticated endpoint 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.dev.predictstreet.sde.adifoundation.ai description: Testnet (partner integrator API — final domain TBD) 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: 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: >- admin.matches aggregate — 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 frontend (Privy JWT) 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. paths: /api/matches: get: tags: - Matches summary: List matches description: >- Returns all currently READY matches (the admin.matches aggregate that groups several events into a single 'card' — e.g. 'BRA vs ARG' wraps the 1X2 event + first-scorer event + over-under event). Each match nests its child events with their public-status markets. Empty matches (no public-status market on any child event) are filtered out. operationId: MatchesController_list parameters: - name: stage in: query required: false schema: type: string enum: - group - r32 - r16 - quarter_finals - semi_finals - third_place - final - name: tag in: query required: false description: Single tag slug, exact match. schema: type: string - name: from in: query required: false description: ISO-8601 lower bound on match.startTime. schema: type: string format: date-time - name: to in: query required: false description: ISO-8601 upper bound on match.startTime. schema: type: string format: date-time responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/MatchesListRespDto' type: object properties: matches: type: array items: $ref: '#/components/schemas/Match' security: - {} components: schemas: MatchesListRespDto: type: object properties: matches: type: array items: $ref: '#/components/schemas/PublicMatchSummaryDto' required: - matches PublicMatchSummaryDto: type: object properties: id: type: string slug: type: string title: type: string participantA: type: object nullable: true participantB: type: object nullable: true tags: type: array items: $ref: '#/components/schemas/MatchEventTagSummaryDto' stage: type: object nullable: true description: Knockout stage (group/r16/.../final). startTime: type: object nullable: true description: ISO-8601 match start. state: type: string description: >- Match aggregate state — currently always `READY` (only state surfaced publicly). createdAt: type: string updatedAt: type: string events: type: array items: $ref: '#/components/schemas/PublicMatchEventSummaryDto' required: - id - slug - title - participantA - participantB - tags - stage - startTime - state - createdAt - updatedAt - events MatchEventTagSummaryDto: type: object properties: slug: type: string name: type: string color: type: object nullable: true iconUrl: type: object nullable: true required: - slug - name - color - iconUrl PublicMatchEventSummaryDto: type: object properties: id: type: string slug: type: string title: type: string group: type: object nullable: true stage: type: object nullable: true teamA: type: object nullable: true description: Home FIFA code. teamB: type: object nullable: true description: Away FIFA code. tags: type: array items: $ref: '#/components/schemas/MatchEventTagSummaryDto' eventStartTime: type: object nullable: true description: ISO-8601 event start. volume24h: type: string description: Aggregate matched notional, last 24h (decimal string). totalVolume: type: string description: Aggregate matched notional, all-time (decimal string). createdAt: type: string updatedAt: type: string markets: type: array items: type: object additionalProperties: true description: >- Public market projections (same shape as `/markets/:symbol`). See MarketSummaryDto in the Markets tag for the field-level reference. required: - id - slug - title - group - stage - teamA - teamB - tags - eventStartTime - volume24h - totalVolume - createdAt - updatedAt - markets ````