---
title: "Health check endpoint"
method: GET
path: "/health"
tags: ["Health"]
---

# Health check endpoint

`GET /health`

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.

## Response `200`

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

- object
  - `status` string — The overall health status of the system.
  - `details` object — Detailed health status for each connected cryptocurrency node.

## Other responses

- `503` — Service Unavailable. One or more nodes are not synchronized or unavailable.

---

[API](https://skmtc.net/btcpayserver/apis/nbxplorer-api.md) · [All operations](https://skmtc.net/btcpayserver/apis/nbxplorer-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/btcpayserver/nbxplorer-api/revisions/208cac39e31a/schema)