GETDeprecated

Get staking accrual history

Deprecated. This endpoint is being decommissioned. Please use /{coin}/reward-accrual-report (https://app.bitgo-test.com/api/staking/v1/{coin}/reward-accrual-report) for reward reports. Retrieve staking delegation accrual history.

Path Params

coin string enum required

The staking asset.

ADAAPTASIKAVACOSMOSATOMAVAXCAVAXPBABYBERABLDBSCBTCCOREDAOCOREUMCRONOSCSPRDOTEIGENETHFLRPHASHINJECTIVEMATICNEAROSMOPOLPOLYXRETH-ROCKETSEISOMISOLSTORYSTXSUISUI:WALTAOTIATONTRXWETHWCTWFLRXDCZETA
walletId string required

The wallet ID.

Query Params

range string enum

The time range for the data.

HOURLYDAILY
startDate string date-time

The start date to search from.
endDate string date-time

The end date to search from.
page integer nullable

The page number for pagination.

>= 1

Defaults to 1
pageSize integer nullable

The page size for pagination.

>= 1 · <= 100

Defaults to 20
sortBy string enum

Sort By field

Defaults to -createdDate

-createdDatecreatedDate

Responses

200

Successful Retrieving Delegation Accrual History

Response Body

object

accruals array of objects

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

Bad Request

Response Body

object

error string
errorName string
reqId string
context object

401

Unauthorized

Response Body

object

error string
errorName string
reqId string
context object

403

Forbidden

Response Body

object

error string
errorName string
reqId string
context object

404

Not Found

Response Body

object

error string
errorName string
reqId string
context object

409

Conflict

Response Body

object

error string
errorName string
reqId string
context object

500

Server Error - Transient error please try again

Response Body

object

error string
errorName string
reqId string
context object

curl --request GET \ --url 'https://app.bitgo-test.com/api/staking/v1/coin/wallets/walletId/delegations/accruals&range=HOURLY&startDate=string&endDate=string?page=1&pageSize=20&sortBy=-createdDate' \ --header 'accept: application/json' \ --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

const url = 'https://app.bitgo-test.com/api/staking/v1/coin/wallets/walletId/delegations/accruals&range=HOURLY&startDate=string&endDate=string?page=1&pageSize=20&sortBy=-createdDate'; const options = {method: 'GET', headers: {accept: 'application/json', 'Authorization': 'Bearer YOUR_ACCESS_TOKEN'}}; fetch(url, options) .then(res => res.json()) .then(json => console.log(json)) .catch(err => console.error(err));

require 'uri' require 'net/http' url = URI("https://app.bitgo-test.com/api/staking/v1/coin/wallets/walletId/delegations/accruals&range=HOURLY&startDate=string&endDate=string?page=1&pageSize=20&sortBy=-createdDate") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Get.new(url) request["accept"] = 'application/json' request["Authorization"] = 'Bearer YOUR_ACCESS_TOKEN' response = http.request(request) puts response.read_body

<?php require_once('vendor/autoload.php'); $client = new \GuzzleHttp\Client(); $response = $client->request('GET', 'https://app.bitgo-test.com/api/staking/v1/coin/wallets/walletId/delegations/accruals&range=HOURLY&startDate=string&endDate=string?page=1&pageSize=20&sortBy=-createdDate', [ 'headers' => [ 'accept' => 'application/json', 'Authorization' => 'Bearer YOUR_ACCESS_TOKEN', ], ]); echo $response->getBody();

import requests url = "https://app.bitgo-test.com/api/staking/v1/coin/wallets/walletId/delegations/accruals&range=HOURLY&startDate=string&endDate=string?page=1&pageSize=20&sortBy=-createdDate" headers = { "accept": "application/json", "Authorization": "Bearer YOUR_ACCESS_TOKEN" } response = requests.get(url, headers=headers) print(response.text)

{ "accruals": [ { "delegationId": "string", "coin": "ADA", "enterpriseId": "string", "withdrawalAddress": "string", "delegationAddress": "string", "delegated": "string", "pendingDelegated": "string", "pendingUndelegated": "string", "rewardsReceived": "string", "locked": "string", "date": "string", "wallet": { "walletId": "string", "spendable": "string" } } ], "page": 0, "totalPages": 0, "totalElements": 0 }