shares

Get Share Cohort

Materialize a single historical cohort for a shared scenario on demand.

Per-cohort year-by-year ledgers are not persisted (see historical-sampling-engine). The handler re-runs the deterministic historical backtest from the share's stored config snapshot and returns the ledger for the requested cohort start year.

410 Gone is returned when the year is no longer in the cohort window — typically after the owner's edits shrank the historical range.

get/api/shares/{token}/cohort/{year}

Request

  • Base URL: https://api.retirementlab.app (the document declares no server; this is the origin it was published from)
  • URL: https://api.retirementlab.app/api/shares/{token}/cohort/{year}
  • Auth: none declared

Path parameters

tokenstring required
yearinteger required

Response

Successful Response

start_yearinteger required
is_failureboolean required
depletion_year_indexinteger

Changes

No recorded changes to this operation across all 1 revision of this API.