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

# Provider health

> Get the operator-set health state of each perps provider; needs no API key.

Returns one entry per provider with `state` of `healthy`, `degraded` or `down`. A provider is `healthy` with `message` and `setAt` set to `null` unless yield.xyz has set a manual override; overrides carry a message and the time they were set. The state is not measured from live venue connectivity. This route needs no `x-api-key`.


## OpenAPI

````yaml openapi-perps.json GET /v1/health/providers
openapi: 3.0.0
info:
  title: 'Yield API: Trade (Perps)'
  description: >-
    API Documentation. Errors follow a uniform envelope with `details.code` from
    the public catalog (https://docs.yield.xyz). ValidationPipe failures use
    `validation.message: string[]`.
  version: '1.0'
  contact: {}
servers:
  - url: https://perps.yield.xyz
    description: Production
security: []
tags:
  - name: Discovery
    description: Browse and discover perps markets, networks, and providers
  - name: Portfolio
    description: User-specific positions, orders, and balances
  - name: Actions
    description: Generate transactions to open, close, and manage positions
externalDocs:
  description: For more information
  url: https://docs.yield.xyz
paths:
  /v1/health/providers:
    get:
      tags:
        - Health
      summary: Per-provider manual health overrides
      operationId: HealthController_providersHealth_v1
      parameters: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProvidersHealthDto'
          description: ''
components:
  schemas:
    ProvidersHealthDto:
      type: object
      properties:
        generatedAt:
          type: string
        providers:
          type: array
          items:
            $ref: '#/components/schemas/ProviderHealthEntryDto'
      required:
        - generatedAt
        - providers
    ProviderHealthEntryDto:
      type: object
      properties:
        providerId:
          type: string
        state:
          type: string
          enum:
            - healthy
            - degraded
            - down
        message:
          type: string
          nullable: true
        setAt:
          type: string
          nullable: true
      required:
        - providerId
        - state
        - message
        - setAt

````

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