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

# Health check

> Health check.

 Returns the current health status of the API gateway and its connected
 services. Can be used for monitoring and load balancer health checks.



## OpenAPI

````yaml /proto-openapi/api/openapi.yaml get /health
openapi: 3.0.3
info:
  title: Monaco Protocol API
  description: REST API for the Monaco Protocol hybrid CLOB exchange.
  version: 1.0.0
servers:
  - url: https://staging.apimonaco.xyz
    description: Staging server (Testnet)
security: []
tags:
  - name: AccountsService
  - name: ApplicationsService
  - name: AuthService
  - name: BuildercodeRewardsService
  - name: CopyTradingService
  - name: DelegatedAgentsService
  - name: FaucetService
  - name: FeesService
  - name: HealthService
  - name: ManagedMarketsService
    description: |-
      Wallet-authenticated maker assignments. The signed session must match both
       configured maker user and application. Owner IDs are process fences, never auth.
       Only wallet sessions are supported; delegated-agent sessions receive 403.
  - name: MarginAccountsService
    description: |-
      Current public isolated-margin semantics:
       - a user has one parent margin account per application scope
       - opening orders create or reuse isolated position buckets under that parent
       - parent account creation is handled internally by margin workflows
  - name: MarketService
  - name: OrderbookService
  - name: OrdersService
  - name: PositionsService
    description: |-
      Current public isolated-margin semantics:
       - positions link to a parent margin account and, when applicable, a bucket id
       - opening orders create or reuse isolated position buckets under the parent
       - users can open another isolated position by reusing the parent account with a different market bucket
  - name: PulseService
  - name: SweeperService
  - name: TraderCodeService
  - name: TradesService
  - name: WhitelistService
  - name: WithdrawalsService
paths:
  /health:
    get:
      tags:
        - HealthService
        - Health
      summary: Health check
      description: |-
        Health check.

         Returns the current health status of the API gateway and its connected
         services. Can be used for monitoring and load balancer health checks.
      operationId: health_check
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicHealthCheckResponse'
        '503':
          description: Service is unhealthy
components:
  schemas:
    PublicHealthCheckResponse:
      type: object
      properties:
        status:
          example: healthy
          type: string
          description: 'Health status: healthy or unhealthy'
          nullable: true
        service:
          example: api-gateway
          type: string
          description: Service name
          nullable: true
        version:
          example: 0.1.0
          type: string
          description: Service version
          nullable: true
        timestamp:
          example: 1699872600
          type: integer
          description: Current server timestamp (Unix epoch seconds)
          format: int32
          nullable: true

````

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