Skip to main content
POST
https://api.villagelabs.com
/
v1
/
simulate
POST /simulate
curl --request POST \
  --url https://api.villagelabs.com/v1/simulate

​
Request

{
  "planRules": { },
  "operatingAssumptions": { },
  "initialState": { },
  "systemConfig": { }
}

​
Response

{
  "success": true,
  "data": {
    "simulation_id": "sim_2024_001",
    "status": "completed",
    "results": {
      "total_repurchase_obligation": 8450000,
      "peak_cash_year": 2029,
      "annual_projections": [ ]
    }
  }
}
See Quick Start for complete example.