Skip to content

Health

Service health checks. No authentication required.

MethodPathDescription
GET/v1/healthBasic health status
GET/v1/health/detailedHealth status with dependency checks

GET /v1/health
Terminal window
curl https://api.tokenbot.com/v1/health

Response:

{
"status": "healthy",
"timestamp": "2026-06-28T12:00:00.000Z",
"version": "0.1.0",
"uptime": 3825.21
}
FieldTypeDescription
statusstringhealthy, degraded, or unhealthy
timestampstringISO-8601 timestamp of the check
versionstringRunning API version
uptimenumberProcess uptime in seconds
GET /v1/health/detailed

Adds a dependencies block reporting the status of downstream services. Use this for monitoring; the basic endpoint is best for cheap liveness probes.

Terminal window
curl https://api.tokenbot.com/v1/health/detailed

Response:

{
"status": "healthy",
"timestamp": "2026-06-28T12:00:00.000Z",
"version": "0.1.0",
"uptime": 3825.21,
"dependencies": {
"graphql": "up",
"redis": "up"
}
}
FieldTypeDescription
dependencies.graphqlstringup or down — GraphQL API reachability
dependencies.redisstringup or down — cache reachability (optional)
StatusMeaning
healthyAll checked dependencies are up
degradedSome dependencies are down; partial functionality
unhealthyAll checked dependencies are down