Kiln docs
Search…
⌃K

Tezos (XTZ): Fetch staking rewards

Fetch Tezos Staking Rewards easily to make your reports programmatically.

Stakes

API Objects

Tezos Stake object

Field
Value Type
Description
stake_address
string
Address of the wallet delegating
baker_address
string
Address of the baker to which the stake is delegated to
balance
string
Current balance of the stake (mutez)
rewards
string
Total net rewards earned since activation (mutez)
gross_apy
number
Gross APY for the stake
state
string (see Tezos Stake State below)
Current stake state
delegated_at
string
An RFC3339 date indicating when the stake was made, it corresponds to the block time.
delegated_block
string
The block at which the stake was made.
delegated_cycle
number
The Tezos cycle at which the stake was made
activated_cycle
number
The Tezos cycle at which the stake was activated and started earning rewards. Omitted if the stake is not active yet.
activated_at
string
An RFC3339 date indicating the start time of the activation cycle. Omitted if the stake is not active yet.
updated_at
string
An RFC3339 date indicating when this data was last refreshed.

Tezos Stake State enum

Value
Description
activating
Stake delegation has been approved on-chain.
active
Stake delegation has started earning rewards (7 cycles after staking has been made)
inactive
Stake has been undelegated

Queries

API

Oops, something is missing.
We could not find the original source to display this content.

Rewards

API Objects

Tezos Reward with format=daily (or no query param format)

Field
Value Type
Description
rewards
string
Gross rewards for that day
gross_apy
string
Gross Annual Percentage Yield
active_balance
string
Active balance in mutez
date
string
Date (RFC3339 UTC time)
Tezos Reward with format=cycle
Field
Value Type
Describe
rewards
string
Gross rewards for that cycle
gross_apy
string
Gross annual percentage yield
active_balance
string
Active balance for the cycle in mutez
cycle
int
The cycle number
cycle_begins_at
string
The RFC3339 date at which the cycle started

Queries

API

Oops, something is missing.
We could not find the original source to display this content.