GET

Get staking reward history

Retrieve staking reward history in hourly or daily buckets, selected by range. Responses are paginated. Buckets without recorded accrual data are not guaranteed to have zero-reward rows. Enterprise queries include only staking wallets that the API user has permission to view.

Path Params

coin string enum required

The staking asset.

ADAAPTASIKAVACOSMOSATOMAVAXCAVAXPBABYBERABLDBSCBTCCOREDAOCOREUMCRONOSCSPRDOTEIGENETHFLRPHASHHYPEEVMINJECTIVEMATICNEAROSMOPOLPOLYXRETH-ROCKETSEISOMISOLSTORYSTXSUISUI:WALTAOTIATONTRXWETHWCTWFLRXDCZETA

Query Params

enterpriseId string

The enterprise ID of the enterprise a user staked from.
walletId string

The wallet ID of the wallet a user staked from. Either the enterpriseId or walletId need to be passed in.
delegationId string

The delegation ID to filter rewards for.

aggregationLevel string enum

The response shape depends on the aggregation level and the identifier provided:

Request	Response
`WALLET` + `walletId`	`WalletLevelRewards`: per time bucket for the specified wallet. Includes `walletId`.
`WALLET` + `enterpriseId`, without `walletId`	`EnterpriseAccrual`: enterprise total per coin and time bucket. No `walletId`; does not return separate wallet rows.
`DELEGATION` + `walletId`	`DelegationLevelRewards`: per delegation and time bucket for the specified wallet. Includes `walletId` and `delegationId`.
`DELEGATION` + `enterpriseId`, without `walletId`	`DelegationLevelRewards`: per delegation and time bucket across the enterprise wallets the API user can view. Includes `walletId` and `delegationId`.

If both identifiers are provided, walletId takes precedence. Accepts uppercase (WALLET, DELEGATION) and lowercase (wallet, delegation) values.

Defaults to WALLET

WALLETDELEGATIONwalletdelegation

range string enum

The time range for the data, either hourly or daily.

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 -date

-datedate

Responses

200

Successful Retrieving Staking History

Response Body

object

rewards array of objects

An array of rewards.
rewards object
- reward string required
  
  The reward in base units.
- coin string required
  
  The coin associated with the reward.
- walletId string
  
  The wallet ID.
- enterpriseId string
  
  The enterprise ID.
- delegationId string
  
  The delegation ID, only present when aggregationLevel is delegation.
- date string date-time required
  
  The date and time of the reward.
- properties object
  
  Detailed reward information including consensus, transaction, and MEV rewards. Only populated for ETH delegations.
  properties object
  - consensusReward number
    
    Amount of rewards from consensus participation.
  - transactionReward number
    
    Amount of rewards from transaction fees.
  - mevReward number
    
    Amount of rewards from MEV (Maximum Extractable Value).
  - provider string
    
    The staking provider name.
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 -X GET \ --url 'https://app.bitgo-test.com/api/staking/v1/coin/reward-accrual-report&enterpriseId=string&walletId=59cd72485007a239fb00282ed480da1f&delegationId=string?aggregationLevel=WALLET&range=HOURLY&startDate=string&endDate=string&page=1&pageSize=20&sortBy=-date' \ --header 'accept: application/json' \ --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

const url = 'https://app.bitgo-test.com/api/staking/v1/coin/reward-accrual-report&enterpriseId=string&walletId=59cd72485007a239fb00282ed480da1f&delegationId=string?aggregationLevel=WALLET&range=HOURLY&startDate=string&endDate=string&page=1&pageSize=20&sortBy=-date'; 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/reward-accrual-report&enterpriseId=string&walletId=59cd72485007a239fb00282ed480da1f&delegationId=string?aggregationLevel=WALLET&range=HOURLY&startDate=string&endDate=string&page=1&pageSize=20&sortBy=-date") 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/reward-accrual-report&enterpriseId=string&walletId=59cd72485007a239fb00282ed480da1f&delegationId=string?aggregationLevel=WALLET&range=HOURLY&startDate=string&endDate=string&page=1&pageSize=20&sortBy=-date', [ 'headers' => [ 'accept' => 'application/json', 'Authorization' => 'Bearer YOUR_ACCESS_TOKEN', ], ]); echo $response->getBody();

import requests url = "https://app.bitgo-test.com/api/staking/v1/coin/reward-accrual-report&enterpriseId=string&walletId=59cd72485007a239fb00282ed480da1f&delegationId=string?aggregationLevel=WALLET&range=HOURLY&startDate=string&endDate=string&page=1&pageSize=20&sortBy=-date" headers = { "accept": "application/json", "Authorization": "Bearer YOUR_ACCESS_TOKEN" } response = requests.get(url, headers=headers) print(response.text)

{ "page": 1, "rewards": [ { "coin": "eth", "date": "2022-01-10T14:32:28Z", "enterpriseId": "1032e75c451052000436831deb797af1", "reward": "1000000000000000", "walletId": "2032e75g451052000636831abd797bd3" } ], "totalElements": 1, "totalPages": 1 }

{ "page": 1, "rewards": [ { "coin": "eth", "date": "2022-01-10T14:32:28Z", "delegationId": "d123456789", "enterpriseId": "1032e75c451052000436831deb797af1", "properties": { "consensusReward": 5, "mevReward": 2, "provider": "lido", "transactionReward": 3 }, "reward": "1000000000000000", "walletId": "2032e75g451052000636831abd797bd3" } ], "totalElements": 1, "totalPages": 1 }

{ "page": 1, "rewards": [ { "coin": "eth", "date": "2022-01-10T14:32:28Z", "enterpriseId": "1032e75c451052000436831deb797af1", "reward": "5000000000000000" }, { "coin": "eth", "date": "2022-01-11T14:32:28Z", "enterpriseId": "1032e75c451052000436831deb797af1", "reward": "3500000000000000" } ], "totalElements": 2, "totalPages": 1 }