Nym Technologies Nym Nodes API
The Nym Nodes API from Nym Technologies — 15 operation(s) for nym nodes.
Nym Technologies Nym Nodes API is one of 23 APIs that Nym Technologies publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Nym Nodes. The published artifact set on APIs.io includes an OpenAPI specification.
This API exposes 15 operations across 15 paths, and defines 65 schemas. It is described by OpenAPI 3.1.0, at version 4.6.2.
Requests are made against the base URL https://validator.nymtech.net/api.
15 operations
15 paths
65 schemas
13 GET2 POST
Metadata
The identity and technical contract details declared by the specification.
Paths & Operations 15
Across 15 paths, the API surfaces 15 operations — 13 GET, 2 POST. Each is listed below with its method, path, parameters, and response codes.
Nym Nodes 15
GET
/v1/nym-nodes/annotation/{node_id}
GET
/v1/nym-nodes/bonded
GET
/v1/nym-nodes/describeddeprecated
GET
/v1/nym-nodes/historical-performance/{node_id}
GET
/v1/nym-nodes/noise
GET
/v1/nym-nodes/performance-history/{node_id}
GET
/v1/nym-nodes/performance/{node_id}
POST
/v1/nym-nodes/refresh-described
GET
/v1/nym-nodes/rewarded-set
GET
/v1/nym-nodes/stake-saturation/{node_id}
GET
/v1/nym-nodes/uptime-history/{node_id}
GET
/v2/nym-nodes/annotation/{node_id}
GET
/v2/nym-nodes/described
POST
/v3/nym-nodes/stress-testing/batch-submit
Accept a batch of stress-test results from an authorised network monitor orchestrator.
GET
/v3/nym-nodes/stress-testing/known-monitors/{identity_key}
Report whether the given identity key is currently recognised by this nym-api as an authorised network monitor orchestrator.
Schemas 65
The contract defines 65 schemas that model the data the API accepts and returns. The most detailed are BlockHeader (14 properties), NymNodeDataV2 (11 properties), BinaryBuildInformationOwned (10 properties), NymNodeDataV1 (10 properties). Each schema is shown below with its type and property counts.
NodeAnnotationV2
object
3 properties
1 required
HostKeysV1
object
5 properties
3 required
NymNode
object
Information provided by the node operator during bonding that are used to allow other entities to use the services of this node.
3 properties
2 required
AnnotationResponseV1
object
2 properties
1 required
NodeRefreshBody
object
3 properties
3 required
BlockInfo
object
2 properties
2 required
NodeCostParams
object
The cost parameters, or the cost function, defined for the particular mixnode that influences how the rewards should be split between the node operator and its…
2 properties
2 required
DetailedNodePerformanceV1
object
3 properties
3 required
NymNodeAuxiliaryDetailsV1
object
3 properties
NodeDatePerformanceResponse
object
3 properties
2 required
AbciInfo
object
5 properties
5 required
PaginatedResponse_HistoricalPerformanceResponse
object
2 properties
2 required
AuthenticatorDetailsV1
object
1 property
1 required
OffsetDateTimeJsonSchemaWrapper
string
HostInformationV1
object
3 properties
2 required
PaginatedResponse_NoiseDetails
object
2 properties
2 required
VersionedNoiseKeyV1
object
2 properties
2 required
DescribedNodeTypeV1
string
NymNodeDataV2
object
11 properties
3 required
PartSetHeader
object
Block parts header
2 properties
2 required
LewesProtocolDetailsDataV1
object
5 properties
5 required
HeaderVersion
object
Version contains the protocol version for the blockchain and the application.
2 properties
2 required
DetailedNodePerformanceV2
object
4 properties
4 required
PerformanceHistoryResponse
object
2 properties
2 required
NetworkRequesterDetailsV1
object
2 properties
2 required
StakeSaturationResponse
object
3 properties
3 required
RewardedSetResponse
object
7 properties
6 required
ConfigScoreV1
object
5 properties
4 required
BlockHeader
object
Block Header values contain metadata about the block and about the consensus, as well as commitments to the data in the current block, the previous block, and…
14 properties
9 required
BinaryBuildInformationOwned
object
10 properties
9 required
DeclaredRolesV1
object
4 properties
4 required
NodeRewarding
object
7 properties
7 required
FullBlockInfo
object
1 property
1 required
DetailedChainStatus
object
2 properties
2 required
StressTestingScore
object
2 properties
2 required
NodePerformanceResponse
object
2 properties
1 required
AnnouncePortsV1
object
2 properties
Output
string
LewesProtocolDetailsV1
object
2 properties
2 required
KnownNetworkMonitorResponse
object
Response body for GET /v3/nym-nodes/stress-testing/known-monitors/{identitykey}, used by orchestrators to check whether this nym-api currently recognises their…
2 properties
2 required
ChainInteractionCapabilitiesDetailed
object
2 properties
2 required
AnnotationResponseV2
object
2 properties
1 required
u32
integer
WireguardDetailsV1
object
4 properties
2 required
WebSocketsV1
object
2 properties
1 required
ChainBlocksStatusResponseBody
object
3 properties
2 required
CoinSchema
object
2 properties
2 required
DisplayRole
string
PendingNodeChanges
object
2 properties
OutputV2
string
PaginatedResponse_NymNodeDescriptionV1
object
2 properties
2 required
ConfigScoreV2
object
6 properties
5 required
PaginatedResponse_NymNodeDetails
object
2 properties
2 required
IpPacketRouterDetailsV1
object
1 property
1 required
NymNodeBond
object
6 properties
6 required
ChainInteractionCapabilities
object
2 properties
2 required
RoutingScore
object
1 property
1 required
NymNodeDataV1
object
10 properties
3 required
BlockId
object
Block identifiers which contain two distinct Merkle roots of the block, as well as the number of parts in the block. Default implementation is an empty Id as d…
2 properties
2 required
PaginatedResponse_NymNodeDescriptionV2
object
2 properties
2 required
SphinxKeyV1
object
2 properties
2 required
Pagination
object
3 properties
3 required
NodeAnnotationV1
object
3 properties
2 required
SignedMessage
object
2 properties
2 required
ChainStatus
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Nym Technologies 12
Other APIs Nym Technologies publishes across the network.
Nym Technologies API Status API
Nym Technologies circulating-supply API
Nym Technologies contract-cache API
Nym Technologies dVPN Directory Cache API
Nym Technologies Ecash API
Nym Technologies Ecash Global Data API
Nym Technologies Gateways API
Nym Technologies Mixnodes API
Nym Technologies network API
Nym Technologies network-monitor-status API
Nym Technologies Node Families API
Nym Technologies Nym Explorer API
#Nym Nodes