HEherondata
EndUserCalculations

Get EndUser balance

Changed on

Get balance for given EndUser on a daily and account granularity

get/api/end_users/balance

Request

  • Base URL
    https://app.herondata.io
  • URL
    https://app.herondata.io/api/end_users/balance
  • Auth
    API key in header x-api-key

Query parameters

end_user_idstring nullable
Example:your_end_user_id

end_user_id for statistics; either end_user_id or end_user_heron_id is required

end_user_heron_idstring nullable
Example:eus_e3h52yUnj6tsJs4nXdPuU8

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

to_currency'GBP' | 'USD' | 'EUR' | 'CAD' | 'AUD' | 'null' nullable
Example:USD

ISO 4217 currency code to convert to

timestamp_minstring date-time nullable
Example:2026-11-02T23:44:33.034822

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

date_minstring date nullable
Example:2026-11-02

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

timestamp_maxstring date-time nullable
Example:2026-11-01T23:44:33.034916

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

date_maxstring date nullable
Example:2026-11-01

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

include_forecastboolean

If true, forecasts the balances of each account

account_idsstring[]

Filter by specific account reference IDs

[
  "1234",
  "5678"
]

Response

OK. Empty balances include a warning reason when no balance data is available.

warningsstring[]

Empty-balance reason codes. Populated responses return an empty list.

Example response

{
  "daily_balances": [
    {
      "accounts": [
        {
          "account_info": {
            "currency": "USD",
            "heron_id": "dsa_cykpvUuCaCvM8wmjS9GjVr",
            "institution_name": "Chase",
            "name": "Checking Account",
            "number": "123456789",
            "owner_name": "John Doe",
            "type": "Checking"
          },
          "currency": "USD",
          "currency_converted": "USD",
          "display_account_id": "7505",
          "heron_account_suffix": "001"
        }
      ],
      "accounts_not_converted": [
        {
          "account_info": {
            "currency": "USD",
            "heron_id": "dsa_cykpvUuCaCvM8wmjS9GjVr",
            "institution_name": "Chase",
            "name": "Checking Account",
            "number": "123456789",
            "owner_name": "John Doe",
            "type": "Checking"
          },
          "currency": "USD",
          "currency_converted": "USD",
          "display_account_id": "7505",
          "heron_account_suffix": "001"
        }
      ],
      "currency": "USD"
    }
  ],
  "forecasted": [
    {
      "balances": [
        {
          "date": "2026-11-02",
          "predicted": 42.42,
          "predicted_lower": 4.24,
          "predicted_upper": 420.42
        }
      ]
    }
  ],
  "summary": {
    "accounts": [
      {
        "account_info": {
          "currency": "USD",
          "heron_id": "dsa_cykpvUuCaCvM8wmjS9GjVr",
          "institution_name": "Chase",
          "name": "Checking Account",
          "number": "123456789",
          "owner_name": "John Doe",
          "type": "Checking"
        },
        "currency": "USD",
        "currency_converted": "USD",
        "display_account_id": "7505",
        "heron_account_suffix": "001"
      }
    ],
    "accounts_not_converted": [
      {
        "account_info": {
          "currency": "USD",
          "heron_id": "dsa_cykpvUuCaCvM8wmjS9GjVr",
          "institution_name": "Chase",
          "name": "Checking Account",
          "number": "123456789",
          "owner_name": "John Doe",
          "type": "Checking"
        },
        "currency": "USD",
        "currency_converted": "USD",
        "display_account_id": "7505",
        "heron_account_suffix": "001"
      }
    ],
    "currency": "USD"
  }
}

Changes

  • bd8008e49534Revision changes
    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status