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

# Health check

> Returns service health and version metadata.



## OpenAPI

````yaml https://statistics.1up.vision/openapi.json get /
openapi: 3.1.0
info:
  title: Vision Stats API
  version: 1.0.0
  description: >-
    REST API for accessing Twitch streamer analytics, stream summaries, partner
    data, and events. All endpoints are read-only and powered by Cloudflare
    Workers + Hyperdrive.
  contact:
    name: Vision Stats
    url: https://1up.vision
servers:
  - url: http://localhost:8787
    description: Local development
security:
  - BearerAuth: []
tags:
  - name: Meta
    description: Operational endpoints
  - name: Streamer
    description: Streamer level information
  - name: Streams
    description: Individual stream analytics
  - name: Leaderboard
    description: Aggregated leaderboards
  - name: Partners
    description: Sponsor and partner information
  - name: Events
    description: Public events
paths:
  /:
    get:
      tags:
        - Meta
      summary: Health check
      description: Returns service health and version metadata.
      responses:
        '200':
          description: API is reachable
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HealthResponse'
        '401':
          description: Missing or invalid bearer token
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '429':
          description: Rate limited
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security: []
components:
  schemas:
    HealthResponse:
      type: object
      properties:
        status:
          type: string
        version:
          type: string
      required:
        - status
        - version
      additionalProperties: true
    ErrorResponse:
      type: object
      properties:
        error:
          type: string
      required:
        - error
      additionalProperties: false
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: Token
      description: >-
        Optional bearer token enforced when the Worker is configured with an API
        token.

````