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.

All HTTP endpoints are available at https://hyper.polynode.dev. No authentication required.

​
GET /health

Health check for load balancers and monitoring. Response: 200 OK 
ok

​
GET /status

Service status overview. Response: 
{
  "status": "ok",
  "network": "mainnet",
  "block": 70874222,
  "actions_per_sec": 2344,
  "uptime_seconds": 10502,
  "ws_connections": 0,
  "ws_subscriptions": 0
}
FieldTypeDescription
statusstringAlways "ok" if service is running
networkstring"mainnet" or "testnet"
blocknumberLatest block number processed
actions_per_secnumberCurrent throughput
uptime_secondsnumberSeconds since service start
ws_connectionsnumberActive WebSocket connections
ws_subscriptionsnumberActive subscriptions

​
GET /metrics

Full metrics in JSON format. Response: 
{
  "network": "mainnet",
  "uptime_seconds": 10502,
  "current_block": 70874222,
  "actions_total": 24620887,
  "actions_per_sec": 2344,
  "events_broadcast": 16392548,
  "events_dropped": 8228339,
  "broadcaster_hit_rate_pct": 100.0,
  "broadcaster_hits": 24620592,
  "broadcaster_misses": 295,
  "bytes_received_mb": 5919.85,
  "frames_total": 81566,
  "decompress_ok": 81372,
  "decompress_fail": 194,
  "ws_connections": 1,
  "ws_subscriptions": 1,
  "ws_auth_connections": 1
}
FieldDescription
actions_totalTotal actions decoded since startup
actions_per_secCurrent action throughput
events_broadcastEvents delivered to subscribers
events_droppedEvents with no matching subscribers
broadcaster_hit_rate_pctPercentage of events matched to at least one subscriber
broadcaster_hits / missesRaw match/miss counts
bytes_received_mbTotal data received from upstream
frames_totalTotal protocol frames processed
decompress_ok / failFrame decompression success/failure counts

​
GET /metrics/prometheus

Prometheus-compatible text format. All metrics prefixed with hl_gossip_. Response: 
hl_gossip_actions_per_sec 2344
hl_gossip_actions_total 24621058
hl_gossip_current_block 70874223
hl_gossip_uptime_seconds 10502
hl_gossip_ws_connections 0
hl_gossip_ws_subscriptions 0
Prometheus scrape config: 
scrape_configs:
  - job_name: 'hypernode-mainnet'
    static_configs:
      - targets: ['localhost:8080']
    metrics_path: '/metrics/prometheus'
    scrape_interval: 15s