getrpcinfo - Bitcoin

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

This method returns runtime details about the RPC server, including the commands currently in progress and the path to the active logging file.

Parameters

This method does not accept any parameters.

Request

cURL

curl --location --request POST 'https://shared.eu-central-1.getblock.io/<ACCESS-TOKEN>/' \
--header 'Content-Type: application/json' \
--data-raw '{
    "jsonrpc": "2.0",
    "method": "getrpcinfo",
    "params": [],
    "id": "getblock.io"
}'

bitcoinjs-lib

example.js

const axios = require('axios');

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

console.log(response.data.result);

Request

example.py

import requests

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

print(response.json())

Rust

example.rs

use reqwest::Client;
use serde_json::{json, Value};

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let client = Client::new();

    let response = client
        .post("https://shared.eu-central-1.getblock.io/<ACCESS-TOKEN>/")
        .header("Content-Type", "application/json")
        .json(&json!({
            "jsonrpc": "2.0",
            "method": "getrpcinfo",
            "params": [],
            "id": "getblock.io"
        }))
        .send()
        .await?
        .json::<Value>()
        .await?;

    println!("Result: {}", response["result"]);
    Ok(())
}

Response

{
    "jsonrpc": "2.0",
    "id": "getblock.io",
    "result": {
        "active_commands": [
            {
                "method": "getrpcinfo",
                "duration": 0
            }
        ],
        "logpath": "/var/lib/bitcoind/debug.log"
    }
}

Response Parameters

Parameter	Type	Description
jsonrpc	string	JSON-RPC protocol version ("2.0")
id	string	Request identifier matching the request
result	object	RPC server information object

Result Object

Field	Type	Description
active_commands	array	Commands currently being processed
active_commands[].method	string	The method being processed
active_commands[].duration	number	Running time in microseconds
logpath	string	Path to the node's debug log

Use Cases

• Diagnostics: Inspect in-flight RPC commands

• Performance: Measure command durations

• Monitoring: Watch RPC server activity

• Operations: Locate the active log file

Error Handling

Error Code	Message	Description
403	Forbidden	Missing or invalid ACCESS-TOKEN
-8	Invalid parameter	A parameter is out of range or malformed
-32601	Method not found	The method is not available on this endpoint
-32602	Invalid params	A parameter is missing or has the wrong type