Summarise track record
describe_portfolio_seriesRead-onlyIdempotent
Summary statistics of a backtested strategy's track record, or an account's history.
A read: computes and writes nothing. Returns the summary statistics; the curve is
drawn by the card where the host renders one. ``series_in_context=True`` returns
every daily point, for questions about the curve's shape (peaks, time under water).
``contributions_by`` returns instead what each holding or group added to the
return between ``from_date`` and ``to_date`` (ISO dates; default the last year),
largest first. Contributions add up to the window's return. A fund counts as one
holding: its past holdings are not known, so it is not split by country, sector
or industry.
For a strategy it also gives the one-way turnover over the last year's worth of
rebalances and the dividend yield, gross: the track record deducts no trading
cost or withholding tax, and these are the inputs for estimating both.
For an account it is the account's own history. A strategy with no track record
yet is refused; ``run_strategy_backtest`` or a build with ``backtest=True``
creates one.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"strategy_id": "<strategy_id>"
},
"name": "describe_portfolio_series"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| to_date | No | ||
| from_date | No | ||
| strategy_id | Yes | ||
| contributions_by | No | ||
| series_in_context | No |