Nym Technologies Node Families 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 Node Families. The published artifact set on APIs.io includes an OpenAPI specification.
This API exposes
3 operations
across 3 paths,
and defines 11 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.
3 operations3 paths11 schemas3 GET
Metadata
The identity and technical contract details declared by the specification.
Specification
OpenAPI 3.1.0
API Version
4.6.2
Base URL
https://validator.nymtech.net/api
Contact
Nym Technologies SA
License
Apache-2.0
Resource Areas
1
Paths & Operations 3
Across 3 paths, the API surfaces 3 operations — 3 GET. Each is listed below with its method, path, parameters, and response codes.
Node Families 3
GET
/v1/node-families
get_families3 params→ 200
GET
/v1/node-families/by-node/{node_id}
get_family_for_node2 params→ 200
GET
/v1/node-families/{family_id}
get_family_by_id2 params→ 200
Schemas 11
The contract defines 11 schemas that model the data the API accepts and returns. The most detailed are NodeFamily (9 properties), NodeStakeInformation (4 properties), Pagination (3 properties), NodeFamilyMember (3 properties). Each schema is shown below with its type and property counts.
NodeFamilyForNodeResponse
object
Response wrapper for endpoints that look up the family a given node belongs to. family is None when the node is not currently a member of any cached family.
2 properties1 required
NodeStakeInformation
object
Per-node stake snapshot derived from the mixnet contract's rewarding state.
4 properties4 required
NodeFamilyMember
object
Family member view as exposed by the nym-api node-families endpoints.
3 properties2 required
u32
integer
NodeFamilyResponse
object
Response wrapper for endpoints that look up a single family. family is None when the lookup did not match (rather than returning a 404).
1 property
PaginatedResponse_NodeFamily
object
2 properties2 required
PendingFamilyInvitation
object
Pending family invitation as exposed by the nym-api node-families endpoints.
2 properties2 required
NodeFamily
object
Family view as exposed by the nym-api node-families endpoints, carrying current members, pending invitations and aggregated stats.
9 properties8 required
CoinSchema
object
2 properties2 required
Pagination
object
3 properties3 required
OutputV2
string
Specification
The full machine-readable OpenAPI contract behind this narrative.
