runs

Get Latest Sweep Run

get/api/runs/sweeps/latest

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/runs/sweeps/latest
  • Auth: HTTP bearer

Query parameters

config_namestring required
sweep_variable'retirement_year' | 'annual_savings' | 'portfolio_preset' | 'baseline_annual_expenses' | 'initial_net_worth' | 'country' | 'claim_age' | 'bond_tilt_pp' required
sweep_target_income_idstring
include_failedboolean

Response

Successful Response

idinteger required
withdrawal_baseline_run_idinteger
config_idinteger
config_namestring
labelstring
status'queued' | 'running' | 'succeeded' | 'failed' required
run_kind'simulation' | 'sweep' | 'grid' | 'roth_conversion_explorer'
run_sourcestring
sweep_variable'retirement_year' | 'annual_savings' | 'portfolio_preset' | 'baseline_annual_expenses' | 'initial_net_worth' | 'country' | 'claim_age' | 'bond_tilt_pp'
sweep_valuesstring[]
col_enabledboolean
col_adjustmentsobject
sweep_target_income_idstring
simulation_mode'monte_carlo_regime' | 'monte_carlo_iid' | 'historical'
runs_remaininginteger
requested_atstring date-time
assumptions_versionstring
assumptions_version_state'declared' | 'legacy_unverified'
source_assumptions_versionstring
source_assumptions_version_state'declared' | 'legacy_unverified'

Changes

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