get_portfolio_returns
Calculate portfolio returns for a chosen scope and period, showing simple return, TWR, XIRR, P&L split, and NAV risk stats; add daily NAV history and drawdowns when needed.
Instructions
Portfolio return for a period: simple return, TWR and XIRR side by side, P&L split and NAV risk statistics.
Read from stored daily NAV snapshots and the ledger. include_series adds the daily NAV history of the same period with drawdown statistics. That is the dated value series; it stores nothing, and no export or snapshot is needed for it. Fetched broker rows are recorded in the local append-only ledger (no broker writes).
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| scope | No | equity | |
| period | No | YTD | |
| detail_level | No | summary | |
| include_series | No |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||