> ## 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.

# Get match by id

> 404 with `code=match_not_found` if the id does not exist or has no public-status markets.



## OpenAPI

````yaml /api-reference/openapi.json get /api/matches/{id}
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/{id}:
    get:
      tags:
        - Matches
      summary: Get match by id
      description: >-
        404 with `code=match_not_found` if the id does not exist or has no
        public-status markets.
      operationId: MatchesController_byId
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
            format: uuid
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Match'
        '404':
          description: match_not_found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
        - {}
components:
  schemas:
    Match:
      type: object
      description: >-
        admin.matches aggregate — a single fixture/card that groups several
        related events (e.g. 1X2, first-scorer, over-under) under one matchup.
      properties:
        id:
          type: string
          format: uuid
        slug:
          type: string
        title:
          type: string
          description: Short matchup label (e.g. 'BRA vs ARG').
        participantA:
          type: string
          nullable: true
        participantB:
          type: string
          nullable: true
        tags:
          type: array
          items:
            $ref: '#/components/schemas/EventTagSummary'
        stage:
          type: string
          nullable: true
          enum:
            - group
            - r32
            - r16
            - quarter_finals
            - semi_finals
            - third_place
            - final
        startTime:
          type: string
          format: date-time
          nullable: true
        state:
          type: string
          description: >-
            Lifecycle state from admin.matches.state — typically READY for
            everything surfaced publicly.
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
        events:
          type: array
          items:
            $ref: '#/components/schemas/MatchEvent'
    Error:
      type: object
      required:
        - code
      properties:
        code:
          type: string
          description: >-
            Machine-readable code (e.g. `insufficient_funds`, `market_not_open`,
            `rate_limited`).
        message:
          type: string
        details:
          type: object
          additionalProperties: true
    EventTagSummary:
      type: object
      description: >-
        Tag summary as embedded inside an Event. The richer Tag schema
        (sortOrder, isFeatured) is returned by /api/tags.
      properties:
        slug:
          type: string
          description: URL-safe identifier; use as ?tag=<slug> on /api/events.
        name:
          type: string
          description: Human-readable label.
        color:
          type: string
          nullable: true
        iconUrl:
          type: string
          format: uri
          nullable: true
    MatchEvent:
      type: object
      description: >-
        Event nested under a Match. Same field set as Event, modulo no createdBy
        and no parent match wiring (a MatchEvent always belongs to one match).
      properties:
        id:
          type: string
          format: uuid
        slug:
          type: string
        title:
          type: string
        group:
          type: string
          nullable: true
        stage:
          type: string
          nullable: true
          enum:
            - group
            - r32
            - r16
            - quarter_finals
            - semi_finals
            - third_place
            - final
        teamA:
          type: string
          nullable: true
        teamB:
          type: string
          nullable: true
        tags:
          type: array
          items:
            $ref: '#/components/schemas/EventTagSummary'
        eventStartTime:
          type: string
          format: date-time
          nullable: true
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
        markets:
          type: array
          items:
            $ref: '#/components/schemas/MarketSummary'
    MarketSummary:
      type: object
      description: >-
        Public shape of a market. Returned by /api/markets, /api/markets/{slug},
        and as the markets[] array on Event / Match responses.
      properties:
        id:
          type: string
          format: uuid
        eventId:
          type: string
          format: uuid
          description: Parent admin.events row.
        symbol:
          type: string
          description: >-
            Operator-facing identifier (e.g. `M1V1-RMA-MCI-959311`). Used by
            sub-resource endpoints (`/orderbook`, `/trades`, `/ohlc`,
            `/traders`).
        slug:
          type: string
          description: >-
            Canonical URL-safe slug, lowercased kebab-case derived from
            `event.slug` + `groupItemTitle` + `title`. Required for the root
            market-detail endpoint `GET /api/markets/{slug}` (2026-05-16
            breaking change; sub-resources still use `symbol`). Unique across
            `admin.markets`.
        title:
          type: string
          description: >-
            Human-readable market title (matches the parent event title for
            single-market events).
        groupItemTitle:
          type: string
          nullable: true
          description: >-
            Per-market label inside a multi-market event accordion
            (Polymarket-style). Null when the market is its own event.
        conditionId:
          type: string
          nullable: true
          description: >-
            On-chain ConditionalTokens condition id (bytes32 hex). Null until
            the deployment is confirmed.
        questionId:
          type: string
          nullable: true
          description: On-chain question id (bytes32 hex).
        yesTokenId:
          type: string
          nullable: true
          description: >-
            ERC-1155 position id of the YES outcome (uint256, decimal string).
            Use for EIP-712 order signing on binary markets.
        noTokenId:
          type: string
          nullable: true
          description: ERC-1155 position id of the NO outcome. Null for non-binary markets.
        status:
          type: string
          enum:
            - DRAFT
            - PROPOSED
            - PRE_MARKET
            - OPEN
            - PAUSED
            - SUSPENDED
            - CLOSED
            - PENDING_RESOLUTION
            - DELAYED
            - DISPUTED
            - RESOLVED
            - VOIDED
            - CANCELLED
        currentReviewRound:
          type: integer
        outcomeCount:
          type: integer
        outcomeLabels:
          type: array
          items:
            type: string
          description: >-
            Outcome labels in fixed order (e.g. ["YES","NO"] or ["Real
            Madrid","Draw","Barcelona"]).
        initialFairValue:
          $ref: '#/components/schemas/DecimalString'
          description: >-
            Single-number seed for binary AMMs. Use initialOutcomePrices for
            multi-outcome.
        initialOutcomePrices:
          type: array
          items:
            $ref: '#/components/schemas/DecimalString'
          description: >-
            Per-outcome initial price, parallel to outcomeLabels. Sums to ~1.0.
            Polymarket-equivalent of outcomePrices.
        feeTakerBps:
          type: integer
          nullable: true
          description: >-
            Per-fill taker fee (k × BPS_DIVISOR; peak fee at P=0.5 = feeTakerBps
            / 4 / 10_000). Null inherits from PlatformFeeConfig.
        opensAt:
          type: string
          format: date-time
          nullable: true
        closesAt:
          type: string
          format: date-time
          nullable: true
        kickoff:
          type: string
          format: date-time
          nullable: true
          description: Real-world fixture kickoff time (mirrors event.eventStartTime).
        resolutionWindowHours:
          type: integer
          nullable: true
        pausedAt:
          type: string
          format: date-time
          nullable: true
        resolvedAt:
          type: string
          format: date-time
          nullable: true
        payoutNumerators:
          nullable: true
          description: >-
            Per-outcome payout vector (set on resolve). Null for unresolved
            markets.
        officialDataSource:
          type: string
          nullable: true
        sourceMatchId:
          type: string
          nullable: true
          description: >-
            External fixture identifier (StatsPerform / API-Football / etc.)
            used by the oracle.
        resolutionCriteria:
          type: string
          nullable: true
          description: >-
            Plain-text criteria for settlement. Use resolutionCriteriaUrl on
            Event for the full complete write-up if needed.
        negRiskEligible:
          type: boolean
          description: True if this market is part of a negRisk multi-outcome group.
        isNewMarketType:
          type: boolean
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
        outcomePrices:
          type: array
          items:
            $ref: '#/components/schemas/DecimalString'
          description: >-
            Last-trade price per outcome (parallel to `outcomes`). Decimal
            string in USDC.
    DecimalString:
      type: string
      description: >-
        Decimal number encoded as a string to preserve precision (e.g.
        `'100.5'`).

````