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

# Health check

> Get the health status of the yield API with current timestamp



## OpenAPI

````yaml get /health
openapi: 3.0.0
info:
  title: Yield.xyz API
  description: API Documentation
  version: '1.0'
  contact: {}
servers:
  - url: https://api.yield.xyz
    description: Production environment
  - url: https://api.staging.yield.xyz
    description: Staging environment
  - url: http://localhost:3000
    description: Local development
security: []
tags:
  - name: Discovery
    description: Browse and discover yield opportunities, networks, and providers
  - name: Portfolio
    description: User-specific balances, activity, and rewards
  - name: Actions
    description: Generate transactions to enter, exit, and manage yields
externalDocs:
  description: For more information
  url: https://docs.yield.xyz
paths:
  /health:
    get:
      tags:
        - Health
      summary: Health check
      description: Get the health status of the yield API with current timestamp
      operationId: HealthController_health
      parameters: []
      responses:
        '200':
          description: Health check status with timestamp
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HealthStatusDto'
components:
  schemas:
    HealthStatusDto:
      type: object
      properties:
        status:
          $ref: '#/components/schemas/HealthStatus'
          example: OK
        timestamp:
          type: string
          format: date-time
          example: '2024-01-15T10:30:00.000Z'
          description: Timestamp when the health check was performed
      required:
        - status
        - timestamp
    HealthStatus:
      type: string
      description: The health status of the service
      enum:
        - OK
        - FAIL

````