gateway_balances - XRPL

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

Returns gateway balances on XRP Ledger.

Parameters

Parameter

Type

Required

Description

account

string

Yes

Gateway account

strict

boolean

Fail if not valid address

hotwallet

string/array

Operational wallets

ledger_hash

string

Ledger hash

ledger_index

string/number

Ledger index

Request Example

Request (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": "gateway_balances",
    "params": [{
        "account": "rN7n7otQDd6FczFgLdSqtcsAUxDkw6fzRH",
        "strict": true
    }],
    "id": "getblock.io"
}'

Request (JavaScript - Axios)

const axios = require('axios');

const url = 'https://xrp.getblock.io/mainnet/';
const headers = {
    'x-api-key': 'YOUR-API-KEY',
    'Content-Type': 'application/json'
};

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

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

Request (Python)

import requests

url = "https://xrp.getblock.io/mainnet/"
headers = {
    "x-api-key": "YOUR-API-KEY",
    "Content-Type": "application/json"
}

payload = {
    "jsonrpc": "2.0",
    "method": "gateway_balances",
    "params": [{
        "account": "rN7n7otQDd6FczFgLdSqtcsAUxDkw6fzRH",
        "strict": True
    }],
    "id": "getblock.io"
}

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

Request (Rust)

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": "gateway_balances",
        "params": [{
            "account": "rN7n7otQDd6FczFgLdSqtcsAUxDkw6fzRH",
            "strict": true
        }],
        "id": "getblock.io"
    });

    let response = client
        .post("https://xrp.getblock.io/mainnet/")
        .header("x-api-key", "YOUR-API-KEY")
        .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",
        "ledger_current_index": 63632030,
        "obligations": {
            "USD": "100000"
        },
        "status": "success"
    }
}

Response Parameters

Field

Type

Description

account

string

Gateway account

obligations

object

Total obligations

balances

object

Hotwallet balances

assets

object

Assets held

Use Cases

Gateway accounting
Track issued currencies
Monitor obligations

Error Handling

actNotFound

Account not found

invalidParams

Invalid parameters

SDK Integration

xrpl.js example

const xrpl = require('xrpl');

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

getGatewayBalances();

xrpl-py example

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

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

Previoussubmit - XPRL Nextsign_for - XRPL

Last updated 6 days ago

Was this helpful?

hashtagParameters

hashtagRequest Example

hashtagResponse Example

hashtagResponse Parameters

hashtagUse Cases

hashtagError Handling

hashtagSDK Integration

Parameters

Request Example

Response Example

Response Parameters

Use Cases

Error Handling

SDK Integration