Get Balance History
get_balance_historyReturns the user's monthly net-worth history plus a linear forecast (6 and 12 months ahead). Confidence is 'rough' until at least 6 months of history exist. Includes a not-financial-advice disclaimer. Each actual month returns net_worth (which respects the user's include_property_in_net_worth setting) AND home_equity (property valuations minus mortgage owed), which is ALWAYS populated and independent of that setting — negative values mean the user was underwater that month. Guidance: respect the user's setting as the default and never override it. When property is not counted (include_property_in_net_worth false, or property_section_hidden true), still say so plainly and give the counterfactual (e.g. 'X excluding property per your setting; Y with property included'). Offer to include property rather than blocking the answer behind a question — only ask a brief clarifying question when the request is itself ambiguously about property or equity. Never imply the user has no property when it is merely toggled off. If the result has empty: true, the user has not added the relevant data yet: relay the message and next_step_url rather than treating it as an error.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| months | No | How many months of history to include |