Kiln docs
Search…
⌃K

Cardano (ADA): Fetch staking rewards

Fetch Cardano Staking Rewards easily to make your reportings programmatically.

Stakes

API Objects

Cardano Stake Object

Field
Value Type
Description
wallet_addresses
string[]
Wallet addresses associated to the stake
stake_address
string
Stake address controlling the stake
pool_id
string
Pool id on which the stake is delegated
balance
string
Active stake balance in lovelace
rewards
string
Total net rewards earned since activation in lovelace
available_rewards
string
Available rewards that can be withdrawn in lovelace
delegation_epoch
Epoch
Epoch at which the stake becomes delegated
activation_epoch
Epoch
Epoch at which the stake becomes active
state
Cardano Stake State
Stake state 'active' | 'activating' | 'inactive'
net_apy
float32
Net Annual Pourcentage Yield
updated_at
string
Epoch Date (RFC3339 UTC time)

Epoch object

Field
Value Type
Description
nb
unit
Epoch Number
begin_at
string
Epoch Date (RFC3339 UTC time)

Cardano Stake State object

Value
Description
active
The stake is actively receiving rewards
activating
The stake is not receiving rewards yet, it will be active in the next 2 epochs
inactive
The stake has been unstaked and is no longer receiving rewards

Queries

SDK

/* async getStakesByStakeAddresses(stakeAddresses: string[]): Promise<AdaStake[]> */
const stakes = await k.ada.getStakesByStakeAddresses(['abcd...']);
/* async getStakesByWallets(walletAddresses: string[]): Promise<AdaStake[]> */
const stakes = await k.ada.getStakesByWallets(['abcd...']);
/* async getStakesByAccounts(accountIds: string[]): Promise<AdaStake[]> */
const stakes = await k.ada.getStakesByAccounts(['abcd...']);

API

get
https://api.kiln.fi/v1
/ada/stakes
Retrieve Cardano Stakes for stake accounts

Rewards

API Objects

Cardano Reward object

Field
Value Type
Description
date
string
Reward day following format "2006-01-02"
rewards
string
Net rewards received for this epoch in lovelace
active_balance
string
Active balance for this epoch in lovelace
net_apy
string
Net Annual Pourcentage Yield

Queries

SDK

/* async getRewardsByStakeAddresses(stakeAddresses: string[]): Promise<AdaReward[]> */
const rewards = await k.ada.getRewardsByStakeAddresses(['abcd...']);
/* async getRewardsByWallets(walletAddresses: string[]): Promise<AdaReward[]> */
const rewards = await k.ada.getRewardsByWallets(['abcd...']);
/* async getRewardsByAccounts(accountIds: string[]): Promise<AdaReward[]> */
const rewards = await k.ada.getRewardsByAccounts(['abcd...']);

API

get
https://api.kiln.fi/v1
/ada/rewards
Retrieve Cardano Rewards