# SimulationStudy

[All API schemas](/api-reference/schemas/)

Exactly one of: <code>object</code>; <code>object</code>; <code>object</code>

| Field | Required at this level | Type | Description and constraints |
| --- | --- | --- | --- |
| <code>oneOf&#91;1&#93;.engineVersion</code> | Yes | Constant <code>digital-twin-pcg64-fixed-v1</code> | — |
| <code>oneOf&#91;1&#93;.seed</code> | Yes | <code>string</code> | — |
| <code>oneOf&#91;1&#93;.pathCount</code> | Yes | <code>integer</code> | Allowed: <code>2000</code>, <code>10000</code> |
| <code>oneOf&#91;1&#93;.stepCount</code> | Yes | <code>integer</code> | Minimum: <code>1</code>; Maximum: <code>365</code> |
| <code>oneOf&#91;1&#93;.scenario</code> | Yes | [ScenarioDefinition](/api-reference/schemas/scenario-definition/) | — |
| <code>oneOf&#91;1&#93;.variants</code> | Yes | Array of <code>object</code> | Min items: <code>5</code>; Max items: <code>5</code> |
| <code>oneOf&#91;1&#93;.variants&#91;&#93;.variant</code> | Yes | <code>string</code> | Allowed: <code>CURRENT</code>, <code>RECOMMENDED</code>, <code>CONSERVATIVE</code>, <code>CAPITAL&#95;EFFICIENT</code>, <code>EMERGENCY</code> |
| <code>oneOf&#91;1&#93;.variants&#91;&#93;.endingValueQuote</code> | Yes | [DistributionPercentiles](/api-reference/schemas/distribution-percentiles/) | — |
| <code>oneOf&#91;1&#93;.variants&#91;&#93;.slippagePips</code> | Yes | [PipsPercentiles](/api-reference/schemas/pips-percentiles/) | — |
| <code>oneOf&#91;1&#93;.variants&#91;&#93;.drawdownPips</code> | Yes | [PipsPercentiles](/api-reference/schemas/pips-percentiles/) | — |
| <code>oneOf&#91;1&#93;.variants&#91;&#93;.turnoverQuote</code> | Yes | [DistributionPercentiles](/api-reference/schemas/distribution-percentiles/) | — |
| <code>oneOf&#91;1&#93;.variants&#91;&#93;.gasCostQuote</code> | Yes | [DistributionPercentiles](/api-reference/schemas/distribution-percentiles/) | — |
| <code>oneOf&#91;1&#93;.variants&#91;&#93;.feeIncomeQuote</code> | Yes | [DistributionPercentiles](/api-reference/schemas/distribution-percentiles/) | — |
| <code>oneOf&#91;1&#93;.variants&#91;&#93;.protocolFeesQuote</code> | Yes | [DistributionPercentiles](/api-reference/schemas/distribution-percentiles/) | — |
| <code>oneOf&#91;1&#93;.variants&#91;&#93;.platformFeesQuote</code> | Yes | [DistributionPercentiles](/api-reference/schemas/distribution-percentiles/) | — |
| <code>oneOf&#91;1&#93;.variants&#91;&#93;.inventoryPips</code> | Yes | [PipsPercentiles](/api-reference/schemas/pips-percentiles/) | — |
| <code>oneOf&#91;1&#93;.variants&#91;&#93;.minimumDepthQuote</code> | Yes | [DistributionPercentiles](/api-reference/schemas/distribution-percentiles/) | — |
| <code>oneOf&#91;1&#93;.variants&#91;&#93;.reserveBreachProbabilityPips</code> | Yes | [Pips](/api-reference/schemas/pips/) | — |
| <code>oneOf&#91;1&#93;.variants&#91;&#93;.drivers</code> | Yes | Array of <code>object</code> | — |
| <code>oneOf&#91;1&#93;.variants&#91;&#93;.drivers&#91;&#93;.driver</code> | Yes | <code>string</code> | Allowed: <code>PRICE&#95;PATH</code>, <code>VOLATILITY</code>, <code>FLOW</code>, <code>LIQUIDITY</code>, <code>UNLOCK</code>, <code>GAS</code>, <code>RESERVE</code> |
| <code>oneOf&#91;1&#93;.variants&#91;&#93;.drivers&#91;&#93;.impactQuote</code> | Yes | [SignedAtomicAmount](/api-reference/schemas/signed-atomic-amount/) | — |
| <code>oneOf&#91;1&#93;.variants&#91;&#93;.drivers&#91;&#93;.evidence</code> | Yes | <code>string</code> | — |
| <code>oneOf&#91;1&#93;.variants&#91;&#93;.drivers&#91;&#93;.method</code> | Yes | Constant <code>DETERMINISTIC&#95;COUNTERFACTUAL&#95;DELTA&#95;V1</code> | — |
| <code>oneOf&#91;1&#93;.recommendedVariant</code> | Yes | <code>string</code> | Allowed: <code>CURRENT</code>, <code>RECOMMENDED</code>, <code>CONSERVATIVE</code>, <code>CAPITAL&#95;EFFICIENT</code>, <code>EMERGENCY</code> |
| <code>oneOf&#91;1&#93;.warnings</code> | Yes | Array of <code>string</code> | — |
| <code>oneOf&#91;1&#93;.sourceLineage</code> | No | [SimulationStudySourceLineage](/api-reference/schemas/simulation-study-source-lineage/) | — |
| <code>oneOf&#91;2&#93;.engineVersion</code> | Yes | Constant <code>digital-twin-pcg64-fixed-v2</code> | — |
| <code>oneOf&#91;2&#93;.seed</code> | Yes | <code>string</code> | — |
| <code>oneOf&#91;2&#93;.pathCount</code> | Yes | <code>integer</code> | Allowed: <code>2000</code>, <code>10000</code> |
| <code>oneOf&#91;2&#93;.stepCount</code> | Yes | <code>integer</code> | Minimum: <code>1</code>; Maximum: <code>365</code> |
| <code>oneOf&#91;2&#93;.scenario</code> | Yes | [ScenarioDefinition](/api-reference/schemas/scenario-definition/) | — |
| <code>oneOf&#91;2&#93;.variants</code> | Yes | Array of <code>object</code> | Min items: <code>5</code>; Max items: <code>5</code> |
| <code>oneOf&#91;2&#93;.variants&#91;&#93;.variant</code> | Yes | <code>string</code> | Allowed: <code>CURRENT</code>, <code>RECOMMENDED</code>, <code>CONSERVATIVE</code>, <code>CAPITAL&#95;EFFICIENT</code>, <code>EMERGENCY</code> |
| <code>oneOf&#91;2&#93;.variants&#91;&#93;.endingValueQuote</code> | Yes | [DistributionPercentiles](/api-reference/schemas/distribution-percentiles/) | — |
| <code>oneOf&#91;2&#93;.variants&#91;&#93;.slippagePips</code> | Yes | [PipsPercentiles](/api-reference/schemas/pips-percentiles/) | — |
| <code>oneOf&#91;2&#93;.variants&#91;&#93;.drawdownPips</code> | Yes | [PipsPercentiles](/api-reference/schemas/pips-percentiles/) | — |
| <code>oneOf&#91;2&#93;.variants&#91;&#93;.turnoverQuote</code> | Yes | [DistributionPercentiles](/api-reference/schemas/distribution-percentiles/) | — |
| <code>oneOf&#91;2&#93;.variants&#91;&#93;.gasCostQuote</code> | Yes | [DistributionPercentiles](/api-reference/schemas/distribution-percentiles/) | — |
| <code>oneOf&#91;2&#93;.variants&#91;&#93;.feeIncomeQuote</code> | Yes | [DistributionPercentiles](/api-reference/schemas/distribution-percentiles/) | — |
| <code>oneOf&#91;2&#93;.variants&#91;&#93;.protocolFeesQuote</code> | Yes | [DistributionPercentiles](/api-reference/schemas/distribution-percentiles/) | — |
| <code>oneOf&#91;2&#93;.variants&#91;&#93;.platformFeesQuote</code> | Yes | [DistributionPercentiles](/api-reference/schemas/distribution-percentiles/) | — |
| <code>oneOf&#91;2&#93;.variants&#91;&#93;.inventoryPips</code> | Yes | [PipsPercentiles](/api-reference/schemas/pips-percentiles/) | — |
| <code>oneOf&#91;2&#93;.variants&#91;&#93;.minimumDepthQuote</code> | Yes | [DistributionPercentiles](/api-reference/schemas/distribution-percentiles/) | — |
| <code>oneOf&#91;2&#93;.variants&#91;&#93;.reserveBreachProbabilityPips</code> | Yes | [Pips](/api-reference/schemas/pips/) | — |
| <code>oneOf&#91;2&#93;.variants&#91;&#93;.drivers</code> | Yes | Array of <code>object</code> | — |
| <code>oneOf&#91;2&#93;.variants&#91;&#93;.drivers&#91;&#93;.driver</code> | Yes | <code>string</code> | Allowed: <code>PRICE&#95;PATH</code>, <code>VOLATILITY</code>, <code>FLOW</code>, <code>LIQUIDITY</code>, <code>UNLOCK</code>, <code>GAS</code>, <code>RESERVE</code> |
| <code>oneOf&#91;2&#93;.variants&#91;&#93;.drivers&#91;&#93;.impactQuote</code> | Yes | [SignedAtomicAmount](/api-reference/schemas/signed-atomic-amount/) | — |
| <code>oneOf&#91;2&#93;.variants&#91;&#93;.drivers&#91;&#93;.evidence</code> | Yes | <code>string</code> | — |
| <code>oneOf&#91;2&#93;.variants&#91;&#93;.drivers&#91;&#93;.method</code> | Yes | Constant <code>DETERMINISTIC&#95;COUNTERFACTUAL&#95;DELTA&#95;V1</code> | — |
| <code>oneOf&#91;2&#93;.recommendedVariant</code> | Yes | <code>string</code> | Allowed: <code>CURRENT</code>, <code>RECOMMENDED</code>, <code>CONSERVATIVE</code>, <code>CAPITAL&#95;EFFICIENT</code>, <code>EMERGENCY</code> |
| <code>oneOf&#91;2&#93;.warnings</code> | Yes | Array of <code>string</code> | — |
| <code>oneOf&#91;2&#93;.inputSnapshot</code> | Yes | [SimulationStudyInputSnapshot](/api-reference/schemas/simulation-study-input-snapshot/) | — |
| <code>oneOf&#91;2&#93;.sourceLineage</code> | Yes | [SimulationStudySourceLineage](/api-reference/schemas/simulation-study-source-lineage/) | — |
| <code>oneOf&#91;3&#93;.engineVersion</code> | Yes | Constant <code>digital-twin-pcg64-fixed-v2</code> | — |
| <code>oneOf&#91;3&#93;.seed</code> | Yes | <code>string</code> | — |
| <code>oneOf&#91;3&#93;.pathCount</code> | Yes | Constant <code>10000</code> | — |
| <code>oneOf&#91;3&#93;.stepCount</code> | Yes | <code>integer</code> | Minimum: <code>1</code>; Maximum: <code>365</code> |
| <code>oneOf&#91;3&#93;.scenario</code> | Yes | [ScenarioDefinition](/api-reference/schemas/scenario-definition/) | — |
| <code>oneOf&#91;3&#93;.variants</code> | Yes | Array of JSON value | Max items: <code>0</code> |
| <code>oneOf&#91;3&#93;.recommendedVariant</code> | Yes | <code>null</code> | — |
| <code>oneOf&#91;3&#93;.warnings</code> | Yes | Array of <code>string</code> | — |
| <code>oneOf&#91;3&#93;.state</code> | Yes | Constant <code>QUEUED</code> | — |
| <code>oneOf&#91;3&#93;.inputHash</code> | Yes | [Hash](/api-reference/schemas/hash/) | — |
| <code>oneOf&#91;3&#93;.inputSnapshot</code> | Yes | [SimulationStudyInputSnapshot](/api-reference/schemas/simulation-study-input-snapshot/) | — |
| <code>oneOf&#91;3&#93;.sourceLineage</code> | Yes | [SimulationStudySourceLineage](/api-reference/schemas/simulation-study-source-lineage/) | — |

Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.

Exact definition: <code>#/components/schemas/SimulationStudy</code> in the [OpenAPI contract](/openapi/liquidity-operating-system-v2.openapi.json).