Ctrl+K

Get staking accrual history

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

Retrieve staking delegation accrual history.

Path Parameters

  • coinstring or stringRequired
    The staking asset.
  • walletIdstringRequired
    The wallet ID of the wallet a user staked from. Either the enterpriseId or walletId need to be passed in.
    Example: 59cd72485007a239fb00282ed480da1f

Query Parameters

  • delegationIdsstring
    Delegation IDs
  • rangestring
    The time range for the data, either hourly or daily.
  • startDatestring<date-time>
    The start date to search from.
  • endDatestring<date-time>
    The end date to search from.
  • 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

accruals array[object]
An array of delegation accruals.
rewardsReceived string
The total rewards received over the lifetime of the wallet.
delegated string
The total rewards delegated (staked).
pendingDelegated string
The total amount pending to be delegated (staked).
pendingUndelegated string
Total amount pending to be undelegated (unstaked).
spendable string
Total spendable (withdrawable) amount in the wallet.
locked string
The total amount locked but not delegated (staked). Example is staking rewards that are not re-staked and compounding.
delegationId string
The delegation ID.
delegationAddress string
The delegation address.
withdrawalAddress string
The withdrawal address.
walletId string
The wallet ID.
enterpriseId string
The enterprise ID.
coin string
The staking asset.
date string <date-time>
The date and time of the accrual record.
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