Skip to main content

Documentation Index

Fetch the complete documentation index at: https://hypernode-docs.polynode.dev/llms.txt

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

Returns a snapshot of indexer health and platform status. Use this as a liveness probe before relying on data freshness.

​
Endpoint

GET /v1/health
Authentication: required (X-API-Key).

​
Why use this

  • Liveness check before running an integration that depends on real-time data.
  • Lag tracking — lag_seconds is the gap between the latest event we’ve ingested and wall-clock time. Normally 1–10 seconds.
  • Status field — "ok" if lag < 60s, "degraded" otherwise.

​
Response

{
  "status": "ok",
  "lag_seconds": 5,
  "active_markets": 1,
  "latest_event": {
    "us": 1777745247319000,
    "iso": "2026-05-02T18:07:27.319+00:00",
    "relative": "3s ago"
  }
}
FieldTypeDescription
statusstring"ok" if lag < 60s, "degraded" otherwise
lag_secondsintSeconds between latest indexed event and now
active_marketsintNumber of HIP-4 outcomes currently active
latest_eventobjectTimestamp of the most recent fill ingested (us epoch microseconds + iso + relative string)

​
Examples

curl -H "X-API-Key: hip4_live_..." \
  https://hip4.polynode.dev/api/v1/health