Ctrl+K

List staking details by wallet

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

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

Path Parameters

  • coinstringRequired
    The staking asset.
    Enum: ADA APT ASI 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 ZETA
  • walletIdstringRequired
    The wallet ID.
    Example: 59cd72485007a239fb00282ed480da1f

Query Parameters

  • excludeExtraWalletInformationboolean
    Exclude balance and attributes for the wallet

200 Response

enterpriseId string required
The ID of the enterprise where the staking request was created.
walletId string required
The ID of the wallet where the staking request was created.
stakingWalletId
string or null
The unique identifier of the staking wallet entity.
walletType string required
The type of wallet the staking request was created from.
Allowed values: cold custodial custodialPaired hot trading
label
string or null
The label of the wallet the staking request was created from.
coin string required
The staking asset.
parentCoin
string or null
The parent asset of the staking coin.
assetBalance
string or null
The total asset balance in base units.
delegated string required
The delegated staked amount in base units.
pendingUnstake string required
The amount that is actively being unstaked.
pendingStake string required
The amount that is actively being staked.
spendableAttributes object
Spendable attributes available for a wallet’s staking operations.
staking object
unstaking object
Spendable amounts and rules specific to unstaking operations.
claimRewards object
Spendable attributes specific to claiming staking rewards.
switchValidator object
permissionAttributes object
Permission attributes for the staking wallet.
staking object
Permission attributes specific to staking.
unstaking object
Permission attributes specific to unstaking.
claimRewards object
Permission attributes specific to claiming staking rewards.
switchValidator object
Permission attributes specific to switching validators.
wallet object
Permission attributes specific to the wallet.
users
array[object] or null
The users associated with the staking wallet.
user string required
The ID of the user.
permissions array[string]
The list of permissions assigned to the user.
rewards string required
The amount of rewards received in base units.
pendingClaimRewards string required
The amount of rewards that are pending claim in base units.
lockedRewards string required
The amount of locked rewards in base units.
reserved string required
The amount reserved in base units.
pendingReserved string required
The amount pending reservation in base units.
apy string 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).
createdDate
string or null
<date-time>
The date the staking request was created.
modifiedDate
string or null
<date-time>
The last date the staking wallet was modified.
propertiesOne of
type string required
Allowed value: BASE
walletMultisigType string required
Allowed value: TSS

400 Response

error string
errorName string
reqId string
context object

401 Response

error string
errorName string
reqId string
context object

403 Response

error string
errorName string
reqId string
context object

404 Response

error string
errorName string
reqId string
context object

409 Response

error string
errorName string
reqId string
context object

500 Response

error string
errorName string
reqId string
context object