Honeycluster Docs – Get gateway issued balances

Account Methods

Get gateway issued balances

wss://honeycluster.io

rpc method: gateway_balances

Returns total amounts issued by an account (gateway), broken down by obligation, asset, and frozen balances.

Try it now

Response · gateway_balances WS Response

{
  "result": {
    "account": "rPT1Sjq2YGrBMTttX4GZHjKu9dyfzbpAYe",
    "assets": {},
    "balances": {},
    "ledger_index": 89012345,
    "obligations": {
      "USD": "5000",
      "EUR": "2000"
    }
  },
  "status": "success",
  "type": "response",
  "id": 1
}

Request Message

gateway_balances WS Request

application/json

Get gateway issued balances

Field	Type	Description
`command` required	string	WebSocket command name
`id`	object	Client-supplied identifier to correlate requests with responses.
`account`	string	The issuing account (gateway) to check.
`hotwallet`	object	Hot wallet account(s) to exclude from the calculations.
`strict`	boolean	If true, only accept an account address in the proper base58 format.
`ledger_index`	object	A ledger index (sequence number) or shortcut string identifying which ledger to use.
`ledger_hash`	string	256-bit hex hash identifying a specific ledger version.
`api_version`	object	API version for the response format. Version 2 is the default for rippled 2.0+.

Example

Json

{
  "command": "gateway_balances",
  "id": 1,
  "account": "rPT1Sjq2YGrBMTttX4GZHjKu9dyfzbpAYe",
  "hotwallet": [
    "rG1QQv2nh2gr7RCZ1P8YYcBUKCCN633jCn"
  ],
  "ledger_index": "validated"
}

Response Message

gateway_balances WS Response

application/json

WebSocket response for gateway_balances

Field	Type	Description
`result`	object
`status`	enum<string>	Available `successerror`
`type`	string
`id`	stringnumber	Echo of the client-provided correlation ID

Example

Json

{
  "result": {
    "account": "rPT1Sjq2YGrBMTttX4GZHjKu9dyfzbpAYe",
    "assets": {},
    "balances": {},
    "ledger_index": 89012345,
    "obligations": {
      "USD": "5000",
      "EUR": "2000"
    }
  },
  "status": "success",
  "type": "response",
  "id": 1
}

Request

Payload · JSON

const ws = new WebSocket('wss://honeycluster.io');

ws.addEventListener('open', () => {
  const request = {
    "command": "gateway_balances",
    "id": 1,
    "account": "rPT1Sjq2YGrBMTttX4GZHjKu9dyfzbpAYe",
    "hotwallet": [
      "rG1QQv2nh2gr7RCZ1P8YYcBUKCCN633jCn"
    ],
    "ledger_index": "validated"
  };
  ws.send(JSON.stringify(request));
});

ws.addEventListener('message', (event: MessageEvent<string>) => {
  const response: unknown = JSON.parse(event.data);
  console.log(response);
  ws.close();
});

Response · gateway_balances WS Response

{
  "result": {
    "account": "rPT1Sjq2YGrBMTttX4GZHjKu9dyfzbpAYe",
    "assets": {},
    "balances": {},
    "ledger_index": 89012345,
    "obligations": {
      "USD": "5000",
      "EUR": "2000"
    }
  },
  "status": "success",
  "type": "response",
  "id": 1
}