Balances and statements
Get ledger balances
Get balances for ledger owned by a RippleNet address.
get/monitor/ledger/balances
Request
- Base URL//[domainPrefix].ripplexcurrent.com/v4 (relative, and it does not resolve against the document’s source URL)
- AuthAPI key in header Authorization
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Response
Successfully returned balances.
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
}
]
}
]
}
]
}Changes
No recorded changes to this operation across all 1 revision of this API.