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

# Get Health

> Health check endpoint that returns the API status



## OpenAPI

````yaml GET /health
openapi: 3.1.0
info:
  title: Bestflow API
  description: >-
    Bestflow is a cryptocurrency exchange aggregator that provides cross-chain
    swap capabilities without any additional fees. It aggregates multiple
    exchanges to offer users the best rates and seamless cryptocurrency swaps
    across different networks.
  license:
    name: MIT
  version: 1.0.0
servers:
  - url: https://api.bestflow.xyz
security:
  - {}
  - bearerAuth: []
paths:
  /health:
    get:
      description: Health check endpoint that returns the API status
      responses:
        '200':
          description: API is running
          content:
            application/json:
              schema:
                type: object
                required:
                  - status
                properties:
                  status:
                    type: string
                    example: ok
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '503':
          $ref: '#/components/responses/ServiceUnavailableError'
components:
  responses:
    UnauthorizedError:
      description: Invalid or unknown API key
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: UNAUTHORIZED
            message: Invalid API key
    ServiceUnavailableError:
      description: Auth dependency unavailable
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: SERVICE_UNAVAILABLE
            message: Auth service unavailable
  schemas:
    Error:
      type: object
      required:
        - error
        - message
      properties:
        error:
          type: string
          description: Error code
          enum:
            - VALIDATION_ERROR
            - INVALID_FORMAT
            - UNKNOWN_EXCHANGE
            - SWAP_ERROR
            - SWAP_NOT_FOUND
            - UNAUTHORIZED
            - RATE_LIMITED
            - SERVICE_UNAVAILABLE
        message:
          type: string
          description: Human-readable error message
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        Optional Bearer authentication using an API key provided as a Bearer
        token. Required for unlimited requests and revenue sharing.

````