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-08-01",
"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"
}
}
Get balance for given EndUser on a daily and account granularity
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-08-01",
"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"
}
}
Filter for transactions with date earlier than the input value (inclusive). It has precedence over timestamp_max
"2025-07-31"
Deprecated (use date_min instead). Filter for transactions with timestamp after the input value
"2025-08-01T13:14:51.620206"
Deprecated (use date_max instead). Filter for transactions with timestamp earlier than the input value
"2025-07-31T13:14:51.620250"
If true, forecasts the balances of each account
ISO 4217 currency code to convert to
GBP
, USD
, EUR
"USD"
end_user_id for statistics; either end_user_id or end_user_heron_id is required
"your_end_user_id"
Filter for transactions with timestamp after the input value (inclusive). It has precedence over timestamp_min
"2025-08-01"
Heron-generated id for end user; either end_user_id or end_user_heron_id is required
"eus_Wy8pNZjYSFtucFzsJT5j4s"
OK
The response is of type object
.
Was this page helpful?