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

# Liveness and dependency check

> Unauthenticated, so a monitor with no credentials can reach it.

`not_configured` is distinct from `down`: the first means TradingAgents was
never installed here, the second that it is present and broken. Only the
second is an incident.



## OpenAPI

````yaml /api/openapi.json get /health
openapi: 3.1.0
info:
  title: BlackQuant TradingAgents API
  description: >

    An HTTP API over the
    [TradingAgents](https://github.com/TauricResearch/TradingAgents)

    multi-agent LLM trading framework by Tauric Research, used under Apache-2.0.


    ## Analyses are asynchronous


    A single analysis runs a full multi-agent debate and takes **minutes**, not

    seconds. `POST /v1/analyses` therefore returns a job reference immediately
    and

    the result is collected by polling `GET /v1/analyses/{id}`.


    ## Ratings


    A completed analysis carries one of `Buy`, `Overweight`, `Hold`,
    `Underweight`,

    `Sell` — or `REVIEW`.


    `REVIEW` is **not** a weak Hold. It means the run produced no parseable
    rating,

    so there is no opinion to act on. Check `is_review` before reading `rating`.


    ## This API places no orders


    Nothing here can move money. It starts analyses and returns what they
    decided.
  version: 0.1.0
servers:
  - url: http://127.0.0.1:8900
    description: Local
security: []
tags:
  - name: Analyses
    description: Start, poll and cancel analyses.
  - name: Service
    description: Health and effective configuration.
paths:
  /health:
    get:
      tags:
        - Service
      summary: Liveness and dependency check
      description: >-
        Unauthenticated, so a monitor with no credentials can reach it.


        `not_configured` is distinct from `down`: the first means TradingAgents
        was

        never installed here, the second that it is present and broken. Only the

        second is an incident.
      operationId: health_health_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Health'
components:
  schemas:
    Health:
      properties:
        status:
          type: string
          title: Status
          description: '`ok`, `degraded`, or `down`.'
        version:
          type: string
          title: Version
        checks:
          additionalProperties:
            $ref: '#/components/schemas/ComponentHealth'
          type: object
          title: Checks
      type: object
      required:
        - status
        - version
        - checks
      title: Health
    ComponentHealth:
      properties:
        status:
          type: string
          title: Status
          description: '`up`, `down`, or `not_configured`.'
        detail:
          anyOf:
            - type: string
            - type: 'null'
          title: Detail
      type: object
      required:
        - status
      title: ComponentHealth

````