v1

latestOpenAPI 3.0.02026-07-175652103.9 KB
peer

Get Peers

This function is an API endpoint that retrieves the list of all peers in the network. It is tagged with "peer" for OpenAPI documentation.

Parameters

  • none

Returns

If successful, this function returns a Json<PeersResponse> object, which includes a success message, the total number of peers, and the list of peers. <br> If no peers are found, this function returns a status::NotFound error. <br>

Errors

This function will return an error if the system is in maintenance mode, or if no peers are found.

Example

GET /api/peers

get/api/peers

Response

msgstring required
totalinteger required