NymAPI

The NymAPI is a sidecar binary operated by members of the Nyx Validator set that caches smart contract data from the Nyx blockchain and exposes it via HTTP endpoints, making queries faster and more scalable than querying the chain directly.

Key endpoint categories:

• Token economics: circulating NYM supply, staking information
• Credential data: zk-nym ticketbook information, global and per-ticketbook data
• Network topology: cached node and mixnet data from on-chain contracts

For operator setup instructions, see the NymAPI Operator Guide.

Quick examples

Get the circulating NYM supply:

curl https://validator.nymtech.net/api/v1/circulating-supply

Get the current network topology (Mix Nodes and gateways):

curl https://validator.nymtech.net/api/v1/mixnodes/active

Mainnet endpoints

• OpenAPI spec: validator.nymtech.net/api-docs/openapi.json (opens in a new tab)
• Swagger UI: validator.nymtech.net/api/swagger/index.html (opens in a new tab)

Full API reference