ok is false until the first poll tick completes, which is honest about readiness rather than pretending to be ready. Poll this endpoint to build a staleness banner or liveness probe.
Parameters
This endpoint takes no parameters.Request
Response — Healthy
Response — Degraded
Response Fields
boolean
false until the first poll tick completes. true once the reader has received at least one ledger. A true reading with degraded: true means the reader has data but upstream is currently unhealthy.string
The API contract version. Currently
"1.0.0". Breaking changes increment the major version.string
Where the data came from:
"devnet" for a live Devnet read, "fixtures" for the recorded ring buffer used in offline demos.string
Always
"devnet". This service runs against XRPL Devnet — XLS-65 vaults and XLS-66 lending are not amended into Mainnet.number
The ledger sequence number of the most recent successful read.
string
ISO 8601 close time of the most recent ledger. This is the ledger close time converted from the Ripple epoch — not the server’s wall clock.
string | null
The
rippled build version reported by the connected node. Reported, never asserted — Devnet nodes upgrade independently.boolean
Present only when upstream is unhealthy. When
true, the reader is keeping the last good snapshot rather than blanking. Display stale data with an age banner rather than an empty screen.number
Present only alongside
degraded: true. Seconds since the last successful ledger read.GET /api/health is the one response that does not go through stamp(). It builds serverTime and ledgerIndex itself, because it must be able to report on the reader’s state before the reader has necessarily connected — including the case where ok is false and no ledger has been seen yet.