unsubscribe - XRPL

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

This method tells the server to stop sending messages for a particular subscription.

Parameters

Parameter	Type	Required	Description
streams	array	No	Streams to unsubscribe
accounts	array	No	Accounts to stop watching
accounts_proposed	array	No	Proposed tx accounts
books	array	No	Order books to stop watching

Request Example

cURL

cURL

curl --location --request POST 'https://go.getblock.io/<ACCESS_TOKEN>/' \

--header 'Content-Type: application/json' \
--data-raw '{
    "jsonrpc": "2.0",
    "method": "unsubscribe",
    "params": [{
        "streams": ["ledger"]
    }],
    "id": "getblock.io"
}'

JavaScript (Axios)

unsubscribe.js

const axios = require('axios');

const url = 'https://go.getblock.io/<ACCESS_TOKEN>/';
const headers = {
    'Content-Type': 'application/json'
};

const payload = {
    jsonrpc: '2.0',
    method: 'unsubscribe',
    params: [{
        streams: ['ledger']
    }],
    id: 'getblock.io'
};

axios.post(url, payload, { headers })
    .then(response => console.log(response.data))
    .catch(error => console.error(error));

Python

unsubscribe.py

import requests

url = "https://go.getblock.io/<ACCESS_TOKEN>/"
headers = {
    "Content-Type": "application/json"
}

payload = {
    "jsonrpc": "2.0",
    "method": "unsubscribe",
    "params": [{
        "streams": ["ledger"]
    }],
    "id": "getblock.io"
}

response = requests.post(url, headers=headers, json=payload)
print(response.json())

Rust

main.rs

use reqwest::Client;
use serde_json::json;

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let client = Client::new();
    
    let payload = json!({
        "jsonrpc": "2.0",
        "method": "unsubscribe",
        "params": [{
            "streams": ["ledger"]
        }],
        "id": "getblock.io"
    });

    let response = client
        .post("https://go.getblock.io/<ACCESS_TOKEN>/")
      
        .header("Content-Type", "application/json")
        .json(&payload)
        .send()
        .await?;

    let result: serde_json::Value = response.json().await?;
    println!("{:#?}", result);
    
    Ok(())
}

Response Example

{
    "result": {
        "status": "success"
    }
}

Response Parameters

Parameter	Type	Description
status	string	Unsubscribe status

Use Cases

• Stop receiving updates

• Clean up connections

• Resource management

Error Handling

Error Code	Description
invalidParams	Invalid parameters

SDK Integration

xrpl.js

xrpl.js (Node.js)

const xrpl = require('xrpl');

async function unsubscribe() {
    const client = new xrpl.Client('wss://xrplcluster.com');
    await client.connect();
    
    await client.request({
        command: 'unsubscribe',
        streams: ['ledger']
    });
    
    console.log('Unsubscribed');
    await client.disconnect();
}

unsubscribe();

xrpl-py

xrpl-py (Python)

from xrpl.clients import JsonRpcClient
from xrpl.models.requests import Unsubscribe

client = JsonRpcClient("https://xrp.getblock.io/mainnet/")
request = Unsubscribe(streams=["ledger"])
response = client.request(request)
print(response.result)