Ctrl+K

List staking delegations

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

Retrieve staking wallet delegation information.

Path Parameters

  • coinstring or stringRequired
    The staking asset.
  • walletIdstringRequired
    The wallet ID.
    Example: 59cd72485007a239fb00282ed480da1f

Query Parameters

  • delegationIdsstring
    The delegation IDs.
  • delegationStatusstring
    The status of the delegation.
  • 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.
  • 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
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.
withdrawalAddress string
The withdrawal address.
delegated string
The delegation amount.
status string
The status of the delegation.
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.
apy string
The estimated reward APY or APR if rewards are not compounding.
unstakingFee string
The total fees needed in the wallet to unstake an amount from the delegation.
unstakingMin string
The minimum amount needed to unstake from the 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