gateway_balances

POST

https://xrp.nownodes.io/

Authorizations

ApiKeyAuthApiKeyAuth

api-key string

NOWNodes API key passed in the api-key header.

Calculates the total balances issued by a given account, optionally excluding amounts held by operational addresses (hot wallets). This method is primarily used by gateway operators to calculate their net obligations to users.

Body

application/json

JSON-RPC request payload.

methodstringgateway_balancesrequired

The JSON-RPC method name

paramsArray<object>required

Ordered JSON-RPC method parameters.

Show child attributes

accountstringrequired

The unique identifier of the gateway's issuing address, typically an XRP Ledger address in base58 format. This is the account that issues the currencies (the gateway operator).

hotwalletArray<string>

(Optional) An array of operational addresses (hot wallets) to exclude from the balances. Amounts held by these addresses are not counted as obligations to users.

ledger_hashstring

(Optional) A 20-byte hex string identifying a specific ledger version to use for the request.

ledger_indexstringvalidatedclosedcurrent

The ledger index of the ledger to use for the request.

"validated": The most recent validated ledger (recommended for accurate balances)
"closed": The most recent closed ledger
"current": The current working ledger

strictboolean

If true, only accept a public key or XRP Ledger address for the account parameter.

Response

200OK

HTTP 200 response for gateway_balances. The body contains either a successful result or a method-level JSON-RPC error.

400Bad Request

Bad Request. The request body is malformed or contains invalid JSON-RPC parameters.

401Unauthorized

Unauthorized: API key is present but rejected by the NOWNodes gateway.

405Method Not Allowed

Method Not Allowed. Returned by the NOWNodes gateway for malformed or unsupported gateway-level requests.

422Unprocessable Entity

Missing API key. The NOWNodes gateway returns plain text for this error.

500Internal Server Error

Internal Server Error. The gateway or node failed while processing the request.

gateway_balances

curl -X POST 'https://xrp.nownodes.io/' \
  -H 'Content-Type: application/json' \
  -d '{
    "method": "gateway_balances",
    "params": [
      {
        "account": "rMwjYedjc7qqtKYVLiAccJSmCwih4LnE2q",
        "hotwallet": [
          "rKm4uWpg9tfwbVSeATv4KxDe6mpE9yPkgJ",
          "ra7JkEzrgeKHdzKgo4EUUVBnxggY4z37kt"
        ],
        "ledger_index": "validated",
        "strict": true
      }
    ]
  }'

import { JsonRpcProvider } from "ethers";

const provider = new JsonRpcProvider("https://xrp.nownodes.io/");
const result = await provider.send("gateway_balances", [
  {
    "account": "rMwjYedjc7qqtKYVLiAccJSmCwih4LnE2q",
    "hotwallet": [
      "rKm4uWpg9tfwbVSeATv4KxDe6mpE9yPkgJ",
      "ra7JkEzrgeKHdzKgo4EUUVBnxggY4z37kt"
    ],
    "ledger_index": "validated",
    "strict": true
  }
]);
console.log(result);

require 'eth'
require 'json'
require 'net/http'

uri = URI('https://xrp.nownodes.io/')
request = Net::HTTP::Post.new(uri)
request['Content-Type'] = 'application/json'
request.body = '{
  "jsonrpc": "2.0",
  "method": "gateway_balances",
  "params": [
    {
      "account": "rMwjYedjc7qqtKYVLiAccJSmCwih4LnE2q",
      "hotwallet": [
        "rKm4uWpg9tfwbVSeATv4KxDe6mpE9yPkgJ",
        "ra7JkEzrgeKHdzKgo4EUUVBnxggY4z37kt"
      ],
      "ledger_index": "validated",
      "strict": true
    }
  ],
  "id": 1
}'

response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) do |http|
  http.request(request)
end

puts JSON.parse(response.body)

from web3 import Web3

w3 = Web3(Web3.HTTPProvider("https://xrp.nownodes.io/"))
response = w3.provider.make_request("gateway_balances", [
  {
    "account": "rMwjYedjc7qqtKYVLiAccJSmCwih4LnE2q",
    "hotwallet": [
      "rKm4uWpg9tfwbVSeATv4KxDe6mpE9yPkgJ",
      "ra7JkEzrgeKHdzKgo4EUUVBnxggY4z37kt"
    ],
    "ledger_index": "validated",
    "strict": True
  }
])
print(response)

import { createPublicClient, http } from "viem";

const client = createPublicClient({
  transport: http("https://xrp.nownodes.io/"),
});

const result = await client.request({
  method: "gateway_balances",
  params: [
  {
    "account": "rMwjYedjc7qqtKYVLiAccJSmCwih4LnE2q",
    "hotwallet": [
      "rKm4uWpg9tfwbVSeATv4KxDe6mpE9yPkgJ",
      "ra7JkEzrgeKHdzKgo4EUUVBnxggY4z37kt"
    ],
    "ledger_index": "validated",
    "strict": true
  }
],
});

console.log(result);

const endpoint = "https://xrp.nownodes.io/";
const apiKey = "YOUR_API_KEY";

async function nownodesRequest(payload) {
  const response = await fetch(endpoint, {
    method: "POST",
    headers: {
      "Content-Type": "application/json",
      "api-key": apiKey,
    },
    body: JSON.stringify(payload),
  });

  return response.json();
}

const result = await nownodesRequest({ jsonrpc: "2.0", method: "gateway_balances", params: [
  {
    "account": "rMwjYedjc7qqtKYVLiAccJSmCwih4LnE2q",
    "hotwallet": [
      "rKm4uWpg9tfwbVSeATv4KxDe6mpE9yPkgJ",
      "ra7JkEzrgeKHdzKgo4EUUVBnxggY4z37kt"
    ],
    "ledger_index": "validated",
    "strict": true
  }
], id: 1 });
console.log(result);

const response = await fetch('https://xrp.nownodes.io/', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
      "method": "gateway_balances",
      "params": [
        {
          "account": "rMwjYedjc7qqtKYVLiAccJSmCwih4LnE2q",
          "hotwallet": [
            "rKm4uWpg9tfwbVSeATv4KxDe6mpE9yPkgJ",
            "ra7JkEzrgeKHdzKgo4EUUVBnxggY4z37kt"
          ],
          "ledger_index": "validated",
          "strict": true
        }
      ]
    }),
});

const data = await response.json();

import requests

payload = {
  "method": "gateway_balances",
  "params": [
    {
      "account": "rMwjYedjc7qqtKYVLiAccJSmCwih4LnE2q",
      "hotwallet": [
        "rKm4uWpg9tfwbVSeATv4KxDe6mpE9yPkgJ",
        "ra7JkEzrgeKHdzKgo4EUUVBnxggY4z37kt"
      ],
      "ledger_index": "validated",
      "strict": True
    }
  ]
}

response = requests.post('https://xrp.nownodes.io/', json=payload)
data = response.json()

require 'net/http'
require 'json'

uri = URI('https://xrp.nownodes.io/')
request = Net::HTTP::Post.new(uri)
request['Content-Type'] = 'application/json'
request.body = '{
    "method": "gateway_balances",
    "params": [
      {
        "account": "rMwjYedjc7qqtKYVLiAccJSmCwih4LnE2q",
        "hotwallet": [
          "rKm4uWpg9tfwbVSeATv4KxDe6mpE9yPkgJ",
          "ra7JkEzrgeKHdzKgo4EUUVBnxggY4z37kt"
        ],
        "ledger_index": "validated",
        "strict": true
      }
    ]
  }'

response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }
data = JSON.parse(response.body)

Request Body

{
  "method": "gateway_balances",
  "params": [
    {
      "account": "rMwjYedjc7qqtKYVLiAccJSmCwih4LnE2q",
      "hotwallet": [
        "rKm4uWpg9tfwbVSeATv4KxDe6mpE9yPkgJ",
        "ra7JkEzrgeKHdzKgo4EUUVBnxggY4z37kt"
      ],
      "ledger_index": "validated",
      "strict": true
    }
  ]
}

{
  "result": {
    "ledger_index": 105281656,
    "status": "success",
    "validated": true
  }
}

{
  "result": {
    "error": "invalidParams",
    "error_code": 31,
    "error_message": "Invalid parameters.",
    "request": {
      "method": "gateway_balances",
      "params": [
        {}
      ]
    },
    "status": "error"
  }
}

{
  "code": 400,
  "message": "Bad Request"
}

Unknown API_key

Method Not Allowed

Missing API_key

{
  "code": 500,
  "message": "Internal Server Error"
}

Documentation

How to migrate to NOWNodes

gateway_balances

Authorizations

Body

Response