> ## Documentation Index
> Fetch the complete documentation index at: https://help.mytruv.com/llms.txt
> Use this file to discover all available pages before exploring further.

# The Balances object

> Aggregated account balances across all connected financial institutions.

The Balances response aggregates balances from all connected financial accounts, grouped by account type and currency.

## Aggregated balance attributes

| Attribute          | Type    | Description                                                                     |
| :----------------- | :------ | :------------------------------------------------------------------------------ |
| type               | string  | Account type (`CHECKING`, `SAVINGS`, `CREDIT_CARD`, `LOAN`, `INVESTMENT`, etc.) |
| currency\_code     | string  | ISO 4217 currency code                                                          |
| balance            | string  | Sum of current balances across all accounts of this type                        |
| available\_balance | string  | Sum of available balances across all accounts of this type                      |
| credit\_limit      | string  | Sum of credit limits (0 for deposit accounts)                                   |
| account\_count     | integer | Number of accounts in this aggregation                                          |

## Account attributes

| Attribute   | Type      | Description                                                                      |
| :---------- | :-------- | :------------------------------------------------------------------------------- |
| id          | string    | Unique identifier of account                                                     |
| created\_at | date-time | Date and time account was created                                                |
| updated\_at | date-time | Date and time account was last updated                                           |
| type        | string    | Account type                                                                     |
| subtype     | string    | Account subtype                                                                  |
| mask        | string    | Masked account number                                                            |
| nickname    | string    | Alternate name for account                                                       |
| balances    | object    | Balance information (currency\_code, balance, available\_balance, credit\_limit) |
| provider    | object    | Financial institution details (id, name, logo\_url)                              |

***

## Response attributes

| Attribute            | Type             | Description                                          |
| :------------------- | :--------------- | :--------------------------------------------------- |
| total\_accounts      | integer          | Total number of accounts across all links            |
| accounts             | array of objects | Individual account records with provider information |
| aggregated\_balances | array of objects | Balances grouped by account type and currency        |

***

## Endpoints

* [Get aggregated balances](/api-reference/balances/get-balances)

***

## Example response

```json theme={null}
{
  "total_accounts": 6,
  "accounts": [
    {
      "id": "24d7e80942ce4ad58a93f70ce4115f5c",
      "type": "CHECKING",
      "subtype": "MONEY_MARKET",
      "mask": "6789",
      "nickname": "My account",
      "balances": {
        "currency_code": "USD",
        "balance": "25000.00",
        "available_balance": "24500.00",
        "credit_limit": "0.00"
      },
      "provider": {
        "id": "chase",
        "name": "Chase",
        "logo_url": "https://cdn.mytruv.com/providers/chase.png"
      }
    }
  ],
  "aggregated_balances": [
    {
      "type": "CHECKING",
      "currency_code": "USD",
      "balance": "49635.00",
      "available_balance": "48200.00",
      "credit_limit": "0.00",
      "account_count": 2
    }
  ]
}
```
