Klineo/Docs
Open app ↗

API schemas

ScenarioDefinition

All API schemas

object — Additional properties rejected

Field Required at this level Type Description and constraints
id Yes string —
name Yes string —
kind Yes string Allowed: HISTORICAL_REPLAY, BULL, BEAR, SIDEWAYS, LIQUIDITY_CRISIS, TOKEN_UNLOCK, LARGE_BUYER, LARGE_SELLER, LIQUIDITY_WITHDRAWAL, GAS_SPIKE, ORACLE_OUTAGE, COMBINED
driftPipsPerStep Yes integer Minimum: -1000000; Maximum: 1000000
volatilityPipsPerStep Yes Pips —
liquidityWithdrawalPips Yes Pips —
oneSidedFlowPips Yes Pips —
gasIncreasePips Yes Pips —
oracleOutageStep No integer Minimum: 0; Maximum: 364
historicalReturnPips No Array of integer Min items: 1; Max items: 365
protocolFeePips No Pips —
platformFeePips No Pips —
unlocks Yes Array of UnlockTranche Max items: 256

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