Skip to main content

Documentation Index

Fetch the complete documentation index at: https://nexus.gerowallet.io/docs/llms.txt

Use this file to discover all available pages before exploring further.

The Health API provides endpoints for monitoring the status of Gero Nexus services and underlying data providers. Use these endpoints to check service availability and troubleshoot connectivity issues.

Available endpoints

Provider health

Get health status of all data providers

Provider status

Gero Nexus aggregates data from multiple providers for redundancy and reliability. The health endpoint returns status for each provider:
StatusDescription
HEALTHYProvider is operational and responding
DEGRADEDProvider is slow but functional
UNHEALTHYProvider is not responding
UNKNOWNStatus cannot be determined

Health response

The endpoint returns an array of provider status objects:
[
  {
    "provider": "blockfrost",
    "status": "HEALTHY",
    "latency_ms": 45,
    "last_check": "2025-01-15T12:00:00Z",
    "networks": ["MAINNET", "PREPROD", "PREVIEW"]
  },
  {
    "provider": "koios",
    "status": "HEALTHY",
    "latency_ms": 62,
    "last_check": "2025-01-15T12:00:00Z",
    "networks": ["MAINNET", "PREPROD"]
  }
]

Use cases

Monitoring dashboards

Integrate the health endpoint into your monitoring systems to track API availability and performance.

Graceful degradation

Check provider health before making requests to implement graceful degradation in your application.

Debugging

When experiencing issues, check the health endpoint to identify if the problem is with a specific provider or network.

Example: Check API health

curl -X GET "https://nexus-dev.gerowallet.io/api/providers/health" \
  -H "Authorization: Bearer your-token"

Service level

Gero Nexus maintains high availability through:
  • Multiple providers - Automatic failover between data sources
  • Geographic distribution - Servers in multiple regions
  • Caching - Reduces load on underlying providers
  • Rate limiting - Prevents abuse and ensures fair access
For enterprise SLA requirements, contact our sales team.