GET
List staking validators for a wallet
Returns a list of staking validators for a wallet, and includes the total delegated amount and the amount of accrued rewards.
Path Params
-
coinstring enum requiredThe staking asset.ADAAPTASIKAVACOSMOSATOMAVAXCAVAXPBABYBERABLDBSCBTCCOREDAOCOREUMCRONOSCSPRDOTEIGENETHFLRPHASHHYPEEVMINJECTIVEMATICNEAROSMOPOLPOLYXRETH-ROCKETSEISOMISOLSTORYSTXSUISUI:WALTAOTIATONTRXWETHWCTWFLRXDCZETA -
walletIdstring requiredThe wallet ID.
Query Params
-
pageinteger nullableThe page number for pagination. -
pageSizeinteger nullableThe page size for pagination. -
statusarray of string enumsComma-separated list of delegation statuses to filter by. Defaults toACTIVE,PENDING.PENDINGFAILEDREJECTEDACTIVECOMPLETE -
validatorAddressstringValidator address to filter results by. Expect 1 item only. -
subTypestringThe delegation staking sub type to filter by (e.g., LIDO, MARINADE, JITO for liquid staking variants). -
unstakeablebooleanETH only. Whentrue, only delegations that can currently be unstaked are aggregated (ACTIVE, not exiting, and active for at least 256 finalized epochs), so the per-provider delegated amount matches the unstakeable delegations list. If the beacon finality lookup fails the request returns an error instead of the unfiltered amounts. Ignored for other coins. Defaults tofalse.
Responses
200
Successful Retrieving Staking Validators For A Wallet
Response Body
object
-
validatorsarray of objectsvalidators object
-
delegationAddressstringThe delegation address. -
coinstringThe staked coin. -
delegatedstringThe total delegated amount in base units. -
totalStakedstringThe total staked amount in base units. -
rewardsstringThe reward accrual amount in base units. -
activeRewardsstringThe amount of active rewards in base units. -
pendingClaimRewardsstringThe amount of rewards pending claim in base units. -
apystringThe annual percentage yield. -
historicRatePerformancestringThe historical APY/return performance of the validator. -
commissionstringThe validator commission rate. -
typestringThe validator provider display used for staking. -
providerstringThe validator provider enum used for staking. -
rewardCoinstringThe coin in which rewards will be received. -
endTimestringThe timestamp when the staking position expires, at which point it will either be unstaked automatically or become available for manual unstaking. -
pendingStakestringThe amount currently pending stake. -
pendingUnstakestringThe amount currently pending unstake. -
enterpriseIdstringThe enterprise ID of the wallet. -
walletIdstringThe wallet ID. -
lastRedelegationTimestampstringThe timestamp of the last redelegation. -
permissionAttributesobjectPermission attributes for the staking wallet.permissionAttributes object
-
stakingobjectPermission attributes specific to staking.staking object
-
allowClientToUseOwnValidatorbooleanTrue if the client is allowed to stake to their own validator. -
allowClientToUseOwnDRepboolean nullableADA-specific. True if the client can use their own DRep for governance. -
allowVoteDelegationboolean nullableADA-specific. True if the client can delegate votes. -
requireVoteDelegationboolean nullableADA-specific. True if vote delegation is required. -
enabledboolean requiredTrue if the permission is enabled. -
disabledReasonstring nullableReason why the permission is disabled, if applicable.
-
-
unstakingobjectPermission attributes specific to unstaking.unstaking object
-
enabledboolean requiredTrue if the permission is enabled. -
disabledReasonstring nullableReason why the permission is disabled, if applicable.
-
-
claimRewardsobjectPermission attributes specific to claiming staking rewards.claimRewards object
-
enabledboolean requiredTrue if the permission is enabled. -
disabledReasonstring nullableReason why the permission is disabled, if applicable.
-
-
switchValidatorobjectPermission attributes specific to switching validators.switchValidator object
-
enabledboolean requiredTrue if the permission is enabled. -
disabledReasonstring nullableReason why the permission is disabled, if applicable.
-
-
walletobjectPermission attributes specific to the wallet.wallet object
-
hasEnoughAdminsbooleanTrue, if the wallet has enough admins to create a staking request. -
numberOfRequiredAdminsintegerThe number of admins required to create a hot staking request. -
useValidatorListbooleanBoolean flag to control whether to show dropdown list of validators or not. -
skipAddressValidationbooleanBoolean flag to control whether to perform validator address validation or not. -
showValidatorAddressbooleanBoolean flag to control whether to display the validator address in the UI even when skipAddressValidation is true. -
allowPartialUnstakebooleanTrue if the wallet allows partial unstaking. -
validatorNotNeededForStakebooleanTrue if a validator is not required when staking. -
validatorCoinstring nullableOptional coin used for validator-specific staking.
-
-
-
spendableAttributesobjectSpendable attributes available for a wallet’s staking operations.spendableAttributes object
-
stakingobjectstaking object
-
netMaxstringThe maximum spendable amount minus fees. -
netMinstringThe net minimum spendable amount plus fees. -
isStakingDurationNeededbooleanTrue, if staking duration in seconds is required. -
defaultStakingDurationstringOptional default staking duration in seconds. -
unlockTimeEpochSecondsstringOptional unlock time in epoch seconds. -
minStakeMorestringThe minimum amount required to stake more to the same validator. -
minDurationstringMinimum allowed staking duration in seconds. -
maxDurationstringMaximum allowed staking duration in seconds. -
durationLabelstringOptional label for staking duration (e.g., "Epoch"). -
breakdownobjectBreakdown of staking spendable amounts, including balances, fees, and limits.breakdown object
-
balancestringTotal balance available for staking operations. -
stakingFeestringFee amount required to perform staking operations. -
unstakingFeestringFee amount required to perform unstaking operations. -
pendingStakestringAmount of stake that has been requested but is not yet active. -
proxyCoststringProxy fee cost (applies to DOT staking only). -
maxSpendablestringMaximum amount that can be spent on staking after accounting for fees and limits. -
minSpendablestringMinimum amount required for a valid staking operation.
-
-
namestringOptional staking type name (UI label). -
typestringOptional staking type identifier. -
fieldsarray of objectsAdditional form fields required for staking (e.g., resource type selection dropdown).fields object
-
namestringMachine-readable name of the staking field. -
labelstringHuman-readable label for display. -
requiredbooleanWhether this field must be provided. -
typestringInput type (e.g., text, number, select). -
coinstringOptional coin symbol associated with the field. -
useValidatorListbooleanWhether this field should use the validator list as options. -
readonlybooleanIf true, the field is not editable. -
valuestringOptional pre-filled or default value for the field. -
minstringOptional minimum value (serialized as string). -
maxstringOptional maximum value (serialized as string). -
optionsarray of objectsSelect/dropdown options for the field, if applicable.options object
-
labelstringHuman-readable label for the option. -
valuestringMachine-readable value for the option. -
descriptionstringOptional explanation of the option. -
amountstringOptional amount associated with this option (used for fixed-amount staking like VET NFT tiers).
-
-
-
stakingSubTypesarray of objectsAvailable staking sub-types with their own attributes.stakingSubTypes object
-
namestringThe display name of the staking sub-type. -
typestringThe identifier of the staking sub-type. -
feestringThe blockchain fee for this sub-type. -
maxstringThe maximum amount for this sub-type. -
minstringThe minimum amount for this sub-type. -
netMaxstringThe net maximum amount for this sub-type. -
netMinstringThe net minimum amount for this sub-type. -
multiplierstringThe multiplier for this sub-type. -
decimalstringOptional custom conversion factor, when provided, should use amount ÷ decimal to get converted to derived unit. -
displayUnitstringOptional custom unit (e.g., "TP" for TronPower). When provided, this unit is the derived unit of the amounts in the attributes.
-
-
isDelegatedbooleanTrue if this staking is delegated. -
restakingobjectAttributes related to restaking positions.restaking object
-
totalstringTotal amount currently restaked. -
pendingStakestringAmount of stake that has been requested but is not yet active. -
pendingUnstakestringAmount of stake that is pending to be unstaked. -
operatorstringThe operator identifier for the restaking position. -
typestringThe type of restaking (e.g., EigenLayer, AVS, etc.). -
avsesarray of stringsOptional list of AVS (Actively Validated Services) identifiers linked to this restaking. -
apystring decimalAnnual percentage yield (APY) for the restaking position. -
commissionPercentstring decimalCommission percentage charged by the operator.
-
-
stakingSubTypesStylestringOptional style hint for rendering staking sub-types. -
decimalstringOptional custom conversion factor, when provided, use amount ÷ decimal to get derived unit. -
displayUnitstringOptional custom unit (e.g., "TP" for TronPower). When provided, this unit is the derived unit of the amounts in the attributes. -
fixedAmountStakingbooleanIndicates that staking amounts are fixed per tier/option and should be auto-filled from the selected option's amount field. When true, the UI should prefill and make the amount field readonly. -
conversionRatesmap of stringsMap of netUID to alpha-to-TAO conversion rate (string-encoded BigInteger). Used to display TAO equivalent amounts in the staking form.conversionRates object
-
<key>string
-
-
maxstringThe maximum spendable amount. -
minstringThe minimum spendable amount. -
multiplierstringThe multiplier amount to be staked. Default to 1, but for coins like where the amount to stake is a multiple of 32 ETH, this is 32 in base unit, to allow validation. -
feestringThe blockchain fee to submit the transactions.
-
-
unstakingobjectSpendable amounts and rules specific to unstaking operations.unstaking object
-
multipleDelegationsbooleanTrue if more than one active staking delegation exists for a wallet. -
breakdownobjectDetailed breakdown of spendable amounts and fees for unstaking.breakdown object
-
balancestring bigIntegerCurrent balance available for unstaking. -
unstakingFeestring bigIntegerFee required to perform an unstaking transaction. -
maxSpendablestring bigIntegerMaximum amount that can be unstaked in a single transaction. -
unstakeableobjectBreakdown of the wallet’s staked funds that can be unstaked.unstakeable object
-
stakedBalancestring bigIntegerTotal amount currently staked. -
pendingUnstakestring bigIntegerAmount already requested for unstaking but not yet completed. -
maxUnstakeablestring bigIntegerMaximum amount of staked funds that can be unstaked at this time.
-
-
-
requiresAmountbooleanWhether specifying an amount is required for the unstaking request. -
requiresDelegationIdbooleanWhether a single delegation ID is required for the unstaking request. -
requiresDelegationIdsbooleanWhether multiple delegation IDs must be specified for the unstaking request. -
fieldsarray of objectsDynamic form fields for the unstaking request (e.g., resource type selection).fields object
- Same shape as
StakingField.
- Same shape as
-
unstakingSubTypesarray of objectsSupported unstaking sub-types with their own spendable attributes.unstakingSubTypes object
-
namestringHuman-readable name of the unstaking sub-type. -
typestringInternal identifier for the unstaking sub-type. -
feestring bigIntegerFee required to perform an unstaking transaction for this sub-type. -
maxstring bigIntegerMaximum amount that can be unstaked for this sub-type. -
minstring bigIntegerMinimum amount that must be unstaked for this sub-type. -
netMaxstring bigIntegerMaximum unstakeable amount minus applicable fees. -
netMinstring bigIntegerMinimum unstakeable amount including fees. -
requiresAmountbooleanTrue if the unstaking request requires specifying an amount. -
requiresDelegationIdbooleanTrue if a single delegation ID must be specified for unstaking. -
requiresDelegationIdsbooleanTrue if multiple delegation IDs must be specified for unstaking. -
allowPartialUnstakebooleanTrue if partial unstaking (less than full delegation) is allowed. -
multipleDelegationsbooleanTrue if this sub-type supports wallets with multiple active delegations.
-
-
conversionRatesmap of stringsMap of netUID to alpha-to-TAO conversion rate (string-encoded BigInteger). Used to display TAO equivalent amounts in the unstaking form.conversionRates object
-
<key>string
-
-
maxstringThe maximum spendable amount. -
minstringThe minimum spendable amount. -
multiplierstringThe multiplier amount to be staked. Default to 1, but for coins like where the amount to stake is a multiple of 32 ETH, this is 32 in base unit, to allow validation. -
feestringThe blockchain fee to submit the transactions.
-
-
claimRewardsobjectSpendable attributes specific to claiming staking rewards.claimRewards object
-
breakdownobjectBreakdown of rewards available for claiming.breakdown object
-
totalRewardsstringTotal accumulated rewards (claimable + pending). -
claimableRewardsstringRewards that are immediately available for claiming. -
pendingClaimRewardsstringRewards that are pending and not yet claimable. -
claimFeestringEstimated fee required to claim rewards.
-
-
requiresDelegationIdbooleanTrue if a delegation ID must be specified when claiming rewards. -
rewardCoinstringThe coin in which rewards are distributed. -
rewardPairsarray of objectsOptional list of reward pairs (e.g., multiple tokens being rewarded).rewardPairs object
-
tokenAddressstring nullableThe optional token address. -
amountstring requiredThe total amount of the reward pair in base units. -
activeAmountstring requiredThe currently active amount in base units. -
coinstring nullableThe optional coin for this reward pair.
-
-
maxstringThe maximum spendable amount. -
minstringThe minimum spendable amount. -
multiplierstringThe multiplier amount to be staked. Default to 1, but for coins like where the amount to stake is a multiple of 32 ETH, this is 32 in base unit, to allow validation. -
feestringThe blockchain fee to submit the transactions.
-
-
switchValidatorobjectswitchValidator object
-
breakdownobjectbreakdown object
-
balancestringThe wallet balance available for validator switching. -
switchFeestringThe fee required to switch validators. -
switchableobjectswitchable object
-
stakedBalancestringThe total balance currently staked that can be switched. -
pendingUnstakestringThe amount currently pending unstake, not switchable until complete. -
maxSwitchablestringThe maximum amount of balance that can be switched to another validator.
-
-
-
requiresDelegationIdbooleanTrue if a delegation ID must be specified when switching validators. -
requiresAmountbooleanTrue if an amount must be specified when switching validators. -
useDelegationForTargetbooleanTrue if the validator field of a switch validator request must be a validator public key. -
maxstringThe maximum spendable amount. -
minstringThe minimum spendable amount. -
multiplierstringThe multiplier amount to be staked. Default to 1, but for coins like where the amount to stake is a multiple of 32 ETH, this is 32 in base unit, to allow validation. -
feestringThe blockchain fee to submit the transactions.
-
-
-
countstringThe number of delegations for this validator. -
avsesarray of stringsList of AVSEs associated with the validator. -
preferredbooleanWhether this validator is preferred. -
rewardPairsarray of objectsList of reward pairs.rewardPairs object
- Same shape as
RewardPairs.
- Same shape as
-
stakingTypestringThe staking type, e.g., STAKE.
-
-
pageintegerThe page number for paging purposes. -
totalPagesintegerThe total number of pages for paging purposes. -
totalElementsintegerThe number of elements per page used for paging purposes.
400
Bad Request
Response Body
object
-
errorstring -
errorNamestring -
reqIdstring -
contextobject
401
Unauthorized
Response Body
object
-
errorstring -
errorNamestring -
reqIdstring -
contextobject
403
Forbidden
Response Body
object
-
errorstring -
errorNamestring -
reqIdstring -
contextobject
404
Not Found
Response Body
object
-
errorstring -
errorNamestring -
reqIdstring -
contextobject
409
Conflict
Response Body
object
-
errorstring -
errorNamestring -
reqIdstring -
contextobject
500
Server Error - Transient error please try again
Response Body
object
-
errorstring -
errorNamestring -
reqIdstring -
contextobject