GET
/
api
/
end_users
/
balance
curl --request GET \
  --url https://app.herondata.io/api/end_users/balance \
  --header 'x-api-key: <api-key>'
{
  "daily_balances": [
    {
      "accounts": [
        {
          "account_id": "<string>",
          "account_info": {
            "currency": "USD",
            "institution_name": "Chase",
            "name": "Checking Account",
            "number": "123456789",
            "owner_name": "John Doe",
            "type": "Checking"
          },
          "balance": 123,
          "balance_converted": 123,
          "currency": "USD",
          "currency_converted": "USD",
          "is_computed": true,
          "is_latest": true,
          "timestamp": "2023-11-07T05:31:56Z"
        }
      ],
      "accounts_not_converted": [
        {
          "account_id": "<string>",
          "account_info": {
            "currency": "USD",
            "institution_name": "Chase",
            "name": "Checking Account",
            "number": "123456789",
            "owner_name": "John Doe",
            "type": "Checking"
          },
          "balance": 123,
          "balance_converted": 123,
          "currency": "USD",
          "currency_converted": "USD",
          "is_computed": true,
          "is_latest": true,
          "timestamp": "2023-11-07T05:31:56Z"
        }
      ],
      "balance": 123,
      "currency": "USD",
      "date": "2023-12-25"
    }
  ],
  "forecasted": [
    {
      "account_id": "<string>",
      "balances": [
        {
          "date": "2025-04-30",
          "predicted": 42.42,
          "predicted_lower": 4.24,
          "predicted_upper": 420.42
        }
      ],
      "currency": "<string>"
    }
  ],
  "summary": {
    "accounts": [
      {
        "account_id": "<string>",
        "account_info": {
          "currency": "USD",
          "institution_name": "Chase",
          "name": "Checking Account",
          "number": "123456789",
          "owner_name": "John Doe",
          "type": "Checking"
        },
        "balance": 123,
        "balance_converted": 123,
        "currency": "USD",
        "currency_converted": "USD",
        "is_computed": true,
        "is_latest": true,
        "timestamp": "2023-11-07T05:31:56Z"
      }
    ],
    "accounts_not_converted": [
      {
        "account_id": "<string>",
        "account_info": {
          "currency": "USD",
          "institution_name": "Chase",
          "name": "Checking Account",
          "number": "123456789",
          "owner_name": "John Doe",
          "type": "Checking"
        },
        "balance": 123,
        "balance_converted": 123,
        "currency": "USD",
        "currency_converted": "USD",
        "is_computed": true,
        "is_latest": true,
        "timestamp": "2023-11-07T05:31:56Z"
      }
    ],
    "balance": 123,
    "currency": "USD",
    "date": "2023-12-25"
  }
}

Authorizations

​
x-api-key
string
header
required

Query Parameters

​
date_min
string | null

Filter for transactions with timestamp after the input value (inclusive). It has precedence over timestamp_min

Example:

"2025-04-30"

​
to_currency
enum<string> | null

ISO 4217 currency code to convert to

Available options:
GBP,
USD,
EUR
Example:

"USD"

​
include_forecast
boolean
default:false

If true, forecasts the balances of each account

​
timestamp_min
string | null

Deprecated (use date_min instead). Filter for transactions with timestamp after the input value

Example:

"2025-04-30T19:15:19.441755"

​
timestamp_max
string | null

Deprecated (use date_max instead). Filter for transactions with timestamp earlier than the input value

Example:

"2025-04-29T19:15:19.441802"

​
date_max
string | null

Filter for transactions with date earlier than the input value (inclusive). It has precedence over timestamp_max

Example:

"2025-04-29"

​
end_user_id
string | null

end_user_id for statistics; either end_user_id or end_user_heron_id is required

Example:

"your_end_user_id"

​
end_user_heron_id
string | null

Heron-generated id for end user; either end_user_id or end_user_heron_id is required

Example:

"eus_FcjtxALUX8mtznFYBAbH7n"

Response

200 - application/json
OK

The response is of type object.