health

Returns a HealthRequestBuilder instance for querying server health status.

The health endpoint provides information about the current operational status of the Horizon server. It returns three key indicators:

• Database connectivity

• Stellar Core availability

• Stellar Core synchronization status

The server is considered healthy when all three indicators are true.

Example usage:

val health = horizonServer.health().execute()
if (health.isHealthy) {
    println("Server is operational")
} else {
    println("Server is experiencing issues")
}

See also