Klineo/Docs
Open app ↗

API schemas

SimulationStudyRequest

All API schemas

object — Additional properties rejected

Field Required at this level Type Description and constraints
issuerIntentId Yes string Min length: 3; Max length: 160
expectedIssuerIntentResourceVersion Yes Hash —
seed Yes string Min length: 8; Max length: 200
pathCount Yes integer Allowed: 2000, 10000
stepCount Yes integer Minimum: 1; Maximum: 365
startingPortfolioQuote Yes PositiveAtomicAmount —
startingDepthQuote Yes PositiveAtomicAmount —
startingInventoryPips Yes Pips —
scenario Yes ScenarioDefinition —
reason Yes string Min length: 3; Max length: 500

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