Klineo/Docs
Open app ↗

API schemas

HealthMetricComparison

All API schemas

object — Additional properties rejected

Field Required at this level Type Description and constraints
metric Yes string Allowed: QUOTE_BALANCE, PROTECTED_QUOTE_RESERVE, BUY_DEPTH, SELL_DEPTH
aggregation Yes Constant LAST_RECORDED_SAMPLE —
unit Yes Constant QUOTE_ATOMIC —
baseline Yes At least one of: HealthMetricReading; null —
observation Yes At least one of: HealthMetricReading; null —
status Yes string Allowed: COMPARABLE, BASELINE_UNAVAILABLE, OBSERVATION_UNAVAILABLE, BOTH_UNAVAILABLE, INCOMPATIBLE_UNITS, INCOMPATIBLE_DEFINITION
absoluteDelta Yes At least one of: string; null —
relativeChange Yes At least one of: object; null —
relativeChange.anyOf[1].numerator Yes string Exact signed integer difference in quote atomic units. Pattern: ^-?(0|[1-9][0-9]{0,77})$
relativeChange.anyOf[1].denominator Yes string Exact unsigned atomic amount; never coerce to a JavaScript number. Pattern: ^(0|[1-9][0-9]{0,77})$
relativeUnavailableReason Yes At least one of: string; null —

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