get_balance_history
Retrieve account balance snapshots over time to track balance trends, filter by date or account, and choose daily, weekly, or monthly granularity to control response size.
Instructions
Get daily balance snapshots for accounts over time. Each entry returns current_balance, available_balance, limit, account_id, and account_name. The response also includes an accounts array listing the distinct account IDs in the paginated page. Requires a granularity parameter (daily, weekly, monthly) to control response size. Weekly and monthly modes downsample by keeping the last data point per period. Filter by account_id and date range.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | Maximum number of results (default: 100, max: 10000) | |
| offset | No | Number of results to skip for pagination (default: 0) | |
| end_date | No | End date (YYYY-MM-DD) | |
| account_id | No | Filter by account ID | |
| start_date | No | Start date (YYYY-MM-DD) | |
| granularity | Yes | Required. Controls response density: daily (every day), weekly (one per week), or monthly (one per month). Use weekly or monthly for longer time ranges. |