Klineo/Docs
Open app ↗

API schemas

CapitalRequirementStudy

All API schemas

object — Additional properties rejected

Field Required at this level Type Description and constraints
calculationVersion Yes string Allowed: capital-requirement-v1, capital-requirement-v2
intent Yes IssuerIntent —
minimumCapitalQuote Yes AtomicAmount —
recommendedRangeWidthPips Yes Pips —
requiredStableReserveQuote Yes AtomicAmount —
expectedFeeIncomeLowQuote Yes AtomicAmount —
expectedFeeIncomeHighQuote Yes AtomicAmount —
inventoryExposurePips Yes Pips —
confidencePips Yes Pips —
variants Yes Array of LiquidityPlanVariant Min items: 5; Max items: 5
assumptions Yes Array of string —

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