> ## 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. # Fetch a single match by slug > Public match detail is resolved by the canonical match slug. UUID-based public match URLs are not part of the API contract. 404 with `code=match_not_found` if the slug does not exist or has no public-status markets. ## OpenAPI ````yaml /api-reference/openapi.json get /api/matches/{slug} openapi: 3.1.0 info: title: PredictStreet API description: >- Client-facing HTTP API for the PredictStreet prediction-market platform. **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: 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: >- Public platform state: the contract registry, the platform fee configuration, the platform freeze flag and active notices. No authentication. paths: /api/matches/{slug}: get: tags: - Matches summary: Fetch a single match by slug description: >- Public match detail is resolved by the canonical match slug. UUID-based public match URLs are not part of the API contract. 404 with `code=match_not_found` if the slug does not exist or has no public-status markets. operationId: MatchesController_bySlug parameters: - name: slug in: path required: true description: Canonical match slug. schema: type: string 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: >- 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'). teamA: description: Home team. allOf: - $ref: '#/components/schemas/TeamRefDto' teamB: description: Away team. allOf: - $ref: '#/components/schemas/TeamRefDto' group: type: string nullable: true description: Group letter, only set when `stage` is `group`. tags: type: array items: $ref: '#/components/schemas/EventTagSummary' stage: type: string nullable: true enum: - group - r32 - r16 - quarter_finals - semi_finals - third_place - final - fifa_friendlies - ucl - uefa_europa_conference_league kickoffAt: type: string format: date-time nullable: true description: Scheduled kickoff. state: type: string description: >- Match publication state — `LIVE` for every match returned publicly. Not an in-play flag; use `live` for that. scheduleStatus: type: string enum: - SCHEDULED - POSTPONED - CANCELLED - PLAYED description: >- Rollup of the child events: CANCELLED > POSTPONED > PLAYED (all) > SCHEDULED. createdAt: type: string format: date-time updatedAt: type: string format: date-time events: type: array items: $ref: '#/components/schemas/MatchEvent' Error: type: object description: >- Error body returned by every API error (same shape as `ErrorEnvelope`). Branch on `error.code`, not on `message`. required: - status - error properties: status: type: integer description: HTTP status, repeated in the body. example: 404 error: type: object required: - code - message properties: code: type: string description: >- Machine-readable code (e.g. `market_not_found`, `event_not_found`, `invalid_limit`). message: type: string trace_id: type: string description: Request trace id; quote it to support. May be absent. retryAfterSec: type: integer description: >- Seconds to wait before retrying, when the server says so (also sent as the `Retry-After` header). retryable: type: boolean description: >- Whether the same request may be sent again as it is. Absent when the server does not say. details: type: object additionalProperties: true description: >- Extra structured context thrown with the error, e.g. `slug`, `allowed`, `auditId`. TeamRefDto: type: object properties: code: type: string description: FIFA 3-letter code (e.g. "BRA"). label: type: string description: >- Display name (e.g. "Brazil"). Falls back to the code when the code has no name mapping. logo: type: string nullable: true description: >- Club crest URL, or null. Null is normal for a national team: render the crest when present and fall back to a flag drawn from `code` only when it is null. required: - code - label - logo EventTagSummary: type: object description: >- Tag summary as embedded inside an Event. The richer Tag schema (with `isFeatured`) is returned by /api/tags. properties: slug: type: string description: URL-safe identifier; use as ?tag= 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 - fifa_friendlies - ucl - uefa_europa_conference_league teamA: description: Home team. allOf: - $ref: '#/components/schemas/TeamRefDto' teamB: description: Away team. allOf: - $ref: '#/components/schemas/TeamRefDto' tags: type: array items: $ref: '#/components/schemas/EventTagSummary' scheduledAt: type: string format: date-time nullable: true description: >- Scheduled start time of the event. For an event bound to a match this usually equals the match's `kickoffAt`, but may differ for partial-game props. 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: Id of the parent event. 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}` (sub-resources use `symbol`). Unique across 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: - PRE_MARKET - OPEN - PAUSED - POSTPONED - SUSPENDED - CLOSED - PENDING_RESOLUTION - DELAYED - DISPUTED - RESOLVED - VOIDED description: >- PRE_MARKET / OPEN / PAUSED / POSTPONED are the open set returned by default lists; the rest are post-trading states returned by detail lookups and `closed=true`. 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"]). feeTakerBps: type: integer nullable: true description: >- Per-fill taker fee rate in basis points (k × 10_000; peak fee at P=0.5 = feeTakerBps / 4 / 10_000). Null inherits the platform default rate. tradingWindow: description: >- Scheduled trading window: `preMarketStartsAt`, `opensAt`, `closesAt`. allOf: - $ref: '#/components/schemas/MarketTradingWindowDto' kickoff: type: string format: date-time nullable: true description: Real-world fixture kickoff time. resolutionWindowHours: type: integer nullable: true lifecycle: description: >- Actual lifecycle transition timestamps (`closedAt`, `pausedAt`, `resolvedAt`, `voidedAt`); each is null until that transition happens. allOf: - $ref: '#/components/schemas/MarketLifecycleDto' 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: type: string nullable: true description: >- Cost to buy per outcome, in outcome-index order: the best ask when the book has an offer, else the last trade; `null` when neither exists. Decimal string in USDC. For the implied probability (the mark) use `chances`. chances: type: array items: type: string description: >- The mark (implied probability) per outcome, in outcome-index order: the book midpoint when the book is two-sided and the spread is at most $0.10, else the last trade. `1/outcomeCount` per outcome before any trade. Never null. vertical: type: string nullable: true description: >- This market's vertical — the category axis verbatim (`football`, `tennis`, `crypto`, `politics`, …). Filter the catalog with `/api/events?vertical=`. example: crypto marketType: type: string nullable: true description: >- Canonical market type (`MATCH_WINNER_AET`, `CRYPTO_PRICE_EVENT`, …). Null for manual and legacy markets, including some older Up/Down windows — to detect a crypto market, branch on `crypto` / `cryptoWindow` instead. crypto: $ref: '#/components/schemas/MarketCryptoRule' cryptoWindow: $ref: '#/components/schemas/MarketCryptoWindow' MarketTradingWindowDto: type: object properties: preMarketStartsAt: type: string nullable: true description: >- ISO-8601 — when PRE_MARKET (post-only) trading opens. Active when `tradingMode === 'pre_market_post_only'`. NULL when the market has no pre-market window (jumps straight to OPEN). opensAt: type: string nullable: true description: >- ISO-8601 — when full OPEN trading starts (post-only flips to full matching). closesAt: type: string nullable: true description: ISO-8601 — trading cutoff after which orders are rejected. required: - preMarketStartsAt - opensAt - closesAt MarketLifecycleDto: type: object properties: closedAt: type: string nullable: true description: >- ISO-8601 — timestamp of the most-recent CLOSED transition. Preserved across DELAYED → CLOSED bounces (a market that moved through DELAYED → CLOSED again picks the second transition). Distinct from `resolvedAt` (terminal RESOLVED) — this is when trading was cut off. NULL for markets that have never been CLOSED (DRAFT through OPEN inclusive). pausedAt: type: string nullable: true description: >- ISO-8601 — last pause timestamp. NOT cleared on resume. Set only when admin explicitly paused (status PAUSED). Read this when `notTradableReason === 'paused'`; for SUSPENDED markets (`notTradableReason === 'suspended'`) this field reflects an earlier pause if any, NOT the suspension time — `deriveTradingMode` maps BOTH PAUSED and SUSPENDED to `tradingMode === 'paused'` but only PAUSED writes `paused_at`. resolvedAt: type: string nullable: true description: >- ISO-8601 — chain-RESOLVED timestamp (terminal). NULL if not resolved. voidedAt: type: string nullable: true description: >- ISO-8601 — chain-VOIDED timestamp (terminal). NULL if not voided. A market reaches exactly one terminal state (resolvedAt XOR voidedAt). required: - closedAt - pausedAt - resolvedAt - voidedAt MarketCryptoRule: type: object nullable: true description: >- Machine-readable price rule of a crypto market — the structured counterpart of the human `resolutionCriteria` text. Null on every non-crypto market. Present on BOTH long-dated crypto markets and Up/Down windows, so `crypto !== null` is the reliable "is this a crypto market" test. properties: productType: type: string description: >- Product vocabulary, passed through verbatim from the listing side — treat it as an open string so a newly enabled product needs no client change. In use today: `THRESHOLD_BY_DEADLINE`, `THRESHOLD_DURING_MONTH`, `CLOSE_ABOVE_AT_TIME`, `RANGE_BAND`, `NEW_ALL_TIME_HIGH`, `MONTH_OVER_MONTH_CLOSE`, `MONTHLY_CLOSE_ABOVE_STRIKE`, `RELATIVE_PERFORMANCE`, `BTC_DOMINANCE_AT_MONTH_END`, `TOTAL_CRYPTO_MARKET_CAP_AT_MONTH_END`, `MARKET_CAP_MILESTONE`, `RANK_MILESTONE`, `UP_DOWN_WINDOW`. example: THRESHOLD_BY_DEADLINE direction: type: string enum: - ABOVE - BELOW nullable: true description: >- Barrier direction. Always set on the touch products (`THRESHOLD_BY_DEADLINE`, `THRESHOLD_DURING_MONTH`). Products that only ask "above" (strike closes, month-end dominance / market cap, market-cap milestone) carry `ABOVE` or null. Null on every other product. targetPrice: type: string nullable: true description: >- The level as a canonical decimal string (never a float — a threshold must round-trip exactly): a price, a dominance percentage, a USD market cap or a rank, depending on the product. Null on level-less products and on `RANGE_BAND`, whose two bounds are only in `resolutionCriteria`. On a market that has one, the market `title` is the same digits. example: '64400' instrumentId: type: string nullable: true description: >- Price-catalog instrument. The key for `GET /api/markets/{symbol}/crypto-price-history` and for the `crypto_price_tick` WebSocket channel. Catalog: `BTC-USD`, `ETH-USD` (Chainlink), `BTC-DOM`, `TOTAL-MCAP`, `SOL-MCAP-USD`, `SOL-RANK` (CoinGecko). The price-history endpoint serves `BTC-USD`, `ETH-USD`, `BTC-DOM`, `TOTAL-MCAP` and `SOL-RANK`. example: BTC-USD benchmarkInstrumentId: type: string nullable: true description: >- `RELATIVE_PERFORMANCE` only — the instrument the asset is compared against. Null otherwise. deadlineAt: type: string format: date-time nullable: true description: >- Deadline products (`THRESHOLD_BY_DEADLINE`, `MARKET_CAP_MILESTONE`, `RANK_MILESTONE`) — observation cutoff (UTC). month: type: string nullable: true description: >- Monthly products only — `YYYY-MM`. The month runs midnight to midnight US Eastern time, not UTC. example: 2026-07 required: - productType - direction - targetPrice - instrumentId - benchmarkInstrumentId - deadlineAt - month MarketCryptoWindow: type: object nullable: true description: >- Short-crypto Up/Down window facts. Populated only on markets materialised from a crypto series window (which also carry `crypto` with `productType: UP_DOWN_WINDOW`); null on every other market, long-dated crypto markets included. properties: seriesId: type: string format: uuid description: Parent series — same id as `event.cryptoSeries.id`. windowStartAt: type: string format: date-time nullable: true description: Start of the economic window (UTC). windowEndAt: type: string format: date-time nullable: true description: >- End of the economic window (UTC). Equals the market's `tradingWindow.closesAt`. openPrice: type: string nullable: true description: >- The frozen open — the price the window's close is measured against. UNSCALED integer as a decimal string: render as `openPrice / 10 ** streamDecimals` with a bigint/decimal helper, never `Number()` (18 decimals exceeds `Number.MAX_SAFE_INTEGER`). Null until the oracle pins it (~45 s after `windowStartAt`) and on windows that have not started. Write-once — this is the value settlement binds. example: '63672459298735910000000' streamDecimals: type: integer nullable: true description: Exponent for `openPrice`. example: 18 openPriceIsFinal: type: boolean description: >- True once the pin exists. The pin is immutable, so an open that exists is already final. outcome: type: string enum: - UP - DOWN nullable: true description: >- Settled direction, once the market is RESOLVED. Null while a proposal is still challengeable — a proposed direction is not a settled one. `UP` is outcome index 0 (payouts `[1,0]`), `DOWN` index 1 (`[0,1]`). required: - seriesId - windowStartAt - windowEndAt - openPrice - streamDecimals - openPriceIsFinal - outcome ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.