Build a dividend-reinvested total-return index
equity-analytics_total-return-seriesCompound a total-return index from closes and cash dividends with optional withholding tax, and report price return, total return and CAGR. Price $0.03 USDC. POST /api/v1/equity-analytics/total-return-series. An unpaid call returns the x402 payment terms and does not run.
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": {
"prices": "<prices>"
},
"name": "equity-analytics_total-return-series"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| base | No | base, number. Required. | |
| prices | Yes | prices, array. Required. | |
| dividends | No | dividends, array. Required. | |
| withholdingTax | No | withholdingTax, number, from 0 to 1. Required. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| cagr | No | cagr. Number. | |
| index | No | index. Array. | |
| sources | No | sources. Array. | |
| limitations | No | limitations. Array. | |
| priceReturn | No | priceReturn. Number. | |
| totalReturn | No | totalReturn. Number. |