mfahampshire
a70e68c7bd
* Smolmix documentation * Add smolmix docs: landing page, tutorials, and developer page links * Add Exit Gateway services page (NR vs IPR) and link from existing docs * Update auto-generated command and API outputs * Reorg of tutorials and architecture pages * License information + remove TODO from docs.rs visibile comment + reorg readme * Add versions file for doc-wide versioning * Relative -> absolute links * Relative -> absolute links * Update license + add old tutorial code as examples * Streamline smolmix docs * Clippy * Clean up doc comments * Last pass * Add larger file download to list * set new versions * Clippy * Remove blake pin from docs + add version range to root Cargo.toml * Format example logging * Remove crate blocked component * Loose whitespace * Add doc verification script for inline mdx * Formatting * Components regen * Reorg + tighten text * Voicing cohesion pass + remove bloated examples * Voicing cont. * Reduce max download size * Small suggested clarifications * Max/docs voicing consistency (#6769) * Reduce max download size * voicing consistency across docs * New landing order w smolmix * Tweaks * Final tweaks
58 lines
2.1 KiB
Plaintext
58 lines
2.1 KiB
Plaintext
---
|
|
title: "Node Status API - Nym Node Performance and Mixnet Stats"
|
|
description: "Reference for the Node Status API, which provides nym-node identity, performance scores, role assignments, and mixnet health summaries."
|
|
schemaType: "TechArticle"
|
|
section: "APIs"
|
|
lastUpdated: "2026-03-15"
|
|
---
|
|
|
|
import { RedocStandalone } from 'redoc'
|
|
import { Callout } from 'nextra/components'
|
|
|
|
# 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
|
|
|
|
<Callout type="info">
|
|
If you're building a service that makes heavy use of this API, consider [running your own instance](/operators/performance-and-testing/ns-api-deployment) to distribute load across the network.
|
|
</Callout>
|
|
|
|
## Quick examples
|
|
|
|
**Get a summary of all gateways:**
|
|
```bash
|
|
curl https://mainnet-node-status-api.nymtech.cc/api/v1/gateways
|
|
```
|
|
|
|
**Get details for a specific node by identity key:**
|
|
```bash
|
|
curl https://mainnet-node-status-api.nymtech.cc/api/v1/gateways/23A7CSaBSA2L67PWuFTPXUnYrCdyVcB7ATYsjUsfdftb
|
|
```
|
|
|
|
## Mainnet endpoints
|
|
|
|
- **OpenAPI spec:** [mainnet-node-status-api.nymtech.cc/api-docs/openapi.json](https://mainnet-node-status-api.nymtech.cc/api-docs/openapi.json)
|
|
- **Swagger UI:** [mainnet-node-status-api.nymtech.cc/swagger/](https://mainnet-node-status-api.nymtech.cc/swagger/)
|
|
|
|
## Full API reference
|
|
|
|
<br />
|
|
|
|
<RedocStandalone
|
|
specUrl="https://mainnet-node-status-api.nymtech.cc/api-docs/openapi.json"
|
|
options={{
|
|
nativeScrollbars: true,
|
|
theme: {
|
|
sidebar: {
|
|
backgroundColor: '#273239',
|
|
textColor: '#FCFDFE'
|
|
}
|
|
}
|
|
}}
|
|
/>
|