Simulations
API Reference
DraftLast reviewed 2026-06-23Portfolio simulation management — create, run, and inspect results
List all simulations
Returns all simulation definitions regardless of status.
Create simulation
Creates a new portfolio simulation definition in PENDING status.
Run simulation
Executes the simulation synchronously and returns a run summary.
Run intraday simulation
Triggers an intraday run immediately with current market data.
Cancel running simulation
Sets the cancellation flag for the simulation. The engine checks this flag between pages and stops gracefully.
Get simulation by ID
Returns a single simulation definition by its UUID.
Delete simulation
Removes the simulation definition by its UUID.
Get simulation status
Returns the current lifecycle status of the simulation.
Get simulation results
Returns computed results for the simulation with optional filtering by deal, result type, currency, or book.