account_channels - XRPL

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

Returns payment channels where the account is the source on XRP Ledger.

Parameters

Parameter	Type	Required	Description
account	string	Yes	Account address
destination_account	string	No	Filter by destination
ledger_hash	string	No	Ledger hash
ledger_index	string/number	No	Ledger index or shortcut
limit	number	No	Maximum results
marker	object	No	Pagination marker

Request Example

cURL

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": "account_channels",
    "params": [{
        "account": "rN7n7otQDd6FczFgLdSqtcsAUxDkw6fzRH"
    }],
    "id": "getblock.io"
}'

JavaScript (Axios)

request.js

const axios = require('axios');

const url = 'https://shared.eu-central-1.getblock.io/<ACCESS_TOKEN>/';
const headers = {
    'x-api-key': 'YOUR-API-KEY',
    'Content-Type': 'application/json'
};

const payload = {
    jsonrpc: '2.0',
    method: 'account_channels',
    params: [{
        account: 'rN7n7otQDd6FczFgLdSqtcsAUxDkw6fzRH'
    }],
    id: 'getblock.io'
};

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

Python

request.py

import requests

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

payload = {
    "jsonrpc": "2.0",
    "method": "account_channels",
    "params": [{
        "account": "rN7n7otQDd6FczFgLdSqtcsAUxDkw6fzRH"
    }],
    "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": "account_channels",
        "params": [{
            "account": "rN7n7otQDd6FczFgLdSqtcsAUxDkw6fzRH"
        }],
        "id": "getblock.io"
    });

    let response = client
        .post("https://shared.eu-central-1.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

response.json

{
    "result": {
        "account": "rN7n7otQDd6FczFgLdSqtcsAUxDkw6fzRH",
        "channels": [],
        "ledger_current_index": 102024783,
        "status": "success",
        "validated": false
    }
}

Response Parameters

Parameter	Type	Description
channels	array	Payment channels
channel_id	string	Channel identifier
amount	string	Total allocated
balance	string	Amount paid out

Field	Type	Description
account	string	Source account
channels	array	Payment channel list
ledger_current_index	integer	Current ledger index

Use Cases

• List payment channels

• Monitor channel balances

• Track streaming payments

Error Handling

Error Code	Description
actNotFound	Account not found
invalidParams	Invalid parameters

SDK Integration

xrpl.js

xrpl.js example

const xrpl = require('xrpl');

async function getChannels() {
    const client = new xrpl.Client('wss://xrplcluster.com');
    await client.connect();
    
    const response = await client.request({
        command: 'account_channels',
        account: 'rN7n7otQDd6FczFgLdSqtcsAUxDkw6fzRH'
    });
    
    console.log('Channels:', response.result.channels);
    await client.disconnect();
}

getChannels();

xrpl-py

xrpl-py example

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

client = JsonRpcClient("https://xrp.getblock.io/mainnet/")
request = AccountChannels(account="rN7n7otQDd6FczFgLdSqtcsAUxDkw6fzRH")
response = client.request(request)
print(response.result)