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

# Health check

> Checks the health status of the API and its dependencies including database connections and cache availability.



## OpenAPI

````yaml https://api.vaults.fyi/v2/documentation/json get /v2/health
openapi: 3.0.3
info:
  title: Vaults.fyi API
  version: 2.0.0
  description: >-
    The Vaults.fyi V2 API offers a streamlined, better structured, and more
    performant interface for accessing DeFi vault data. This simplified version
    delivers optimized performance while maintaining comprehensive coverage
    across networks. Basic API key use is limited to 10 requests per minute.
servers:
  - url: https://api.vaults.fyi
    description: Vaults.fyi API
security: []
tags:
  - name: General
    description: >-
      Core informational endpoints providing essential reference data such as
      networks, assets, and vaults listings for orientation and exploration.
  - name: Detailed Vaults
    description: >-
      Comprehensive vault data endpoints delivering in-depth analytics including
      APY metrics, TVL statistics, rewards breakdowns, and risk scores.
  - name: Benchmarks
    description: >-
      Vaults.fyi curated benchmark endpoints providing aggregated yield
      performance data for USD and ETH denominated assets across selected
      networks.
  - name: Historical
    description: >-
      Endpoints returning time-series historical data for vault metrics,
      enabling trend analysis and performance tracking over customizable
      periods.
  - name: Portfolio
    description: >-
      Advanced endpoints providing detailed information about user balances,
      active positions, historical interactions, and tailored investment
      opportunities.
  - name: Transactions
    description: >-
      Endpoints for executing vault deposits, withdrawals, and reward claims
      with ready-to-sign transaction payloads.
  - name: NRT
    description: >-
      NRT (Near-Real-Time) endpoints return live vault data updated continuously
      throughout the day, including current share price, total supply, TVL, and
      APY.
  - name: Health
paths:
  /v2/health:
    get:
      tags:
        - Health
      summary: Health check
      description: >-
        Checks the health status of the API and its dependencies including
        database connections and cache availability.
      operationId: getHealth
      responses:
        '200':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                  message:
                    type: string
                required:
                  - status
                  - message
                additionalProperties: false
        '500':
          description: Default Response
          content:
            application/json:
              schema:
                anyOf:
                  - type: object
                    properties:
                      error:
                        type: string
                        enum:
                          - Internal Server Error
                      message:
                        type: string
                      errorId:
                        type: string
                    required:
                      - error
                      - message
                    additionalProperties: false
                  - {}
        '503':
          description: Default Response
          content:
            application/json:
              schema:
                anyOf:
                  - type: object
                    properties:
                      error:
                        type: string
                        enum:
                          - Service Unavailable
                      message:
                        type: string
                      errorId:
                        type: string
                    required:
                      - error
                      - message
                    additionalProperties: false
                  - {}

````