For the complete documentation index, see llms.txt. This page is also available as Markdown.

net_listening - GIWA

Example code for the net_listening JSON-RPC method. Complete guide on how to use net_listening JSON-RPC in GetBlock Web3 documentation.

This method returns a boolean indicating whether the client is actively listening for network connections. It is used as a lightweight liveness check for an endpoint.

Parameters

This method does not require any parameters. Send the request with an empty params array.

Request

curl --location --request POST 'https://shared.ap-southeast-1.getblock.io/<ACCESS-TOKEN>/' \
--header 'Content-Type: application/json' \
--data-raw '{
    "jsonrpc": "2.0",
    "method": "net_listening",
    "params": [],
    "id": "getblock.io"
}'
example.js
const axios = require('axios');

const response = await axios.post('https://shared.ap-southeast-1.getblock.io/<ACCESS-TOKEN>/', {
    jsonrpc: '2.0',
    method: 'net_listening',
    params: [],
    id: 'getblock.io'
}, {
    headers: { 'Content-Type': 'application/json' }
});

console.log(response.data.result);
example.py
import requests

response = requests.post(
    'https://shared.ap-southeast-1.getblock.io/<ACCESS-TOKEN>/',
    headers={'Content-Type': 'application/json'},
    json={
        'jsonrpc': '2.0',
        'method': 'net_listening',
        'params': [],
        'id': 'getblock.io'
    }
)

print(response.json())

Response

{
    "jsonrpc": "2.0",
    "id": "getblock.io",
    "result": true
}

Response Parameters

Parameter
Type
Description

jsonrpc

string

JSON-RPC protocol version ("2.0")

id

string

Request identifier matching the request

result

boolean

true if the client is listening for peer connections

Use Cases

  • Liveness Probes: Confirm an endpoint is reachable in a health-check loop

  • Failover Logic: Route requests away from a node that reports it is not listening

  • Monitoring: Alert when a node stops accepting peer connections

  • Connection Checks: Validate connectivity before opening a WebSocket subscription

Error Handling

Error Code
Message
Description

-32603

Internal error

The node failed to report its listening status

-32601

Method not found

The net module is disabled on the client build

Web3 Integration

Last updated

Was this helpful?