Node Status API
The Node Status API serves information about individual nym-node instances in the Nym network: which role they are operating in, performance statistics, Network Requester services, and summaries of the overall mixnet state. It is the primary API for anyone building explorers, analytics dashboards, or monitoring tools.
Key endpoint categories:
- Node information: identity, bonding status, declared roles, build version, host details
- Performance scores: routing reliability, configuration scores, probe results
- Mixnet summaries: active set composition, role distribution, network health
If you're building a service that makes heavy use of this API, consider running your own instance to distribute load and promote a robust network of downstream services.
Quick examples
Get a summary of all gateways:
curl https://mainnet-node-status-api.nymtech.cc/api/v1/gatewaysGet details for a specific node by identity key:
curl https://mainnet-node-status-api.nymtech.cc/api/v1/gateways/23A7CSaBSA2L67PWuFTPXUnYrCdyVcB7ATYsjUsfdftbMainnet endpoints
- OpenAPI spec: mainnet-node-status-api.nymtech.cc/api-docs/openapi.json (opens in a new tab)
- Swagger UI: mainnet-node-status-api.nymtech.cc/swagger/ (opens in a new tab)
Full API reference
Loading ...