latestOpenAPI 3.0.32026-08-224982,0272.8 MB

e445c15e5bee

Staking State Information

List staking details by wallet

Get staking wallet information including staking delegated balance, rewards accrued, and rewards accrual annual percentage rate.

get/api/staking/v1/{coin}/wallets/{walletId}

Path parameters

coin'ADA' | 'APT' | 'ASI' | 'KAVACOSMOS' | 'ATOM' | 'AVAXC' | 'AVAXP' | 'BABY' | 'BERA' | 'BLD' | 'BSC' | 'BTC' | 'COREDAO' | 'COREUM' | 'CRONOS' | 'CSPR' | 'DOT' | 'EIGEN' | 'ETH' | 'FLRP' | 'HASH' | 'INJECTIVE' | 'MATIC' | 'NEAR' | 'OSMO' | 'POL' | 'POLYX' | 'RETH-ROCKET' | 'SEI' | 'SOMI' | 'SOL' | 'STORY' | 'STX' | 'SUI' | 'SUI:WAL' | 'TAO' | 'TIA' | 'TON' | 'TRX' | 'WETH' | 'WCT' | 'WFLR' | 'XDC' | 'ZETA' required

The staking asset.

The staking asset.

walletIdstring required
Example:59cd72485007a239fb00282ed480da1f

The wallet ID.

Query parameters

excludeExtraWalletInformationboolean

Exclude balance and attributes for the wallet

Response

Successful Get a Staking Wallet

enterpriseIdstring required

The ID of the enterprise where the staking request was created.

walletIdstring required

The ID of the wallet where the staking request was created.

stakingWalletIdstring nullable

The unique identifier of the staking wallet entity.

walletType'cold' | 'custodial' | 'custodialPaired' | 'hot' | 'trading' required

The type of wallet the staking request was created from.

labelstring nullable

The label of the wallet the staking request was created from.

coinstring required

The staking asset.

parentCoinstring nullable

The parent asset of the staking coin.

rewardCoinstring nullable

The coin in which rewards are denominated, if different from the staking coin (e.g., VTHO for VET staking).

assetBalancestring nullable

The total asset balance in base units.

delegatedstring required

The delegated staked amount in base units.

pendingUnstakestring required

The amount that is actively being unstaked.

pendingStakestring required

The amount that is actively being staked.

rewardsstring required

The amount of rewards received in base units.

pendingClaimRewardsstring required

The amount of rewards that are pending claim in base units.

lockedRewardsstring required

The amount of locked rewards in base units.

reservedstring required

The amount reserved in base units.

pendingReservedstring required

The amount pending reservation in base units.

apystring required

The reward accrual annual percentage rate. The rate is estimated yearly based on the last 7 days using the same methodology as leading beacon chain validator aggregators (e.g. https://beaconcha.in/validators).

createdDatestring date-time nullable

The date the staking request was created.

modifiedDatestring date-time nullable

The last date the staking wallet was modified.