Skip to main content
GET
Show cash flow and optional Sankey graph

Authorizations

X-Api-Key
string
header
required

API key for authentication. Generate one from your account settings.

Query Parameters

month
string<date>

Non-future first day YYYY-MM-01; defaults to the current month in the family time zone.

include
enum<string>

Append server-calculated graph to the monthly summary; cannot combine with view.

Available options:
sankey
view
enum<string>

Graph-only envelope; omits daily comparison. Accepts month or an explicit date range; cannot combine with include.

Available options:
sankey
start_date
string<date>

Inclusive ISO date. Requires end_date and view=sankey; cannot combine with month.

end_date
string<date>

Inclusive ISO date at or after start_date. Explicit ranges preserve their bounds, including future dates.

group_by
enum<string>

How to group the Sankey graph. Requires view=sankey. "category" (default) routes flows through a single Cash Flow node; "account" routes them through each individual account.

Available options:
category,
account

Response

summary returned

month
string<date>
required
as_of
string<date>
required
time_zone
string
required
currency
string
required
period
object
required
income
string
required
spending
string
required
net_savings
string
required
savings_rate
string | null
required

Percentage points; null when income is nonpositive. May be negative.

spending_comparison
object
required
sankey
object

Refunds net within each category. Parent direct amounts exclude child totals before partitioning by direction. Graph income/spending may differ from gross monthly totals; net savings agrees. Decimal strings retain FX precision. Empty flow has empty nodes and links. When group_by=account the basis is net_by_account and nodes include account-kind nodes representing individual accounts between income and expense categories.