---
title: "List balances"
method: GET
path: "/api/br/balances/"
tags: ["Balances"]
---

# List balances

`GET /api/br/balances/`

## ▶️ Usage

With the List Balances method, you can:
  
  1. **[Required]** List balances related to a specific `link.id` (using the `link` query parameter).
  2. **[Highly Recommended]** List balances related to a specific `link.id` and `account.id` (using the `link` and `account` query parameters).
  2. Get the details of a specific `balance.id` (using the `id` query parameter).

## 🔦 Filtering Responses

Please see the query list below for a list of fields that you can filter your responses by. For more information on how to use filters, see our <a href="https://developers.belvo.com/docs/searching-and-filtering" target="_blank">Filtering responses</a> article.

## 📖 Pagination

This method returns a paginated response (default: 100 items per page). You can use the `page_size` query parameter to increase the number of items returned to a maximum of 1000 items. You can use the `page` query parameter to navigate through the results. For more details on how to navigate Belvo's paginated responses, see our <a href="https://developers.belvo.com/docs/belvo-pagination-tips" target="_blank">Pagination Tips</a> article.
    
## 🚨 Deprecated Fields

This resource may return deprecated fields. In the response documentation you may see that a field has been marked as **deprecated**. This means that this field is no longer maintained by the Belvo team. You may still receive data for this field depending on the institution, however, you should not rely on this field.

## Query parameters

- `link` string, uuid, required
- `account` string, uuid
- `id` string, uuid
- `link__in` string[]
- `account__in` string[]
- `id__in` string[]
- `page_size` integer
- `page` integer
- `omit` string
- `fields` string
- `collected_at` string, date
- `collected_at__gt` string, date
- `collected_at__gte` string, date
- `collected_at__lt` string, date
- `collected_at__lte` string, date
- `collected_at__range` string[]
- `created_at` string, date
- `created_at__gt` string, date
- `created_at__gte` string, date
- `created_at__lt` string, date
- `created_at__lte` string, date
- `created_at__range` string[]

## Response `200`

OK - Balances Retrieved

- object
  - `count` integer — The total number of results in your Belvo account.
  - `next` string, uri, nullable — The URL to next page of results. Each page consists of up to 100 items. If there are not enough results for an additional page, the value is `null`. In our documentation example, we use `{endpoint}` as a placeholder value. In production, this value will be replaced by the actual endpoint you are currently using (for example, `accounts` or `owners`).
  - `previous` string, uri, nullable — The URL to the previous page of results. If there is no previous page, the value is `null`.
  - `results` BalanceOFDA[] — An array of balance objects.
    - `id` string, uuid, required — The unique identifier created by Belvo used to reference the current balance.
    - `link` string, uuid, required — The unique identifier of the link that this balance belongs to.
    - `account_id` string, uuid, required — The Belvo `account.id` that this balance belongs to.
    - `account_internal_identification` string, required — The institution's internal identification for the account.
    - `collected_at` string, date-time, required — The ISO-8601 timestamp when the data point was collected.
    - `created_at` string, date-time, required — The ISO-8601 timestamp of when the data point was created in Belvo's database.
    - `last_updated_at` string, date-time, required — The ISO-8601 timestamp of when this balance was last updated by the institution. > 🚧 Warning > > The `last_updated_at` parameter depends on how the institution processes (or stores) data. In the case that the institution stores data synchronously (that is, as soon as a transaction occurs, the balance us updated), then the `last_updated_at` will reflect the balance in near real time. In the case that the institution stores data asynchronously (that is, it retrieves data in bulk and then updates the balance), the balance information can refer to hours or days ago. Additionally, in the case that the institution cannot provide the specific time (due to an internal error), the institution may provide an overall time where they last refreshed the account and balance information.
    - `currency` string, required — The three-letter currency code (ISO-4217).
    - `available` number, float, required — The available account balance.
    - `blocked` number, float, required — The amount that is currently blocked due to, for example, pending transactions.
    - `automatically_invested` number, float, required — The amount that is automatically invested (as agreed upon with the institution).

## Other responses

- `401` — Unauthorized
- `403` — Access to Belvo API denied
- `408` — Request Timeout
- `500` — Unexpected Error

---

[API](https://skmtc.net/belvo/apis/belvo-api-docs.md) · [All operations](https://skmtc.net/belvo/apis/belvo-api-docs/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/belvo/belvo-api-docs/revisions/3423c786ece5/schema)