Months — Range
months_rangeRetrieve budgeted, activity, and balance for every category across a range of months as one matrix, enabling month-over-month budget comparisons in a single call.
Instructions
[READ] Budgeted, activity and balance for every category across a range of months, as one matrix. This is the tool for any month-over-month question: one call instead of one months_get per month, and a quarter of the size, because it returns six fields per category rather than every goal field YNAB tracks. from_month and to_month: 'YYYY-MM', an ISO date, or 'current'. to_month defaults to the current month. Narrow it with category_ids or group_ids (category_ids wins if both are given). fields: which of budgeted, activity and balance each cell carries — all three by default, and dropping the two you are not reading takes roughly two thirds off a forty-category range. include_hidden=true adds hidden categories, including the credit-card payment ones. The response carries as_of: a range is a snapshot, and one cached earlier in a session is not what the plan says now. Re-read it, or use changes_since, before acting on an old one. Amounts are in milliunits (1000 = $1.00). Costs one YNAB request per month in the range (limit 36 months); check overview_request_budget before a long range.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| fields | No | ||
| plan_id | No | ||
| to_month | No | ||
| group_ids | No | ||
| from_month | Yes | ||
| category_ids | No | ||
| include_hidden | No |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||