v1

latestOpenAPI 3.0.02026-08-06102185472.3 KB

Balances and statements

Get balances

Get balances for local and remote accounts owned by a RippleNet address.

get/monitor/balances

Response

Successfully returned balances.

errorsstring[] required

Lists any errors encountered when returning balance details.

Example response

{
  "local_balance": [
    {
      "institution": "rn.us.ca.san_francisco",
      "institution_address": "rn.us.ca.san_francisco",
      "currency_balances": [
        {
          "currency": "USD",
          "account_balances": [
            {
              "account_name": "trans_usd_sf",
              "balance": -909,
              "owner": "rn.us.ca.san_francisco",
              "currency": "USD",
              "minimum_allowed_balance": -1500000,
              "maximum_allowed_balance": 1000000,
              "low_liquidity_threshold": 1000,
              "owner_max_allowed_balance": 1000000
            }
          ]
        }
      ]
    }
  ],
  "remote_balances": [
    {
      "institution": "rn.us.ca.san_francisco",
      "institution_address": "rn.us.ca.san_francisco",
      "currency_balances": [
        {
          "currency": "USD",
          "account_balances": [
            {
              "account_name": "trans_usd_sf",
              "balance": -909,
              "owner": "rn.us.ca.san_francisco",
              "currency": "USD",
              "minimum_allowed_balance": -1500000,
              "maximum_allowed_balance": 1000000,
              "low_liquidity_threshold": 1000,
              "owner_max_allowed_balance": 1000000
            }
          ]
        }
      ]
    }
  ]
}