Retirement

Project savings to retirement across account types

Deterministic accumulation across multiple accounts with contribution escalation and an employer match, returning the projected balance by account and total (nominal + real). With num_simulations > 0 it reuses the Monte Carlo return model to add stochastic ending-total percentile bands. Deterministic given a seed.

post/v1/retirement/accumulation-projection

Request

  • Base URL: https://api.numeratica.com
  • URL: https://api.numeratica.com/v1/retirement/accumulation-projection
  • Auth: one of:
    • HTTP bearer
    • API key in header X-API-Key

Request body

annual_fee_ratenumber double

All-in annual cost drag as a decimal (0.01 = 1%): advisory fee plus fund expense ratios, applied as a reduction to the expected return. Omitted or 0 means the projection is GROSS of fees, which leaves result_id unchanged. Costs compound: a 1% load moves long-horizon outcomes by a large margin (see the Concepts page).

escalation_ratenumber

Annual % increase in contributions.

employer_match_ratenumber

Match on total employee contributions.

employer_match_limitnumber

Annual $ cap on the match (0 = uncapped).

expected_returnnumber

Required unless a glide_path is supplied.

return_volatilitynumber

For the optional stochastic bands.

inflationnumber
yearsinteger required
num_simulationsinteger

0 = deterministic only.

seedinteger

Optional; generated and echoed when simulating.

current_ageinteger

Anchors the glide path: the return for projection year y is taken at age current_age+y. Required when glide_path is supplied.

Example request

{
  "annual_fee_rate": 0.01,
  "expected_return": 0.06,
  "years": 30,
  "glide_path": [
    {
      "age": 40
    }
  ]
}

Response

Accumulation projection

result_idstring
engine_versionstring
disclaimerstring

Example response

{
  "result_id": "acc_1a2b3c4d5e6f7a8b",
  "engine_version": "accumulation-1.0.0",
  "inputs": {
    "annual_fee_rate": 0.01,
    "expected_return": 0.06,
    "years": 30,
    "glide_path": [
      {
        "age": 40
      }
    ]
  }
}

Changes

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