get_portfolio_history
Retrieve portfolio history including equity, cumulative PnL, and traded volume for selectable time windows and point limits.
Instructions
Get the authenticated account's portfolio time-series — equity, cumulative trading PnL, and cumulative traded volume — over a selectable window, oldest first. Richer than get_equity_history (equity only, 5s cadence, ~1h); both derive equity from the same source, so the two never disagree. Each window sets its own downsample cadence and point capacity: day 5m/288, week 1h/168, month 6h/120, all 1d/366. pnl is deposit-neutral (trading performance only) and volume is monotonically non-decreasing. This is a HEAVY read — the gateway charges it 5x an ordinary GET, so a single call draws about five requests' worth of budget and the remaining reported by get_rate_limit_status (counted in ordinary requests) drops by ~5. Poll it sparingly. Requires API credentials.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | Maximum number of points to return (1–366). Clamped server-side to the selected window's capacity. Omit for the full window. | |
| window | No | Time window to return, which also selects the cadence and point capacity. Defaults to `day` server-side when omitted. |