Info

Query the health of the node.

Get node health information. A node is considered healthy if its Stacks tip height matches the maximum Stacks tip height observed among its connected peers. This endpoint returns:

difference_from_max_peer: The difference in Stacks height between this node and its most advanced peer.
max_stacks_height_of_neighbors: The maximum Stacks height observed among the node"s connected peers.
node_stacks_tip_height: The current Stacks tip height of this node.
max_stacks_neighbor_address: The address of the most advanced peer. Null if no peer data is available.

get/v3/health

Response

Success

GetHealth required— unresolved $ref

Changes

Changed in 7 of the 53 revisions of this API.6216

Aug 5, 2025a9c44dcce7611See the full diff
- ●
  deleted the query request parameter neighbors
  request-parameter-removed
Jul 9, 202504a9a0b50aa323See the full diff
- ▲
  removed the media type application/json for the response with the status
  response-media-type-removed
- ▲
  removed the media type application/json for the response with the status
  response-media-type-removed
- ○
  api operation id get_health removed and replaced with getNodeHealth
  api-operation-id-removed
- ○
  added the media type text/plain for the response with the status
  response-media-type-added
- ○
  added the media type text/plain for the response with the status
  response-media-type-added
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jul 8, 2025488dd3b8002023See the full diff
- ▲
  removed the media type text/plain for the response with the status
  response-media-type-removed
- ▲
  removed the media type text/plain for the response with the status
  response-media-type-removed
- ○
  api operation id getNodeHealth removed and replaced with get_health
  api-operation-id-removed
- ○
  added the media type application/json for the response with the status
  response-media-type-added
- ○
  added the media type application/json for the response with the status
  response-media-type-added
This revision also has 35 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jul 8, 2025170414634c9014See the full diff
- ▲
  removed the media type application/json for the response with the status
  response-media-type-removed
- ○
  api operation id get_health removed and replaced with getNodeHealth
  api-operation-id-removed
- ○
  added the new optional query request parameter neighbors
  new-optional-request-parameter
- ○
  added the media type text/plain for the response with the status
  response-media-type-added
- ○
  added the non-success response with the status
  response-non-success-status-added
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jun 27, 20257e7074ff080311See the full diff
- ●
  deleted the query request parameter neighbors
  request-parameter-removed
- ○
  removed the non-success response with the status
  response-non-success-status-removed
Jun 26, 20252fc5956efe3d14See the full diff
- ▲
  removed the media type text/plain for the response with the status
  response-media-type-removed
- ○
  api operation id getNodeHealth removed and replaced with get_health
  api-operation-id-removed
- ○
  added the new optional query request parameter neighbors
  new-optional-request-parameter
- ○
  added the media type application/json for the response with the status
  response-media-type-added
- ○
  added the non-success response with the status
  response-non-success-status-added
This revision also has 35 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jun 25, 202587a7fe30e4361See the full diff
- ○
  removed the non-success response with the status
  response-non-success-status-removed
This revision also has 21 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history