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

# Health Check

> GET /health returns the Vulcx API status with no API key required — poll it to monitor uptime and alert on non-200 responses in production.



## OpenAPI

````yaml GET /health
openapi: 3.1.0
info:
  title: Vulcx API
  description: >-
    Swap aggregator API on Fogo. Get quotes, build swap transactions, and
    retrieve raw instructions for multi-hop token swaps across Vortex, Fluxbeam,
    Fogo.fun, and Moonit.
  version: 1.0.0
  contact:
    name: Vulcx
    url: https://vulcx.finance
servers:
  - url: https://api.vulcx.xyz
    description: Production
security:
  - ApiKeyHeader: []
  - ApiKeyQuery: []
paths:
  /health:
    get:
      tags:
        - Health
      summary: Health check
      description: >-
        Returns service health status. Does not require an API key — safe for
        uptime monitors.
      operationId: healthCheck
      responses:
        '200':
          description: Service is healthy
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    example: ok
                required:
                  - status
      security: []
components:
  securitySchemes:
    ApiKeyHeader:
      type: http
      scheme: bearer
      description: >-
        API key sent as `Authorization: Bearer vulcx_...`. Required on every
        endpoint except `GET /health` and `GET /api/v1/tokens`.
    ApiKeyQuery:
      type: apiKey
      in: query
      name: key
      description: >-
        API key as a `?key=vulcx_...` query parameter — the only option for the
        WebSocket stream (`GET /api/v1/stream`), since browsers can't set custom
        headers on a WS handshake. Also accepted on REST endpoints as a fallback
        to the `Authorization` header.

````

## Related topics

- [Introduction to Vulcx — best-price swaps on Fogo](/get-started/introduction.md)
- [Changelog](/updates/index.md)
- [Vulcx API reference — quote, swap & instructions](/api-reference/introduction.md)
- [Handling Errors](/guides/handling-errors.md)
- [Vulcx FAQ — Fogo swaps, chains, fees & limits](/get-started/faq.md)