> ## 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

> Return the Borrow API service status and a timestamp; no API key needed.

Unauthenticated. Returns `status` `OK` and the current `timestamp`.


## OpenAPI

````yaml openapi-borrow.json GET /health
openapi: 3.0.0
info:
  title: 'Yield API: Borrow'
  description: API Documentation
  version: '1.0'
  contact: {}
servers:
  - url: https://borrow.yield.xyz
    description: Production
security: []
tags:
  - name: Discovery
    description: Browse and discover lending markets, integrations, and supported networks
  - name: Positions
    description: User-specific supply and borrow positions
  - name: Actions
    description: >-
      Execute actions (supply, borrow, repay, withdraw) and manage multi-step
      flows
  - name: Transactions
    description: Submit signed transactions and track status
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 borrow 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:
          example: OK
          description: The health status of the service
          allOf:
            - $ref: '#/components/schemas/HealthStatus'
        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
      enum:
        - OK
        - FAIL
      description: The health status of the service

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.