Ctrl+K

List staking rewards

get/api/staking/v1/enterprises/{enterpriseId}/wallets

Returns total rewards per staking wallet for an enterprise.

Path Parameters

  • enterpriseIdstringRequired
    The enterprise ID.

Query Parameters

  • coinarray[string]
    Filter by one or more staking assets.
    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 STX SUI SUI:WAL TAO TIA TON TRX WETH WCT WFLR ZETA
  • labelstring
    The label of the wallet where the staking request was created.
  • walletTypearray[string]
    Filter by Wallet Type (cold, custodial, custodialPaired, hot, trading)
    Enum: cold custodial custodialPaired hot trading
  • pageintegerDefault: 1
    The page number for pagination.
    Minimum: >= 1
  • pageSizeintegerDefault: 20
    The page size for pagination.
    Minimum: >= 1
    Maximum: <= 100

200 Response

stakingWallets array[object] required
An array of staking wallets.
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.
permissionAttributes object
Permission attributes for the staking wallet.
users
array[object] or null
The users associated with the staking wallet.
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.
properties
object or null
Additional properties of the staking wallet.
page integer required
The page number for paging purposes.
totalPages integer required
The total number of pages for paging purposes.
totalElements integer required
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

500 Response

error string
errorName string
reqId string
context object