Klineo/Docs
Open app ↗

API schemas

UnlockImpact

All API schemas

object — Additional properties rejected

Field Required at this level Type Description and constraints
calculationVersion Yes string Allowed: unlock-impact-v1, unlock-impact-v2
unlockIds Yes Array of string —
sourceLaunchPlanId No string —
sourceObservation No UnlockImpactSourceObservation —
inputHash No Hash —
inputSnapshot No UnlockImpactInputSnapshot —
correlationGroups No Array of object —
correlationGroups[].groupId Yes string —
correlationGroups[].unlockIds Yes Array of string —
correlationGroups[].totalUnlockedToken Yes AtomicAmount —
correlationGroups[].confidencePips Yes Pips —
correlationGroups[].sellPressureTokenRange Yes object Additional properties rejected
correlationGroups[].sellPressureTokenRange.p5 Yes AtomicAmount —
correlationGroups[].sellPressureTokenRange.p50 Yes AtomicAmount —
correlationGroups[].sellPressureTokenRange.p95 Yes AtomicAmount —
sellPressureTokenRange No object Additional properties rejected
sellPressureTokenRange.p5 Yes AtomicAmount —
sellPressureTokenRange.p50 Yes AtomicAmount —
sellPressureTokenRange.p95 Yes AtomicAmount —
sellPressureQuoteRange No object Additional properties rejected
sellPressureQuoteRange.p5 Yes AtomicAmount —
sellPressureQuoteRange.p50 Yes AtomicAmount —
sellPressureQuoteRange.p95 Yes AtomicAmount —
priceImpactPipsRange No object Additional properties rejected
priceImpactPipsRange.p5 Yes Pips —
priceImpactPipsRange.p50 Yes Pips —
priceImpactPipsRange.p95 Yes Pips —
expectedSellPressureToken Yes AtomicAmount —
expectedSellPressureQuote Yes AtomicAmount —
usableDepthAfterQuote Yes AtomicAmount —
expectedPriceImpactPips Yes Pips —
requiredStableReserveQuote Yes AtomicAmount —
recommendedRangeShiftPips Yes integer —
treasuryRiskPips Yes Pips —
confidencePips Yes Pips —
warnings 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/UnlockImpact in the OpenAPI contract.