View Rewards for Go Account
View staking positions, delegations, and rewards for Go Account wallets. See the Guide.
-
Retrieve overall staking positions for your Go Account, including active stakes, pending stakes, pending unstakes, rewards, and staking/unstaking attributes for each supported coin. Staking from Go Accounts enables BitGo to manage the staking process on your behalf.
Prerequisites:
- Complete the Get Started guide
- Set up your Go Account
- Stake Assets
// 1. View Rewards
export GO_ACCOUNT_ID="<YOUR_GO_ACCOUNT_ID>"
export ACCESS_TOKEN="<YOUR_ACCESS_TOKEN>"
curl -X GET \
"https://app.bitgo-test.com/api/go-staking/v1/accounts/$GO_ACCOUNT_ID/coins" \
-H 'Content-Type: application/json' \
-H "Authorization: Bearer $ACCESS_TOKEN"
// 1. View Rewards
const goStakingWallet = wallet.toGoStakingWallet();
const goStakingWallets = await goStakingWallet.getGoStakingWallets();
Response
// 1. View Rewards Response
{
"coins": [
{
"coin": "ofctsol",
"activeStake": 0,
"pendingStake": 0,
"pendingUnstake": 0,
"rewards": 0,
"attributes": {
"permissionAttributes": {
"staking": {
"enabled": true,
"allowClientToUseOwnValidator": false
},
"unstaking": {
"enabled": false,
"disabledReason": "Not actively staking TSOL"
}
},
"spendableAttributes": {
"staking": {
"fee": 0,
"max": 0,
"min": 0,
"netMax": 46000000,
"netMin": 0,
"minStakeMore": 0
},
"unstaking": {
"max": 0,
"min": 0,
"multipleDelegations": false,
"requiresAmount": true,
"requiresDelegationId": false,
"requiresDelegationIds": false
}
},
"disclaimerAttributes": {
"staking": {
"info": [
"Staking takes up to the next epoch to activate (~2.1 days) and earn rewards."
],
"rewardPercentageRate": 7,
"stakeWarmupPeriodDesc": "1 epoch (2.1 days)"
},
"unstaking": {
"info": [
"Unstaking takes up to the next epoch to deactivate (~2.1 days) and withdraw."
],
"unStakeCooldownPeriodDesc": "1 epoch (2.1 days)"
},
"nextRewards": {
"rewardCycle": 181440
}
}
}
},
{
"coin": "ofctsui",
"activeStake": 0,
"pendingStake": 0,
"pendingUnstake": 0,
"rewards": 0,
"attributes": {
"permissionAttributes": {
"staking": {
"enabled": true,
"allowClientToUseOwnValidator": false
},
"unstaking": {
"enabled": false,
"disabledReason": "Not actively staking TSUI"
}
},
"spendableAttributes": {
"staking": {
"fee": 0,
"max": 0,
"min": 0,
"netMax": 498000000,
"netMin": 0,
"minStakeMore": 0
},
"unstaking": {
"max": 0,
"min": 0,
"multipleDelegations": false,
"requiresAmount": true,
"requiresDelegationId": false,
"requiresDelegationIds": false
}
},
"disclaimerAttributes": {
"staking": {
"info": [
"Staking takes up to the next epoch to activate (24 hours) and earn rewards."
],
"rewardPercentageRate": 2.3,
"stakeWarmupPeriodDesc": "1 epoch (24 hours)"
},
"unstaking": {
"info": [
"Unstaking can take up to 24 hours. Rewards are pro-rated based on how much has been unstaked."
],
"unStakeCooldownPeriodDesc": "1 epoch (24 hours)"
},
"nextRewards": {
"rewardCycle": 86400
}
}
}
}
],
"page": 1,
"totalPages": 1,
"totalElements": 2
}