subscribe - XPRL

Example code for the subscribe JSON RPC method. Complete guide to using subscribe JSON-RPC in the GetBlock Web3 documentation.

This method requests periodic notifications from the server when certain events happen.

Parameters

Parameter	Type	Required	Description
streams	array	No	Streams to subscribe
accounts	array	No	Accounts to watch
accounts_proposed	array	No	Accounts for proposed txs
books	array	No	Order books to watch

Request Example

cURL

curl --location --request POST 'https://xrp.getblock.io/mainnet/' \
--header 'x-api-key: YOUR-API-KEY' \
--header 'Content-Type: application/json' \
--data-raw '{
    "jsonrpc": "2.0",
    "method": "subscribe",
    "params": [{
        "streams": ["ledger"]
    }],
    "id": "getblock.io"
}'

JavaScript (Axios)

Python

Rust

Response Example

{
    "result": {
        "fee_base": 10,
        "fee_ref": 10,
        "ledger_hash": "3A0B41C31B13436610C5961E2C914529CAD3CCC4A7859ED6AABFCD0700847BC1",
        "ledger_index": 63632030,
        "ledger_time": 674581032,
        "reserve_base": 10000000,
        "reserve_inc": 2000000,
        "status": "success"
    }
}

Response Parameters

Parameter	Type	Description
ledger_index	number	Current ledger
status	string	Subscription status

Use Cases

• Real-time ledger updates

• Monitor account activity

• Track order book changes

Error Handling

Error Code	Description
invalidParams	Invalid parameters

SDK Integration

xrpl.js

const xrpl = require('xrpl');

async function subscribe() {
    const client = new xrpl.Client('wss://xrplcluster.com');
    await client.connect();
    
    client.on('ledgerClosed', ledger => {
        console.log('New ledger:', ledger.ledger_index);
    });
    
    await client.request({
        command: 'subscribe',
        streams: ['ledger']
    });
}

subscribe();

xrpl-py