Health check

RPC node

Get health information about the node's synchronization status.

GET

Parameters

Query Parameters

neighbors
string Specifies the set of peers to use for health checks. - `initial` (default): Use only the initial bootstrap peers. - `all`: Use all connected peers.
Status codeDescription
200Success
400Bad request
500Internal Server Error
cURL
curl -L \
"https://api.hiro.so/v3/health?neighbors={neighbors}" \
-H 'Accept: application/json'
Response
{
"difference_from_max_peer": 0,
"max_stacks_height_of_neighbors": 12345,
"node_stacks_tip_height": 12345
}

How is this guide?