v1

latestOpenAPI 3.0.02026-07-174823135.4 KB
Health

Health check endpoint

Performs a health check of NBXplorer and its connected nodes. This endpoint can be used without authentication and returns HTTP 200 if all nodes are ready and synchronized.

get/health

Response

System is healthy. All nodes connected to NBXplorer are ready and synchronized.

statusstring

The overall health status of the system.

detailsobject

Detailed health status for each connected cryptocurrency node.

Example response

{
  "status": "healthy"
}