Skip to main content
GET
Get EndUser balance

Authorizations

x-api-key
string
header
required

Query Parameters

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_2X3GPfE8CK7uGU9Dpncxe6"

to_currency
enum<string> | null

ISO 4217 currency code to convert to

Available options:
GBP,
USD,
EUR,
CAD,
AUD,
null
Example:

"USD"

timestamp_min
string<date-time> | null

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

Example:

"2026-07-20T22:15:51.880803"

date_min
string<date> | null

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

Example:

"2026-07-20"

timestamp_max
string<date-time> | null

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

Example:

"2026-07-19T22:15:51.880873"

date_max
string<date> | null

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

Example:

"2026-07-19"

include_forecast
boolean
default:false

If true, forecasts the balances of each account

account_ids
string[]

Filter by specific account reference IDs

Example:

Response

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

daily_balances
object[]
forecasted
object[]
summary
object
warnings
enum<string>[]

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

Available options:
no_transactions_present,
transactions_present_but_not_enriched,
transactions_enriched_but_no_balance_data