---
title: "Get balances"
method: GET
path: "/monitor/balances"
tags: ["Balances and statements"]
---

# Get balances

`GET /monitor/balances`

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

## Response `200`

Successfully returned balances.

- Balances — Provides balances for all accounts owned by a RippleNet address.
  - `local_balance` InstitutionBalance[], required — Provides balance details for accounts owned by a RippleNet address.
    - `institution` string, required — RippleNet unique internal ID of the institution that owns the balances provided in the `currency_balances` array.
    - `institution_address` string, required — RippleNet address of the institution that owns the balances provided in the `currency_balances` array.
    - `currency_balances` CurrencyBalance[], required — Provides balance details for accounts owned by a RippleNet address. The response does not guarantee a fixed number of elements, or a fixed order of elements, in the returned list.
      - `currency` string, required — Currency of the balances provided.
      - `aggregate_balance` number, required — Aggregated balance for the given currrency.
      - `account_balances` AccountBalance[], required — Provides balance details for accounts that support the given currency.
        - `account_name` string — Name of the account, which acts as the account's unique identifier on RippleNet.
        - `balance` number — Balance available in the account.
        - `owner` string — RippleNet address of the owner of the account.
        - `currency` string — Currency supported by the account.
        - `minimum_allowed_balance` number — Minimum balance allowed for the account.
        - `maximum_allowed_balance` number — Maximum balance allowed for the account.
        - `low_liquidity_threshold` number — When the `balance` value for a sender account meets or is less than this amount after payment settlement execution, a low-liquidity message is logged at the INFO level.
        - `owner_min_allowed_balance` number — Minimum balance allowed by the owner of a nostro account. RippleNet Server uses the greater of this value and the `minimum_allowed_balance` to set the account balance minimum.
        - `owner_max_allowed_balance` number — Maximum balance allowed by the owner of a nostro account. RippleNet Server uses the lesser of this value and the `maximum_allowed_balance` to set the account balance maximum.
    - `pool_account_balances` PoolAccountBalance[] — Provides balance details of pool accounts, along with RippleNet accounts linked to those pool accounts.
      - `pool_account_name` string — Name of the pool account.
      - `balance` number — Aggregated balance of linked accounts which form this pool account.
      - `owner` string — The RippleNet peer who owns this pool account.
      - `currency` string — The currency of pool account.
      - `linked_accounts` string[] — Accounts linked to this pool account.
  - `remote_balances` InstitutionBalance[], required — Provides balance details for accounts owned by a RippleNet address.
    - `institution` string, required — RippleNet unique internal ID of the institution that owns the balances provided in the `currency_balances` array.
    - `institution_address` string, required — RippleNet address of the institution that owns the balances provided in the `currency_balances` array.
    - `currency_balances` CurrencyBalance[], required — Provides balance details for accounts owned by a RippleNet address. The response does not guarantee a fixed number of elements, or a fixed order of elements, in the returned list.
      - `currency` string, required — Currency of the balances provided.
      - `aggregate_balance` number, required — Aggregated balance for the given currrency.
      - `account_balances` AccountBalance[], required — Provides balance details for accounts that support the given currency.
        - `account_name` string — Name of the account, which acts as the account's unique identifier on RippleNet.
        - `balance` number — Balance available in the account.
        - `owner` string — RippleNet address of the owner of the account.
        - `currency` string — Currency supported by the account.
        - `minimum_allowed_balance` number — Minimum balance allowed for the account.
        - `maximum_allowed_balance` number — Maximum balance allowed for the account.
        - `low_liquidity_threshold` number — When the `balance` value for a sender account meets or is less than this amount after payment settlement execution, a low-liquidity message is logged at the INFO level.
        - `owner_min_allowed_balance` number — Minimum balance allowed by the owner of a nostro account. RippleNet Server uses the greater of this value and the `minimum_allowed_balance` to set the account balance minimum.
        - `owner_max_allowed_balance` number — Maximum balance allowed by the owner of a nostro account. RippleNet Server uses the lesser of this value and the `maximum_allowed_balance` to set the account balance maximum.
    - `pool_account_balances` PoolAccountBalance[] — Provides balance details of pool accounts, along with RippleNet accounts linked to those pool accounts.
      - `pool_account_name` string — Name of the pool account.
      - `balance` number — Aggregated balance of linked accounts which form this pool account.
      - `owner` string — The RippleNet peer who owns this pool account.
      - `currency` string — The currency of pool account.
      - `linked_accounts` string[] — Accounts linked to this pool account.
  - `errors` string[], required — Lists any errors encountered when returning balance details.

## Other responses

- `400` — Bad request.

---

[API](https://skmtc.net/ripple/apis/ripplenet-server-api.md) · [All operations](https://skmtc.net/ripple/apis/ripplenet-server-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/ripple/ripplenet-server-api/revisions/7843f07ca150/schema)