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

# Health check

> Returns the health status of the API, including database connectivity and uptime.



## OpenAPI

````yaml GET /v1/api/health
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/health:
    get:
      tags:
        - Infrastructure
      summary: Health check
      description: >-
        Returns the health status of the API, including database connectivity
        and uptime.
      operationId: healthCheck
      responses:
        '200':
          description: Service health status.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HealthResponse'
        '401':
          $ref: '#/components/responses/Unauthorized'
components:
  schemas:
    HealthResponse:
      type: object
      properties:
        status:
          type: string
          description: Overall health status.
        checks:
          type: array
          items:
            type: object
            properties:
              name:
                type: string
              status:
                type: string
          description: Individual health checks (e.g., database).
        uptime_seconds:
          type: number
          description: API uptime in seconds.
        version:
          type: string
          description: API version.
    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:
    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.

````