gateway_balances RPC Method

Parameters

account

string

REQUIRED

The account for which balances are to be retrieved

hotwallet

string

An operational address or an array of operational addresses to be excluded from the issued balances

ledger_index

string

The index of the ledger to retrieve the balances from

ledger_hash

string

A 20-byte hex string for identifying the ledger version

strict

boolean

A boolean flag indicating whether strict validation should be applied

Returns

result

object

An object which contains the following fields:

account

string

The account for which balances were retrieved

obligations

array

(Omitted if empty) The total amounts issued to addresses not excluded are returned as a map of currencies to the total value issued

balances

array

(Omitted if empty) The amounts issued to the hot wallet addresses specified in the request are returned as a separate field

assets

array

(Omitted if empty) Total amounts held that are issued by others

ledger_index

integer

The index of the ledger from which balances were retrieved

ledger_hash

string

The hash of the ledger containing the balances

ledger_current_index

string

Omitted if ledger_current_index is provided) The ledger index of the current in-progress ledger version used to retrieve this information

validated

boolean

Indicates if the information is from a validated ledger

status

string

The status of the request

warnings

array

An object of warning which contain the following fields:

id

integer

The ID of the warning

message

string

The warning message

Request

curl https://docs-demo.xrp-mainnet.quiknode.pro/ \
  -X POST \
  -H "Content-Type: application/json" \
  --data '{
    "method": "gateway_balances",
	"params": [{
        "account": "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn",
        "ledger_index": "validated",
        "strict": true
    }],"id":1,"jsonrpc":"2.0"}'

var myHeaders = new Headers();
myHeaders.append("Content-Type", "application/json");

var raw = JSON.stringify({
  "method": "gateway_balances",
  "params": [
    {
      "account": "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn",
      "ledger_index": "validated",
      "strict": true
    }
  ],
  "id": 1,
  "jsonrpc": "2.0"
});

var requestOptions = {
  method: 'POST',
  headers: myHeaders,
  body: raw,
  redirect: 'follow'
};

fetch("https://docs-demo.xrp-mainnet.quiknode.pro/", requestOptions)
  .then(response => response.text())
  .then(result => console.log(result))
  .catch(error => console.log('error', error));

import requests
import json

url = "https://docs-demo.xrp-mainnet.quiknode.pro/"

payload = json.dumps({
  "method": "gateway_balances",
  "params": [
    {
      "account": "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn",
      "ledger_index": "validated",
      "strict": True
    }
  ],
  "id": 1,
  "jsonrpc": "2.0"
})
headers = {
  'Content-Type': 'application/json'
}

response = requests.request("POST", url, headers=headers, data=payload)

print(response.text)

require "uri"
require "json"
require "net/http"

url = URI("https://docs-demo.xrp-mainnet.quiknode.pro/")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = "application/json"
request.body = JSON.dump({
  "method": "gateway_balances",
  "params": [
    {
      "account": "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn",
      "ledger_index": "validated",
      "strict": true
    }
  ],
  "id": 1,
  "jsonrpc": "2.0"
})

response = https.request(request)
puts response.read_body

Don't have an account yet?

Create your QuickNode endpoint in seconds and start building

Get started for free