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

# Health check

> Returns the health status of the API with detailed checks



## OpenAPI

````yaml openapi.json get /health
openapi: 3.1.0
info:
  title: Polyrouter API
  version: 2.0.0
  description: >-
    Unified API for prediction market platforms (Polymarket, Kalshi, Limitless,
    Manifold)
  contact:
    name: Polyrouter
    url: https://polyrouter.io
servers:
  - url: https://api-v2.polyrouter.io
    description: Production
security:
  - apiKey: []
tags:
  - name: Health
    description: Health check and API info
  - name: Markets
    description: Prediction market operations
  - name: Events
    description: Event operations
  - name: Series
    description: Series operations
  - name: Platforms
    description: Platform information
  - name: Search
    description: Search across platforms
  - name: Trades
    description: Historical trades data
  - name: Orderbook
    description: Orderbook data (real-time and historical)
  - name: Sports
    description: Sports betting markets - games, awards, futures, and league info
  - name: Profile
    description: User profiles, trading metrics, and trade history
paths:
  /health:
    get:
      tags:
        - Health
      summary: Health check
      description: Returns the health status of the API with detailed checks
      operationId: healthCheck
      responses:
        '200':
          description: API is healthy
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HealthResponse'
components:
  schemas:
    HealthResponse:
      type: object
      properties:
        data:
          type: object
          properties:
            status:
              type: string
              enum:
                - healthy
                - degraded
                - unhealthy
              example: healthy
            checks:
              type: array
              items:
                $ref: '#/components/schemas/HealthCheck'
            uptime:
              type: number
              example: 86400
            version:
              type: string
              example: 2.0.0
            timestamp:
              type: string
              format: date-time
          required:
            - status
            - checks
            - uptime
            - version
            - timestamp
        meta:
          type: object
          properties:
            request_time:
              type: number
              example: 50
          required:
            - request_time
      required:
        - data
        - meta
    HealthCheck:
      type: object
      properties:
        name:
          type: string
          example: database
        status:
          type: string
          enum:
            - pass
            - fail
            - warn
          example: pass
        response_time_ms:
          type: number
          example: 15
      required:
        - name
        - status
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: X-API-Key
      description: API key for authentication

````