Klineo/Docs
Open app ↗

API schemas

IncentiveProgram

All API schemas

object — Additional properties rejected

Field Required at this level Type Description and constraints
programId Yes string —
venueId Yes string —
startsAt Yes string Format: date-time
endsAt Yes string Format: date-time
incentivesPaidQuote Yes PositiveAtomicAmount —
claimedRewardsQuote Yes AtomicAmount —
baseline Yes object Additional properties rejected
baseline.baselineId Yes string —
baseline.method Yes string Allowed: PRE_PROGRAM_WINDOW, MATCHED_CONTROL, FROZEN_COUNTERFACTUAL
baseline.windowStartsAt Yes string Format: date-time
baseline.windowEndsAt Yes string Format: date-time
baseline.frozenAt Yes string Format: date-time
baseline.liquidityQuote Yes AtomicAmount —
baseline.volumeQuote Yes AtomicAmount —
baseline.slippagePips Yes Pips —
baseline.evidenceHashes Yes Array of Hash Min items: 1; Max items: 128
observedLiquidityQuote Yes AtomicAmount —
observedVolumeQuote Yes AtomicAmount —
observedSlippagePips Yes Pips —
observedAt Yes string Format: date-time
observationEvidenceHashes Yes Array of Hash Min items: 1; Max items: 128
retainedLiquidityQuote Yes AtomicAmount —
retentionObservedAt Yes string Format: date-time
retentionEvidenceHashes Yes Array of Hash Min items: 1; Max items: 128
verifiedLiquidityDays Yes integer Minimum: 0; Maximum: 36500
confidencePips Yes Pips —
confidenceMethodology Yes string —
confidenceEvidenceHashes Yes Array of Hash Min items: 1; Max items: 128
requestedPoolId No string —
requestedRangeId No string —
adapterAuthorization No object Additional properties rejected
adapterAuthorization.adapterId Yes string —
adapterAuthorization.venueId Yes string —
adapterAuthorization.adapterAddress Yes Address —
adapterAuthorization.adapterRuntimeHash Yes Hash —
adapterAuthorization.auditHash Yes Hash —
adapterAuthorization.adapterManifestHash Yes Hash —
adapterAuthorization.releasedManifestDigest Yes Hash —
adapterAuthorization.providerId Yes string —
adapterAuthorization.providerKeyResourceVersion Yes Hash —
adapterAuthorization.providerAttestationHash Yes Hash —
adapterAuthorization.issuedAt Yes string Format: date-time
adapterAuthorization.validUntil Yes string Format: date-time
adapterAuthorization.allowedRecommendations Yes Array of IncentiveRecommendation Min items: 1; Max items: 7
adapterAuthorization.signature Yes string Content encoding: base64

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