xrp

XRP (XRP)

Method: POST gateway_balances

dropdown
POST

gateway_balances

The gateway_balances command calculates the total balances issued by a given account, optionally excluding amounts held by operational addresses.

Parameters

account - String

The unique identifier of an account, typically the account's Address.

The request returns channels where this account is the channel's owner/source.

strict - Boolean

(Optional) If true, then the account field only accepts a public key or XRP Ledger address.

Otherwise, account can be a secret or passphrase (not recommended).

The default is false.

hotwallet - String or Array

(Optional) An operational address to exclude from the balances issued, or an array of such addresses.

ledger_hash - String

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

ledger_index - String or Unsigned Integer

(Optional) The ledger index of the ledger to use, or a shortcut string to choose a ledger automatically.

Request

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"}],
"id": "getblock.io"}'


Response

{
    "result": {
        "account": "rN7n7otQDd6FczFgLdSqtcsAUxDkw6fzRH",
        "ledger_current_index": 63631836,
        "status": "success",
        "validated": false
    }
}