Skip to main content

/node/network REST API Endpoint

Returns network related information of the node.

Updated on
Sep 02, 2024

Parameters

This method does not accept any parameters

Returns

nodeRoles
string | array

Indicates the role of the node in the network

numPeers
string

Represents the number of peer connections the node currently has

isSyncing
boolean

A boolean value indicating whether the node is currently synchronizing

shouldHavePeers
boolean

A boolean value indicating whether the node is expected to have peer connections

localPeerId
string

The unique identifier of the node within the peer-to-peer network

localListenAddresses
array

An array of network addresses where the node is listening for connections

peersInfo
string | array

Peer details as a JSON-encoded string or an array of peer objects, where each peer object includes:

peerId
string

The unique identifier of the peer node

roles
string

The roles assigned to the peer node in the network

protocolVersion
string

The protocol version the peer is using

bestHash
string

The hash of the best block that the peer has seen

bestNumber
string

The number of the best block that the peer has seen

Request
Don't have an account yet?
Create your Quicknode endpoint in seconds and start building
Get started for free