tools

Get account flows

Use this when the user asks how much entered or left specific accounts. Gross inflows, gross outflows, and net flow for selected accounts over a date range, aggregated over ALL matches server-side, e.g. 'how much did I deposit into Schwab this year'. Prefer this over betteroff_search_transactions for deposit/withdrawal totals.

post/v1/tools/betteroff_get_account_flows

Request

  • Base URL: https://api.betteroff.finance
  • URL: https://api.betteroff.finance/v1/tools/betteroff_get_account_flows
  • Auth: one of:
    • OpenID Connect (https://app.betteroff.finance/api/auth/.well-known/openid-configuration, scopes: accounts:read, transactions:read)
    • HTTP bearer

Request body

startDatestring date nullable required

Start date (ISO format, e.g. 2026-01-01). Use null for Jan 1 of this year.

endDatestring date nullable required

End date (ISO format). Use null for today.

accountIdsstring[] nullable required

Specific account IDs to include. Use null to select by accountType/institution.

accountType'depository' | 'investment' | 'credit' | 'loan' | 'crypto' | 'wallet' nullable required

Optional account type filter. Use investment for brokerage/retirement accounts.

institutionstring nullable required

Optional institution name filter, e.g. Charles Schwab. Partial matches are accepted.

direction'all' | 'inflow' | 'outflow' nullable required

Use inflow for deposits only, outflow for withdrawals only, all for both.

limitinteger nullable required

Max transaction rows to return for evidence (default 25, max 100).

Response

Tool result

OR

Changes

No recorded changes to this operation across all 1 revision of this API.