gateway_balances

POST

wss://xrp.nownodes.io/wss/{api_key}

Calculates the total balances issued by a given account, optionally excluding amounts held by operational addresses.

Connection URL:

Copied!

wss://xrp.nownodes.io/wss/{{api_key}}

Open the connection, then send the message below as a text frame.

Example:

Copied!

wscat -c 'wss://xrp.nownodes.io/wss/YOUR_API_KEY'
> {"id":"example_gateway_balances_1","command":"gateway_balances","account":"rMwjYedjc7qqtKYVLiAccJSmCwih4LnE2q","hotwallet":["rKm4uWpg9tfwbVSeATv4KxDe6mpE9yPkgJ","ra7JkEzrgeKHdzKgo4EUUVBnxggY4z37kt"],"ledger_index":"validated"}

Body

application/json

object

Parameters

api_keystringrequiredpath

Your NOWNodes API key.

Response

200OK

A successful response.

gateway_balances

curl -X POST 'wss://xrp.nownodes.io/wss/{api_key}' \
  -H 'Content-Type: application/json' \
  -d '{
    "id": "example_gateway_balances_1",
    "command": "gateway_balances",
    "account": "rMwjYedjc7qqtKYVLiAccJSmCwih4LnE2q",
    "hotwallet": [
      "rKm4uWpg9tfwbVSeATv4KxDe6mpE9yPkgJ",
      "ra7JkEzrgeKHdzKgo4EUUVBnxggY4z37kt"
    ],
    "ledger_index": "validated"
  }'

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

const data = await response.json();

require 'net/http'
require 'json'

uri = URI('wss://xrp.nownodes.io/wss/{api_key}')
request = Net::HTTP::Post.new(uri)
request['Content-Type'] = 'application/json'
request.body = '{
    "id": "example_gateway_balances_1",
    "command": "gateway_balances",
    "account": "rMwjYedjc7qqtKYVLiAccJSmCwih4LnE2q",
    "hotwallet": [
      "rKm4uWpg9tfwbVSeATv4KxDe6mpE9yPkgJ",
      "ra7JkEzrgeKHdzKgo4EUUVBnxggY4z37kt"
    ],
    "ledger_index": "validated"
  }'

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

import requests

payload = {
  "id": "example_gateway_balances_1",
  "command": "gateway_balances",
  "account": "rMwjYedjc7qqtKYVLiAccJSmCwih4LnE2q",
  "hotwallet": [
    "rKm4uWpg9tfwbVSeATv4KxDe6mpE9yPkgJ",
    "ra7JkEzrgeKHdzKgo4EUUVBnxggY4z37kt"
  ],
  "ledger_index": "validated"
}

response = requests.post('wss://xrp.nownodes.io/wss/{api_key}', json=payload)
data = response.json()

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

const data = await response.json();

const endpoint = "wss://xrp.nownodes.io/wss/{api_key}";
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({
    "id": "example_gateway_balances_1",
    "command": "gateway_balances",
    "account": "rMwjYedjc7qqtKYVLiAccJSmCwih4LnE2q",
    "hotwallet": [
      "rKm4uWpg9tfwbVSeATv4KxDe6mpE9yPkgJ",
      "ra7JkEzrgeKHdzKgo4EUUVBnxggY4z37kt"
    ],
    "ledger_index": "validated"
  });
console.log(result);

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

const data = await response.json();

import requests

payload = {
  "id": "example_gateway_balances_1",
  "command": "gateway_balances",
  "account": "rMwjYedjc7qqtKYVLiAccJSmCwih4LnE2q",
  "hotwallet": [
    "rKm4uWpg9tfwbVSeATv4KxDe6mpE9yPkgJ",
    "ra7JkEzrgeKHdzKgo4EUUVBnxggY4z37kt"
  ],
  "ledger_index": "validated"
}

response = requests.post('wss://xrp.nownodes.io/wss/{api_key}', json=payload)
data = response.json()

require 'net/http'
require 'json'

uri = URI('wss://xrp.nownodes.io/wss/{api_key}')
request = Net::HTTP::Post.new(uri)
request['Content-Type'] = 'application/json'
request.body = '{
    "id": "example_gateway_balances_1",
    "command": "gateway_balances",
    "account": "rMwjYedjc7qqtKYVLiAccJSmCwih4LnE2q",
    "hotwallet": [
      "rKm4uWpg9tfwbVSeATv4KxDe6mpE9yPkgJ",
      "ra7JkEzrgeKHdzKgo4EUUVBnxggY4z37kt"
    ],
    "ledger_index": "validated"
  }'

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

Request Body

{
  "id": "example_gateway_balances_1",
  "command": "gateway_balances",
  "account": "rMwjYedjc7qqtKYVLiAccJSmCwih4LnE2q",
  "hotwallet": [
    "rKm4uWpg9tfwbVSeATv4KxDe6mpE9yPkgJ",
    "ra7JkEzrgeKHdzKgo4EUUVBnxggY4z37kt"
  ],
  "ledger_index": "validated"
}

200

{
  "id": "example_gateway_balances_1",
  "result": {
    "account": "rMwjYedjc7qqtKYVLiAccJSmCwih4LnE2q",
    "assets": {
      "r9F6wk8HkXrgYWoJ7fsv4VrUBVoqDVtzkH": [
        {
          "currency": "BTC",
          "value": 5.44416651e-11
        }
      ],
      "rPU6VbckqCLW4kb51CWqZdxvYyQrQVsnSj": [
        {
          "currency": "BTC",
          "value": 1.0299e-11
        }
      ],
      "rpR95n1iFkTqpoy1e878f4Z1pVHVtWKMNQ": [
        {
          "currency": "BTC",
          "value": 4e-15
        }
      ],
      "rwmUaXsWtXU4Z843xSYwgt1is97bgY8yj6": [
        {
          "currency": "BTC",
          "value": 8.7e-15
        }
      ]
    },
    "balances": {
      "rKm4uWpg9tfwbVSeATv4KxDe6mpE9yPkgJ": [
        {
          "currency": "EUR",
          "value": "144816.1965999999"
        }
      ],
      "ra7JkEzrgeKHdzKgo4EUUVBnxggY4z37kt": [
        {
          "currency": "USD",
          "value": "6677.38614"
        }
      ]
    },
    "frozen_balances": {
      "r4keXr5myiU4iTLh68ZqZ2CgsJ8dM9FSW6": [
        {
          "currency": "BTC",
          "value": "0.091207822800868"
        }
      ]
    },
    "ledger_hash": "77D418838128CB6C45FBF5E4D26967216F68CF67BEDB3A64BF71AF99D893C8E9",
    "ledger_index": 100669526,
    "obligations": {
      "BTC": "1761.964986208178",
      "EUR": "813788.3511514511",
      "GBP": "4973.797603049582",
      "USD": "6734897.609769505"
    },
    "validated": true
  },
  "status": "success",
  "type": "response"
}