Peers
The peers resource is much like the node resource, but only exposes the IPs and ports of connected peers. Recursively traversing this API and its responses allow you to inspect the entire network.
Endpoints
List All Peers
Returns all peers known by the Node. These are not necessarily all peers; only public Nodes appear here.
Endpoint
GET
Query Parameters
| Name | Description | Required | Example |
|---|---|---|---|
| page |
The number of the page that will be returned.
|
No | 1 |
| limit |
The number of resources per page.
|
No | 100 |
| offset |
The number of resources to be skipped.
|
No | |
| orderBy |
The column by which the resources will be sorted.
|
No | |
| version |
The node version by which the resources will be filtered.
|
No |
| Name | page |
| Description |
The number of the page that will be returned.
|
| Required | No |
| Example | 1 |
| Name | limit |
| Description |
The number of resources per page.
|
| Required | No |
| Example | 100 |
| Name | offset |
| Description |
The number of resources to be skipped.
|
| Required | No |
| Example |
| Name | orderBy |
| Description |
The column by which the resources will be sorted.
|
| Required | No |
| Example |
| Name | version |
| Description |
The node version by which the resources will be filtered.
|
| Required | No |
| Example |
Retrieve a Peer
Specific peers can be found by IP address. Note that a peer may have their Public API disabled, and thus they are only reachable by the internal p2p API.
Endpoint
GET
Path Parameters
| Name | Description | Required | Example |
|---|---|---|---|
| ip |
The IP address of the peer to be retrieved.
|
No |
| Name | ip |
| Description |
The IP address of the peer to be retrieved.
|
| Required | No |
| Example |
Last updated 3 years ago
Edit Page