APIs
The Nym network exposes several HTTP APIs for querying network state, node performance, blockchain data, and credential information, with each API serving a different purpose.
Which API should I use?
| I want to… | API |
|---|---|
| Query node performance, roles, and mixnet statistics | Node Status API |
| Query circulating NYM supply or zk-nym credential data | NymAPI |
| Query blockchain state, account balances, or transactions | Validator REST API |
| Query legacy explorer data | Explorer API (retired) |
Node Status API
The primary API for querying node information. It serves data about individual nym-node instances: roles, statistics, Network Requester services, and overall mixnet summaries. If you’re building an explorer, analytics dashboard, or monitoring tool, start here.
If you’re building a service that makes heavy use of the Node Status API, consider running your own instance to distribute load across the network.
Endpoints: OpenAPI spec · Swagger
NymAPI
A sidecar binary operated by Nyx Validators. It caches smart contract data and exposes endpoints for circulating NYM supply, zk-nym credential data, and ticketbook information. Use this when you need token economics or credential data.
Endpoints: OpenAPI spec · Swagger
Other NymAPI instances are listed at cosmos.directory/nyx .
Validator REST API
The standard Cosmos SDK REST API exposed by Nyx Validators. Use this for direct chain queries: account balances, transaction history, governance proposals, and staking information.
Endpoints: OpenAPI spec · Swagger
Other validator endpoints are listed at cosmos.directory/nyx .
Explorer API
The Explorer API is retired. Use the Node Status API instead.
The legacy backend for the Mixnet Explorer . The Node Status API replaced it and provides the same data and more.