Klineo/Docs
Open app ↗

API schemas

SimulationStudyInputSnapshot

All API schemas

object — Additional properties rejected

Field Required at this level Type Description and constraints
schemaVersion Yes Constant simulation-study-input-snapshot-v1 —
engineVersion Yes Constant digital-twin-pcg64-fixed-v2 —
seed Yes string —
pathCount Yes integer Allowed: 2000, 10000
stepCount Yes integer Minimum: 1; Maximum: 365
targetTradeSizeQuote Yes PositiveAtomicAmount —
startingPortfolioQuote Yes PositiveAtomicAmount —
startingDepthQuote Yes PositiveAtomicAmount —
startingInventoryPips Yes Pips —
scenario Yes ScenarioDefinition —
variants Yes Array of LiquidityPlanVariant Min items: 5; Max items: 5

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/SimulationStudyInputSnapshot in the OpenAPI contract.