Peering API Methods

The peering API allows retrieving basic information about autopeering.

The API provides the following functions and endpoints:

• /autopeering/neighbors

Client lib APIs:

• GetAutopeeringNeighbors()

/autopeering/neighbors

Returns the chosen and accepted neighbors of the node.

Parameters

Parameter	known
Required or Optional	optional
Description	Return all known peers, set to 1 (default: 0)
Type	int

Examples

cURL

curl --location 'http://localhost:8080/autopeering/neighbors?known=1'

Client lib - GetAutopeeringNeighbors

Blocks can be retrieved via GetAutopeeringNeighbors(knownPeers bool) (*jsonmodels.GetNeighborsResponse, error)

neighbors, err := goshimAPI.GetAutopeeringNeighbors(false)
if err != nil {
    // return error
}

// will print the response
fmt.Println(string(neighbors))

Response examples

{
  "chosen": [
    {
      "id": "PtBSYhniWR2",
      "publicKey": "BogpestCotcmbB2EYKSsyVMywFYvUt1MwGh6nUot8g5X",
      "services": [
        {
          "id": "peering",
          "address": "178.254.42.235:14626"
        },
        {
          "id": "gossip",
          "address": "178.254.42.235:14666"
        }
      ]
    }
  ],
  "accepted": [
    {
      "id": "CRPFWYijV1T",
      "publicKey": "GUdTwLDb6t6vZ7X5XzEnjFNDEVPteU7tVQ9nzKLfPjdo",
      "services": [
        {
          "id": "peering",
          "address": "35.214.101.88:14626"
        },
        {
          "id": "gossip",
          "address": "35.214.101.88:14666"
        }
      ]
    }
  ]
}

Results

• Returned type

Return field	Type	Description
known	[]Neighbor	List of known peers. Only returned when parameter is set.
chosen	[]Neighbor	List of chosen peers.
accepted	[]Neighbor	List of accepted peers.
error	string	Error block. Omitted if success.

• Type Neighbor

field	Type	Description
id	string	Comparable node identifier.
publicKey	string	Public key used to verify signatures.
services	[]PeerService	List of exposed services.

• Type PeerService

field	Type	Description
id	string	Type of service.
address	string	Network address of the service.