getmemoryinfo - Bitcoin

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

This method returns information about memory usage, either as a human-readable summary or as raw malloc statistics depending on the mode.

Parameters

Parameter	Type	Required	Description
mode	string	No	"stats" for a summary or "mallocinfo" for raw XML (default: "stats")

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": "getmemoryinfo",
    "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: 'getmemoryinfo',
    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': 'getmemoryinfo',
        '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": "getmemoryinfo",
            "params": [],
            "id": "getblock.io"
        }))
        .send()
        .await?
        .json::<Value>()
        .await?;

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

Response

{
    "jsonrpc": "2.0",
    "id": "getblock.io",
    "result": {
        "locked": {
            "used": 98304,
            "free": 32768,
            "total": 131072,
            "locked": 131072,
            "chunks_used": 384,
            "chunks_free": 8
        }
    }
}

Response Parameters

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

locked

Field	Type	Description
used	number	Bytes used in the locked memory pool
free	number	Bytes free in the locked memory pool
total	number	Total bytes in the locked memory pool
locked	number	Bytes locked in RAM (not paged to disk)

Use Cases

• Resource Monitoring: Track node memory usage

• Capacity Planning: Size infrastructure for a node

• Diagnostics: Investigate memory pressure

• Operations: Alert on memory limits

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