Staking Indices

What is this endpoint for?

This endpoint is used for staking indices, which are custom products whose value is derived from a combination of price data and yield data. The underlying quantity increases daily according to the APR of the asset, and the index value is obtained by multiplying the quantity by the asset price.

Endpoints

gateway-v0-grpc.kaiko.ovh

Parameters

Parameter
Description
Examples

index_code

The ticker of the staking rate

KAIKO_STK_ETHUSD_LDNLF

Fields

Field
Description

indexCode

The ticker identifying the staking index.

commodity

The publication type.

interval

A nested object containing the requested time interval.

  • startTime

The start time of the interval.

  • endTime

The end time of the interval.

composition

A nested object containing the inputs used to calculate the index price.

  • quantity

A nested object containing the quantity inputs.

  • value

The quantity used in the index calculation.

  • baseQuantity

The base quantity used to derive quantity.value.

  • utilizationRate

The utilization rate used in the quantity calculation.

  • underlyingPrice

A nested object containing the underlying price input.

  • name

The name of the price series used as the underlying price.

  • price

The underlying asset price used in the calculation.

  • tsEvent

The publication timestamp of the underlying price.

  • apr

A nested object containing the APR input.

  • name

The name of the APR series used in the calculation.

  • value

The APR value used in the calculation.

  • forwardFilled

Indicates whether the APR value was forward-filled.

  • tsEvent

The publication timestamp of the APR value.

price

The calculated staking index price.

tsEvent

The exact time of the publication.

Request examples

Make sure to read our Python quick-start guide before starting.

Response Example

Last updated

Was this helpful?