Ctrl+K

List staking delegations

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

Retrieve staking wallet delegation information.

Path Parameters

  • coinstringRequired
    The staking asset.
    Enum: ADA ASI ATOM AVAXC AVAXP BABY BERA BLD BSC BTC COREDAO COREUM CRONOS CSPR DOT EIGEN ETH 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

  • delegationIdsarray[string]
    The delegation IDs.
  • delegationStatusstring
    The status of the delegation.
    Enum: PENDING FAILED REJECTED ACTIVE COMPLETE
  • unstakeableboolean
    Unsupported for staking
  • delegationAddressstring
    The address of of the delegation.
  • delegationAddressesarray[string]
    The list of delegation addresses to query for.
  • providerstring
    The validator provider used for staking.
  • subTypestring
    The delegation staking sub type to filter by, used with the unstakeable flag.
  • pageintegerDefault: 1
    The page number for pagination.
    Minimum: >= 1
  • pageSizeintegerDefault: 20
    The page size for pagination.
    Minimum: >= 1
    Maximum: <= 100
  • sortBystringDefault: -createdDate
    Sort By field
    Enum: -createdDate createdDate

200 Response

delegations
Extended delegation with BitGo-specific properties.
id string
The staking request ID.
coin string
The staking asset.
walletId string
The ID of the wallet that the delegation is tied to.
delegationAddress string
The delegation address.
validatorAddress string
The validator address of the delegation.
provider string
The staking provider backing the delegation.
providerType string
The staking provider backing the delegation. This field is used in bitgo UI to map provider with icon
withdrawalAddress string
The withdrawal address.
delegated string
The delegation amount.
status string
The status of the delegation.
Allowed values: PENDING FAILED REJECTED ACTIVE COMPLETE
rewards string
The amount of rewards received over the lifetime.
lockedRewards string
The amount of locked rewards received.
pendingUnstake string
The amount that is pending unstake.
pendingStake string
The amount that is pending stake.
reserved string
The amount that is reserved for this delegation.
pendingReserved string
The amount that is pending reservation for this delegation.
apy string
The estimated reward APY or APR if rewards are not compounding.
unstakeable boolean
Indicates whether the delegation can currently be unstaked.
propertiesOne of
claimable
boolean or null
Whether the delegation has claimable rewards.
pendingClaimRewards
string or null
Rewards that are pending claim (stringified bigint).
claimableRewards
string or null
Rewards that are currently claimable (stringified bigint).
switchable
boolean or null
Whether the delegation can be switched to another validator.
maxSwitch
string or null
Maximum amount allowed to switch (stringified bigint).
minSwitch
string or null
Minimum amount required to switch (stringified bigint).
permissionAttributes object
Permission attributes for the staking wallet.
spendableAttributes object
Spendable attributes available for a wallet’s staking operations.
restaking
boolean or null
Whether this delegation is restaking rewards automatically.
rewardPairs array[object]
Reward token breakdown for Eigen-like or ETH restaking.
rewardCoin
string or null
The reward coin associated with this delegation.
page integer
The page number for paging purposes.
totalPages integer
The total number of pages for paging purposes.
totalElements integer
The number of elements per page used for paging purposes.

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