Exactly one of: object; object; object
| Field | Required at this level | Type | Description and constraints |
|---|---|---|---|
oneOf[1].engineVersion |
Yes | Constant digital-twin-pcg64-fixed-v1 |
— |
oneOf[1].seed |
Yes | string |
— |
oneOf[1].pathCount |
Yes | integer |
Allowed: 2000, 10000 |
oneOf[1].stepCount |
Yes | integer |
Minimum: 1; Maximum: 365 |
oneOf[1].scenario |
Yes | ScenarioDefinition | — |
oneOf[1].variants |
Yes | Array of object |
Min items: 5; Max items: 5 |
oneOf[1].variants[].variant |
Yes | string |
Allowed: CURRENT, RECOMMENDED, CONSERVATIVE, CAPITAL_EFFICIENT, EMERGENCY |
oneOf[1].variants[].endingValueQuote |
Yes | DistributionPercentiles | — |
oneOf[1].variants[].slippagePips |
Yes | PipsPercentiles | — |
oneOf[1].variants[].drawdownPips |
Yes | PipsPercentiles | — |
oneOf[1].variants[].turnoverQuote |
Yes | DistributionPercentiles | — |
oneOf[1].variants[].gasCostQuote |
Yes | DistributionPercentiles | — |
oneOf[1].variants[].feeIncomeQuote |
Yes | DistributionPercentiles | — |
oneOf[1].variants[].protocolFeesQuote |
Yes | DistributionPercentiles | — |
oneOf[1].variants[].platformFeesQuote |
Yes | DistributionPercentiles | — |
oneOf[1].variants[].inventoryPips |
Yes | PipsPercentiles | — |
oneOf[1].variants[].minimumDepthQuote |
Yes | DistributionPercentiles | — |
oneOf[1].variants[].reserveBreachProbabilityPips |
Yes | Pips | — |
oneOf[1].variants[].drivers |
Yes | Array of object |
— |
oneOf[1].variants[].drivers[].driver |
Yes | string |
Allowed: PRICE_PATH, VOLATILITY, FLOW, LIQUIDITY, UNLOCK, GAS, RESERVE |
oneOf[1].variants[].drivers[].impactQuote |
Yes | SignedAtomicAmount | — |
oneOf[1].variants[].drivers[].evidence |
Yes | string |
— |
oneOf[1].variants[].drivers[].method |
Yes | Constant DETERMINISTIC_COUNTERFACTUAL_DELTA_V1 |
— |
oneOf[1].recommendedVariant |
Yes | string |
Allowed: CURRENT, RECOMMENDED, CONSERVATIVE, CAPITAL_EFFICIENT, EMERGENCY |
oneOf[1].warnings |
Yes | Array of string |
— |
oneOf[1].sourceLineage |
No | SimulationStudySourceLineage | — |
oneOf[2].engineVersion |
Yes | Constant digital-twin-pcg64-fixed-v2 |
— |
oneOf[2].seed |
Yes | string |
— |
oneOf[2].pathCount |
Yes | integer |
Allowed: 2000, 10000 |
oneOf[2].stepCount |
Yes | integer |
Minimum: 1; Maximum: 365 |
oneOf[2].scenario |
Yes | ScenarioDefinition | — |
oneOf[2].variants |
Yes | Array of object |
Min items: 5; Max items: 5 |
oneOf[2].variants[].variant |
Yes | string |
Allowed: CURRENT, RECOMMENDED, CONSERVATIVE, CAPITAL_EFFICIENT, EMERGENCY |
oneOf[2].variants[].endingValueQuote |
Yes | DistributionPercentiles | — |
oneOf[2].variants[].slippagePips |
Yes | PipsPercentiles | — |
oneOf[2].variants[].drawdownPips |
Yes | PipsPercentiles | — |
oneOf[2].variants[].turnoverQuote |
Yes | DistributionPercentiles | — |
oneOf[2].variants[].gasCostQuote |
Yes | DistributionPercentiles | — |
oneOf[2].variants[].feeIncomeQuote |
Yes | DistributionPercentiles | — |
oneOf[2].variants[].protocolFeesQuote |
Yes | DistributionPercentiles | — |
oneOf[2].variants[].platformFeesQuote |
Yes | DistributionPercentiles | — |
oneOf[2].variants[].inventoryPips |
Yes | PipsPercentiles | — |
oneOf[2].variants[].minimumDepthQuote |
Yes | DistributionPercentiles | — |
oneOf[2].variants[].reserveBreachProbabilityPips |
Yes | Pips | — |
oneOf[2].variants[].drivers |
Yes | Array of object |
— |
oneOf[2].variants[].drivers[].driver |
Yes | string |
Allowed: PRICE_PATH, VOLATILITY, FLOW, LIQUIDITY, UNLOCK, GAS, RESERVE |
oneOf[2].variants[].drivers[].impactQuote |
Yes | SignedAtomicAmount | — |
oneOf[2].variants[].drivers[].evidence |
Yes | string |
— |
oneOf[2].variants[].drivers[].method |
Yes | Constant DETERMINISTIC_COUNTERFACTUAL_DELTA_V1 |
— |
oneOf[2].recommendedVariant |
Yes | string |
Allowed: CURRENT, RECOMMENDED, CONSERVATIVE, CAPITAL_EFFICIENT, EMERGENCY |
oneOf[2].warnings |
Yes | Array of string |
— |
oneOf[2].inputSnapshot |
Yes | SimulationStudyInputSnapshot | — |
oneOf[2].sourceLineage |
Yes | SimulationStudySourceLineage | — |
oneOf[3].engineVersion |
Yes | Constant digital-twin-pcg64-fixed-v2 |
— |
oneOf[3].seed |
Yes | string |
— |
oneOf[3].pathCount |
Yes | Constant 10000 |
— |
oneOf[3].stepCount |
Yes | integer |
Minimum: 1; Maximum: 365 |
oneOf[3].scenario |
Yes | ScenarioDefinition | — |
oneOf[3].variants |
Yes | Array of JSON value | Max items: 0 |
oneOf[3].recommendedVariant |
Yes | null |
— |
oneOf[3].warnings |
Yes | Array of string |
— |
oneOf[3].state |
Yes | Constant QUEUED |
— |
oneOf[3].inputHash |
Yes | Hash | — |
oneOf[3].inputSnapshot |
Yes | SimulationStudyInputSnapshot | — |
oneOf[3].sourceLineage |
Yes | SimulationStudySourceLineage | — |
Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.
Exact definition: #/components/schemas/SimulationStudy in the OpenAPI contract.