Get information about a given peer.

GET 
http://127.0.0.1:14265/api/core/v2/peers/:peerId

Get information about a given peer.

Request

Path Parameters

peerId stringrequired
Identifier of the block.
Example: 12D3KooWMajsSUxSUFb3CRgmJvygYCGd27uMDdppVYNGud7xuKG5

Responses

200

Successful operation.

application/json

Schema

Schema

allOf Peer

The peer of a node.

id stringrequired

The identifier of the peer.

multiAddresses string[]required

The addresses of the peer.

alias string

The alias of the peer.

relation stringrequired

Possible values: [known, unknown, autopeered]

connected booleanrequired

Tells whether the peer is connected or not.

gossip Gossip

Information about the gossip stream with the peer.

heartbeat Heartbeatnullablerequired

Information about the most recent heartbeat of the peer. The heartbeat is null if none has been received yet.

solidMilestoneIndex integerrequired

The most recent milestone that has been solidified by the node.

prunedMilestoneIndex integerrequired

Tells from which starting point the node holds data.

latestMilestoneIndex integerrequired

The most recent milestone known to the node.

connectedNeighbors integerrequired

Tells how many connected peers the node has.

syncedNeighbors integerrequired

Tells how many synced peers the node has.

metrics Metricsrequired

Metrics about the gossip stream with the peer.

newBlocks integerrequired

The number of received blocks that were new for the node.

knownBlocks integerrequired

The number of received blocks that already were known to the node.

receivedBlocks integerrequired

The number of received blocks from the peer.

receivedBlockRequests integerrequired

The number of received block requests from the peer.

receivedMilestoneRequests integerrequired

The number of received milestone requests from the peer.

receivedHeartbeats integerrequired

The number of received heartbeats from the peer.

sentBlocks integerrequired

The number of sent blocks to the peer.

sentBlockRequests integerrequired

The number of sent block requests to the peer.

sentMilestoneRequests integerrequired

The number of sent milestone requests to the peer.

sentHeartbeats integerrequired

The number of sent heartbeats to the peer.

droppedPackets integerrequired

The number of dropped packets.

Example (from schema)

{
  "allOf": {
    "id": "string",
    "multiAddresses": [
      "string"
    ],
    "alias": "string",
    "relation": "known",
    "connected": true,
    "gossip": {
      "heartbeat": {
        "solidMilestoneIndex": 0,
        "prunedMilestoneIndex": 0,
        "latestMilestoneIndex": 0,
        "connectedNeighbors": 0,
        "syncedNeighbors": 0
      },
      "metrics": {
        "newBlocks": 0,
        "knownBlocks": 0,
        "receivedBlocks": 0,
        "receivedBlockRequests": 0,
        "receivedMilestoneRequests": 0,
        "receivedHeartbeats": 0,
        "sentBlocks": 0,
        "sentBlockRequests": 0,
        "sentMilestoneRequests": 0,
        "sentHeartbeats": 0,
        "droppedPackets": 0
      }
    }
  }
}

default

{
  "id": "12D3KooWMajsSUxSUFb3CRgmJvygYCGd27uMDdppVYNGud7xuKG5",
  "multiAddresses": [
    "/dns/abc.com/tcp/15602"
  ],
  "alias": "abc",
  "relation": "known",
  "connected": true,
  "gossip": {
    "heartbeat": {
      "solidMilestoneIndex": 61527,
      "prunedMilestoneIndex": 61200,
      "latestMilestoneIndex": 61527,
      "connectedNeighbors": 5,
      "syncedNeighbors": 7
    },
    "metrics": {
      "newBlocks": 3799,
      "knownBlocks": 554,
      "receivedBlocks": 4370,
      "receivedBlockRequests": 0,
      "receivedMilestoneRequests": 1,
      "receivedHeartbeats": 1,
      "sentBlocks": 6,
      "sentBlockRequests": 4325,
      "sentMilestoneRequests": 31,
      "sentHeartbeats": 9,
      "droppedPackets": 0
    }
  }
}

400

Unsuccessful operation: indicates that the provided data is invalid.

application/json

Schema

Schema

error objectrequired

code stringrequired

The application error code.

message stringrequired

The error reason.

Example (from schema)

{
  "error": {
    "code": 400,
    "message": "invalid data provided"
  }
}

403

Unsuccessful operation: indicates that the endpoint is not available for public use.

application/json

Schema

Schema

error objectrequired

code stringrequired

The application error code.

message stringrequired

The error reason.

Example (from schema)

{
  "error": {
    "code": 403,
    "message": "not available for public use"
  }
}

404

Unsuccessful operation: indicates that the requested data was not found.

application/json

Schema

Schema

error objectrequired

code stringrequired

The application error code.

message stringrequired

The error reason.

Example (from schema)

{
  "error": {
    "code": 404,
    "message": "could not find data"
  }
}

500

Unsuccessful operation: indicates that an unexpected, internal server error happened which prevented the node from fulfilling the request.

application/json

Schema

Schema

error objectrequired

code stringrequired

The application error code.

message stringrequired

The error reason.

Example (from schema)

{
  "error": {
    "code": 500,
    "message": "internal server error"
  }
}

• curl
• python
• go
• nodejs
• ruby
• csharp
• php
• java
• powershell

• CURL

curl -L -X GET 'http://127.0.0.1:14265/api/core/v2/peers/:peerId' \
-H 'Accept: application/json'

Request Collapse all

Base URL

http://127.0.0.1:14265

Parameters

peerId — pathrequired

ResponseClear

Click the Send API Request button above and see the response here!