Past annualised returns of assets
get_asset_returnsAnnualised past returns of the assets compoundsim simulates, over the last 5, 10 or 20 years, all the data, or a calendar span: total return with dividends reinvested, price return, the dividends' share, volatility, and the return after US inflation (in USD) or the exchange rate's share of the return (in another currency).
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| assets | No | Assets to include; all of them when omitted. | |
| period | No | The span measured: the last 5, 10 or 20 years, or all the data. An asset with less data than the span asked for uses all of its own. | 10 |
| currency | No | Currency of every amount, in and out. In a currency other than USD the paths carry its exchange-rate swings against the dollar (trend removed). Defaults to the language's currency. | |
| language | No | Language of the page the returned url opens; match the user's language. | en |
| period_to | No | Last calendar year of a custom span. | |
| period_from | No | First calendar year of a custom span (with period_to); replaces period. |