Skip to main content

[EARLY ACCESS] CreateScenarioFromTemplate

hourglassThis endpoint is in early access

CreateScenarioFromTemplate

/api/scenarios/{scope}/$fromTemplate

Creates and stores a scenario built from a pre-defined parameterised template, for example a parallel rates shift or an equity crash. The template determines the scenario's shifts; the parameters supply the targets (e.g. currency or instrument) and optionally override the default shift size. The created scenario is stored in the given scope and behaves exactly like a hand-built scenario. Use ListScenarioTemplates to discover the available templates and, for each, the parameters it accepts, their defaults and their units. A parameter the template does not read is rejected rather than ignored, and parameter names are case-sensitive.