For AI agents: a documentation index is available at /llms.txt. A markdown version of this page is available at the same URL with .md appended (or via Accept: text/markdown).
Skip to main content

getHealth

Returns the health of the node, including the ledger range it currently retains. This method uses 160 credits from your daily balance.

Parameters​

None

Returns​

result: (object) - Health and ledger retention for the node.

  • status: (string) - healthy when the node is healthy.
  • latestLedger: (integer) - Sequence number of the most recent ledger known to the node.
  • latestLedgerCloseTime: (string) - Unix timestamp, as a string, of when that ledger closed.
  • oldestLedger: (integer) - Sequence number of the oldest ledger kept in history.
  • oldestLedgerCloseTime: (string) - Unix timestamp, as a string, of when that ledger closed.
  • ledgerRetentionWindow: (integer) - Configured maximum retention window, in ledgers. The node is retaining a full window when latestLedger - oldestLedger + 1 equals ledgerRetentionWindow.

Request​

curl https://stellar-mainnet.infura.io/v3/<YOUR-API-KEY> \
-X POST \
-H "Content-Type: application/json" \
-d '{"jsonrpc": "2.0", "id": 1, "method": "getHealth"}'

Response​

{
"jsonrpc": "2.0",
"id": 1,
"result": {
"status": "healthy",
"latestLedger": 64923230,
"latestLedgerCloseTime": "1791901932",
"oldestLedger": 63886431,
"oldestLedgerCloseTime": "1786359079",
"ledgerRetentionWindow": 1036800
}
}