API Documentation
Integration guide for querying the Nodus - Zcash Light API monitor.
VERSION 1.0
POST
Get Node List
/api/v1.0/nodes
Retrieves a filtered and sorted list of Zcash Light nodes. This endpoint allows for flexible querying based on uptime status, latency measurements, and custom ordering.
Request Parameters
| Parameter | Type | Description |
|---|---|---|
| chain | String (Enum) |
Chain type
Default:
All (if not provided)Example:
main
test
|
| count | Integer |
Number of nodes to retrieve in the response.
Default:
All (if not provided)Maximum:
1000Example:
10 |
| include_offline | Boolean |
Whether to include nodes currently marked as offline.
Default:
falseExample:
true |
| order_uptime | String (Enum) |
Sorting the result set by uptime.
Default:
-Example:
24h
7d
30d
|
| order_latency | Boolean |
Sorting the result set by answer latency.
Default:
falseExample:
true |
| include_data | Boolean |
Whether to include all other available technical information about the node in the response.
Default:
falseExample:
true |
Response fields
The response is a nodes array. Which fields each node carries depends on its type and on whether include_data was requested.
| Field | Type | Availability |
|---|---|---|
| host | String | Always |
| port | Integer | Always |
| type | String (Enum) | Always indexer, p2p |
| protocol | String (Enum) | Always grpc, p2p |
| online | Boolean | Always |
| latency | Float (ms) | Always |
| chain_name | String (Enum) | Always main, test |
| block_height | Integer | Always |
| up_24h, up_7d, up_30d, up_1y | Float (%) | Always Narrowed to the single requested period when order_uptime is set. |
| first_seen | Integer (unix) | include_data |
| last_check | Integer (unix) | include_data |
| next_check | Integer (unix) | include_data |
| up_30d_c | Float (%) | include_data |
| vendor | String | include_data |
| server_version | String | include_data |
| zcashd_subversion | String | include_data |
| protocol_version | Integer | include_data · P2P Node |
| estimated_height | Integer | include_data · Indexer |
| zcash_build | String | include_data · Indexer |
| sapling_activation_height | Integer | include_data · Indexer |
| build_date | String | include_data · Indexer |
| build_user | String | include_data · Indexer |
| git_commit | String | include_data · Indexer |
| consensus_branch_id | String | include_data · Indexer |
| taddr_support | Boolean | include_data · Indexer |
| donation_address | String | include_data · Indexer |
Example usage
BASH / cURL
curl -X POST https://nodus.alexxiy.top/api/v1.0/nodes \ -H "Content-Type: application/json" \ -d '{ "chain": "main", "count": 10, "order_uptime": "30d" }'