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

# Orderbook snapshot

> Aggregated top-of-book levels per outcome. For real-time updates use the `orderbook` WebSocket channel — polling this endpoint is rate-limited.



## OpenAPI

````yaml /api-reference/openapi.json get /api/markets/{symbol}/orderbook
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/markets/{symbol}/orderbook:
    get:
      tags:
        - Markets
      summary: Orderbook snapshot
      description: >-
        Aggregated top-of-book levels per outcome. For real-time updates use the
        `orderbook` WebSocket channel — polling this endpoint is rate-limited.
      operationId: MarketsController_orderbook
      parameters:
        - $ref: '#/components/parameters/MarketSymbol'
        - name: outcome
          in: query
          required: false
          schema:
            type: string
        - name: depth
          in: query
          required: false
          schema:
            type: integer
            default: 20
            maximum: 50
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OrderbookSnapshot'
      security:
        - {}
components:
  parameters:
    MarketSymbol:
      name: symbol
      in: path
      required: true
      description: >-
        Market symbol, e.g. `UAE-CUP-FINAL-20260425`. Used by sub-resource
        endpoints (`/orderbook`, `/trades`, `/ohlc`, `/traders`). The root
        market-detail endpoint `/api/markets/{slug}` accepts the slug instead —
        see `MarketSlug`.
      schema:
        type: string
  schemas:
    OrderbookSnapshot:
      type: object
      properties:
        symbol:
          type: string
        seq:
          type: integer
        bids:
          type: array
          items:
            $ref: '#/components/schemas/OrderbookLevel'
        asks:
          type: array
          items:
            $ref: '#/components/schemas/OrderbookLevel'
    OrderbookLevel:
      type: object
      properties:
        price:
          $ref: '#/components/schemas/DecimalString'
        quantity:
          $ref: '#/components/schemas/DecimalString'
    DecimalString:
      type: string
      description: >-
        Decimal number encoded as a string to preserve precision (e.g.
        `'100.5'`).

````