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

# Health Check

> Provides API service health status and availability information for system monitoring and diagnostics. This unauthenticated endpoint returns operational status to verify service readiness.

**Use Case:** Implement health monitoring in load balancers, container orchestration systems, and continuous integration pipelines to verify API availability.




## OpenAPI

````yaml openapi.json GET /health
openapi: 3.0.3
info:
  title: Aries Trading Platform API
  description: >-
    Complete API documentation for the Aries trading platform including user
    management, authentication, account management, order management, market
    data, and analytics
  contact:
    name: Aries Financial
    email: dev@aries.com
  version: 1.0.0
servers:
  - url: https://api.tradearies.dev
    description: Production server
security: []
tags:
  - name: Accounts
    description: Account management endpoints for positions, orders, and balances
  - name: Analytics
    description: >-
      Analytics endpoints for market data analysis including top gainers,
      losers, volume leaders, sector analysis, analyst ratings, market breadth,
      and net inflow
  - name: Authentication
    description: User authentication endpoints
  - name: Calendars
    description: Calendar endpoints for economic events and historical data
  - name: Market Data
    description: >-
      Market data endpoints for symbol search, real-time data access, and equity
      details
  - name: Orders
    description: >-
      Order management endpoints for placing, updating, canceling, and
      previewing orders
  - name: Users
    description: User management endpoints
  - name: Health
    description: Service health endpoints
paths:
  /health:
    get:
      tags:
        - Health
      summary: Health Check
      description: |-
        Health check endpoint for service monitoring.

        _Does not require authentication_
      operationId: healthCheck
      responses:
        '200':
          description: Service is healthy
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HealthResponse'
              example:
                status: healthy
      x-codeSamples:
        - lang: java
          label: Java (SDK)
          source: |-
            package hello.world;

            import java.lang.Exception;
            import org.openapis.openapi.AriesJava;
            import org.openapis.openapi.models.operations.HealthCheckResponse;

            public class Application {

                public static void main(String[] args) throws Exception {

                    AriesJava sdk = AriesJava.builder()
                            .bearerAuth(System.getenv().getOrDefault("BEARER_AUTH", ""))
                        .build();

                    HealthCheckResponse res = sdk.health().check()
                            .call();

                    if (res.healthResponse().isPresent()) {
                        // handle response
                    }
                }
            }
components:
  schemas:
    HealthResponse:
      type: object
      properties:
        status:
          type: string
          description: Service health status
          example: healthy

````