Skip to content

trading_agent.gateway.routes.health_routes

The open health check route, which needs no access token.

It reveals only that the gateway is running and the state of each desk, so trading-agent doctor and systemd checks can call it without the token.

Typical usage example:

application.include_router(HealthRoutes(desks).router())

HealthRoutes 

HealthRoutes(desks)

Builds the /api/health route.

Creates the routes for a set of desks.

Parameters:

Name Type Description Default
desks Mapping[str, DeskRuntime]

The running desks, keyed by name.

 required
Source code in src/trading_agent/gateway/routes/health_routes.py 
21
22
23
24
25
26
27
def __init__(self, desks: Mapping[str, desk_runtime.DeskRuntime]):
    """Creates the routes for a set of desks.

    Args:
        desks (Mapping[str, desk_runtime.DeskRuntime]): The running desks, keyed by name.
    """
    self._desks = desks

router 

router()

Builds the router holding the health route.

Returns:

Type Description
APIRouter

The router.
Source code in src/trading_agent/gateway/routes/health_routes.py 
29
30
31
32
33
34
35
36
37
def router(self) -> fastapi.APIRouter:
    """Builds the router holding the health route.

    Returns:
        fastapi.APIRouter: The router.
    """
    router = fastapi.APIRouter()
    router.add_api_route('/api/health', self.health, methods=['GET'])
    return router

health 

health()

Reports that the gateway is running, with each desk's state.

Returns:

Type Description
dict[str, Any]

The status and a list of desks with their state and queue length.
Source code in src/trading_agent/gateway/routes/health_routes.py 
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
def health(self) -> dict[str, Any]:
    """Reports that the gateway is running, with each desk's state.

    Returns:
        dict[str, Any]: The status and a list of desks with their state and queue length.
    """
    desk_summaries = []
    for desk in self._desks.values():
        desk_summaries.append(
            {
                'name': desk.name,
                'state': str(desk.state),
                'queued': desk.queued_count,
            }
        )
    return {
        'status': 'ok',
        'desks': desk_summaries,
    }