🧐 Check BTC node health

Code samples

GET /api/v1/btc/health

Performs a lightweight getblockchaininfo JSON-RPC call to the configured BTC node and returns basic health information.

Example responses

200 Response

{
  "status": "ok",
  "time": "2025-07-23T15:16:00Z",
  "chain": "main",
  "blocks": 840000,
  "headers": 840005,
  "verificationProgress": 0.99999
}

Status	Meaning	Description	Schema
200	OK	BTC node is reachable and responding	Inline
500	Internal Server Error	BTC node URL or credentials are not configured, or node is not reachable	Inline

Status Code 200

Name	Type	Required	Restrictions	Description
» status	string	false	none	none
» time	string(date-time)	false	none	none
» chain	string	false	none	Active chain type reported by `getblockchaininfo` (e.g. main, test, regtest, signet).
» blocks	integer(int64)	false	none	Current block height.
» headers	integer(int64)	false	none	Current number of block headers known.
» verificationProgress	number(float)	false	none	Blockchain verification progress from 0.0 to 1.0.

Status Code 500

Name	Type	Required	Restrictions	Description
» status	string	false	none	none
» message	string	false	none	none