> ## Documentation Index
> Fetch the complete documentation index at: https://docs.dotprediction.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Metrics Snapshot

> Returns a real-time snapshot of market metrics including volume, liquidity, spread, and competitive score.



## OpenAPI

````yaml GET /v1/api/metrics/snapshot
openapi: 3.1.0
info:
  title: Dot Prediction API
  description: >-
    A unified API for accessing prediction market data across Kalshi,
    Polymarket, and Limitless.
  version: 1.0.0
servers:
  - url: https://api.dotprediction.io
security:
  - apiKey: []
paths:
  /v1/api/metrics/snapshot:
    get:
      tags:
        - Metrics
      summary: Metrics snapshot
      description: >-
        Returns a real-time snapshot of market metrics including volume,
        liquidity, spread, and competitive score.
      operationId: getMetricsSnapshot
      parameters:
        - name: platform
          in: query
          required: true
          description: The platform to query.
          schema:
            type: string
            enum:
              - kalshi
              - polymarket
              - limitless
        - name: market_id
          in: query
          required: true
          description: The market ID.
          schema:
            type: string
      responses:
        '200':
          description: Market metrics snapshot.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MarketMetricsSnapshotResponse'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '429':
          $ref: 0d5813fe-a3df-4eee-bda5-8e01bfe0683a
        '500':
          $ref: 13256dda-f2cf-48d5-853d-eda20215fa08
components:
  schemas:
    MarketMetricsSnapshotResponse:
      type: object
      properties:
        market_id:
          type: string
        platform:
          type: string
        title:
          type: string
        status:
          type: string
        metrics:
          type: object
          properties:
            volume:
              type: object
              properties:
                total:
                  type: number
                volume_24h:
                  type: number
                volume_7d:
                  type: number
                volume_30d:
                  type: number
                volume_1y:
                  type: number
            liquidity:
              type: object
              properties:
                total:
                  type: number
                liquidity_score:
                  type: number
                clob_liquidity:
                  type: number
            open_interest:
              type: number
            notional_value:
              type: number
            spread:
              type: object
              properties:
                best_bid:
                  type: number
                best_ask:
                  type: number
                spread:
                  type: number
                adjusted_midpoint:
                  type: number
            fees:
              type: object
              properties:
                fee_rate:
                  type: number
                trading_fee:
                  type: number
                withdrawal_fee:
                  type: number
            competitive_score:
              type: number
            unique_traders:
              type: integer
        meta:
          type: object
          properties:
            platforms:
              type: array
              items:
                type: string
            request_time:
              type: integer
            cache_hit:
              type: boolean
            data_freshness:
              type: string
    ErrorResponse:
      type: object
      properties:
        error:
          type: object
          properties:
            status:
              type: integer
              description: HTTP status code.
            message:
              type: string
              description: Human-readable error message.
            resolution:
              type: string
              description: Suggested action to resolve the error.
            error_text:
              type: string
              description: Detailed error information.
  responses:
    BadRequest:
      description: Invalid request parameters.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    Unauthorized:
      description: Missing or invalid API key.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: X-API-Key
      description: >-
        API key for authentication. Generate one via the dashboard or the
        `/v1/api/auth/api-keys` endpoint.

````