net_peerCount | Aurora

Aurora API method that returns the number of peers connected to the node. This method can be useful for developers who want to monitor their node's connectivity and ensure it functions as expected. By checking the number of connected peers, developers can verify that their node receives updates and is properly synchronized with the network.

👍

Get you own node endpoint today

Start for free and get your app to production levels immediately. No credit card required.

You can sign up with your GitHub, X, Google, or Microsoft account.

Parameters

• none

Response

• quantity — an integer value indicating the current number of peers connected to the node

net_peerCount code examples

const { Web3 } = require("web3");
const NODE_URL = "CHAINSTACK_NODE_URL";
const web3 = new Web3(NODE_URL);

async function getPeers() {
  const peers = await web3.eth.net.getPeerCount()
  console.log(peers);
}

getPeers();

const ethers = require('ethers');
const NODE_URL = "CHAINSTACK_NODE_URL";
const provider = new ethers.JsonRpcProvider(NODE_URL);

const peersCount = async () => {
  const peers = await provider.send("net_peerCount");
  console.log(`Peers connected: ${peers}`);
}

peersCount()

from web3 import Web3  
node_url = "CHAINSTACK_NODE_URL"
web3 = Web3.HTTPProvider(node_url)

peers = web3.provider.make_request('net_peerCount', [])
print(peers)

Use case

One practical use case for the net_peerCount method is to monitor the number of peers connected to a node and take some action if the number drops below a certain threshold. For example, a developer might want to send a notification to check the node if the peer count is low for more than 10 minutes.

Try the net_peerCount RPC method yourself