Skip to main content

Staking API

Version: 1.0

Terms of service:

  • Base URL: api.binance.org/

License: Apache 2.0

/v1/staking/accounts/{address}/balance


GET

Summary: getBalance

Parameters

NameLocated inDescriptionRequiredSchema
addresspathaddressYesstring

Responses

CodeDescriptionSchema
200OKBalanceVo
401Unauthorized
403Forbidden
404Not Found

/v1/staking/chains/{chain-id}/delegators/{delegator}/allowed-dst-validators


GET

Summary: getAllowedDstValidators

Parameters

NameLocated inDescriptionRequiredSchema
chain-idpathchain-idYesstring
delegatorpathdelegatorYesstring
limitquerylimit, min = 1, max = 100Yesinteger
offsetqueryoffset, min = 0, max = 5000Yesinteger
src-validatorquerysrc-validatorYesstring

Responses

CodeDescriptionSchema
200OKAllowedDstValidatorsVO
401Unauthorized
403Forbidden
404Not Found

/v1/staking/chains/{chain-id}/delegators/{delegator}/delegations


GET

Summary: getDelegationsValByDelegator

Parameters

NameLocated inDescriptionRequiredSchema
chain-idpathchain-idYesstring
delegatorpathdelegatorYesstring
limitquerylimit, min = 1, max = 100Yesinteger
offsetqueryoffset, min = 0, max = 5000Yesinteger

Responses

CodeDescriptionSchema
200OKDelegationValsVO
401Unauthorized
403Forbidden
404Not Found

/v1/staking/chains/{chain-id}/delegators/{delegator}/operations


GET

Summary: getOperationsByDelegator

Parameters

NameLocated inDescriptionRequiredSchema
chain-idpathchain-idYesstring
delegatorpathdelegatorYesstring
limitquerylimit, min = 1, max = 100Yesinteger
offsetqueryoffset, min = 0, max = 5000Yesinteger

Responses

CodeDescriptionSchema
200OKOperationsVO
401Unauthorized
403Forbidden
404Not Found

/v1/staking/chains/{chain-id}/delegators/{delegator}/reds


GET

Summary: getDelREDs

Parameters

NameLocated inDescriptionRequiredSchema
chain-idpathchain-idYesstring
delegatorpathdelegatorYesstring
isCompletedqueryisCompletedNointeger
limitquerylimit, min = 1, max = 100Yesinteger
offsetqueryoffset, min = 0, max = 5000Yesinteger

Responses

CodeDescriptionSchema
200OKRedsVO
401Unauthorized
403Forbidden
404Not Found

/v1/staking/chains/{chain-id}/delegators/{delegator}/rewards


GET

Summary: getDelRewards

Parameters

NameLocated inDescriptionRequiredSchema
chain-idpathchain-idYesstring
delegatorpathdelegatorYesstring
endTimequeryendTimeNolong
limitquerylimit, min = 1, max = 100Yesinteger
offsetqueryoffset, min = 0, max = 5000Yesinteger
startTimequerystartTimeNolong

Responses

CodeDescriptionSchema
200OKRewardsDetailVO
401Unauthorized
403Forbidden
404Not Found

/v1/staking/chains/{chain-id}/delegators/{delegator}/ubds


GET

Summary: getDelUBDs

Parameters

NameLocated inDescriptionRequiredSchema
chain-idpathchain-idYesstring
delegatorpathdelegatorYesstring
isCompletedqueryisCompletedNointeger
limitquerylimit, min = 1, max = 100Yesinteger
offsetqueryoffset, min = 0, max = 5000Yesinteger
validatorqueryvalidatorNostring

Responses

CodeDescriptionSchema
200OKUbdsVO
401Unauthorized
403Forbidden
404Not Found

/v1/staking/chains/{chain-id}/next-reward-time


GET

Summary: getNextRewardTime

Parameters

NameLocated inDescriptionRequiredSchema
chain-idpathchain-idYesstring

Responses

CodeDescriptionSchema
200OKobject
401Unauthorized
403Forbidden
404Not Found

/v1/staking/chains/{chain-id}/summary


GET

Summary: getSum

Parameters

NameLocated inDescriptionRequiredSchema
chain-idpathchain-idYesstring

Responses

CodeDescriptionSchema
200OKStakingSumVO
401Unauthorized
403Forbidden
404Not Found

/v1/staking/chains/{chain-id}/validators


GET

Summary: getValidators

Parameters

NameLocated inDescriptionRequiredSchema
chain-idpathchain-idYesstring
consensus-addressqueryconsensus-addressNostring
limitquerylimit, min = 1, max = 100Yesinteger
offsetqueryoffset, min = 0, max = 5000Yesinteger

Responses

CodeDescriptionSchema
200OKValidatorsVO
401Unauthorized
403Forbidden
404Not Found

/v1/staking/chains/{chain-id}/validators/{validator}


GET

Summary: getValidator

Parameters

NameLocated inDescriptionRequiredSchema
chain-idpathchain-idYesstring
validatorpathvalidatorYesstring

Responses

CodeDescriptionSchema
200OKValidatorDetailVO
401Unauthorized
403Forbidden
404Not Found

/v1/staking/chains/{chain-id}/validators/{validator}/delegations


GET

Summary: getDelegationsByValidator

Parameters

NameLocated inDescriptionRequiredSchema
chain-idpathchain-idYesstring
limitquerylimit, min = 1, max = 100Yesinteger
offsetqueryoffset, min = 0, max = 5000Yesinteger
validatorpathvalidatorYesstring

Responses

CodeDescriptionSchema
200OKDelegationsVO
401Unauthorized
403Forbidden
404Not Found

/v1/staking/chains/{chain-id}/validators/{validator}/operations


GET

Summary: getOperationsByValidator

Parameters

NameLocated inDescriptionRequiredSchema
chain-idpathchain-idYesstring
limitquerylimit, min = 1, max = 100Yesinteger
offsetqueryoffset, min = 0, max = 5000Yesinteger
validatorpathvalidatorYesstring

Responses

CodeDescriptionSchema
200OKOperationsVO
401Unauthorized
403Forbidden
404Not Found

/v1/staking/chains/{chain-id}/validators/{validator}/powers


GET

Summary: getVotingPower

Parameters

NameLocated inDescriptionRequiredSchema
chain-idpathchain-idYesstring
endTimequeryendTimeYeslong
startTimequerystartTimeYeslong
validatorpathvalidatorYesstring

Responses

CodeDescriptionSchema
200OK[ VotingPowerVO ]
401Unauthorized
403Forbidden
404Not Found

/v1/staking/chains/{chain-id}/validators/{validator}/rewards


GET

Summary: getValRewards

Parameters

NameLocated inDescriptionRequiredSchema
chain-idpathchain-idYesstring
endTimequeryendTimeYeslong
startTimequerystartTimeYeslong
validatorpathvalidatorYesstring

Responses

CodeDescriptionSchema
200OK[ RewardVO ]
401Unauthorized
403Forbidden
404Not Found

Models


AllowedDstValidatorsVO

NameTypeDescriptionExample
earliestCompleteTimedateTime
totallong
validators[ ValidatorVO ]

BalanceVo

NameTypeDescriptionExample
assetstring
delegatednumber
unbondingnumber

DelegationVO

NameTypeDescriptionExample
amountnumber
delegatorstring
initialTimedateTime
validatorstring

DelegationValVO

NameTypeDescriptionExample
amountnumber
delegatorstring
initialTimedateTime
validatorstring
validatorNamestring
validatorStatusinteger0: active 1: inactive 2: inJail

DelegationValsVO

NameTypeDescriptionExample
delegations[ DelegationValVO ]
totallong

DelegationsVO

NameTypeDescriptionExample
delegations[ DelegationVO ]
totallong
NameTypeDescriptionExample
hrefstring
templatedboolean
NameTypeDescriptionExample
Map«string,Link»object

ModelAndView

NameTypeDescriptionExample
emptyboolean
modelobject
modelMapobject
referenceboolean
statusstring
viewView
viewNamestring

OperationVO

NameTypeDescriptionExample
amountnumber
delegatorstring
operationTypeinteger0: delegate; 1: undelegate; 2: redelegate
srcValidatorstring
timedateTime
txHashstring
valNamestring
validatorstring

OperationsVO

NameTypeDescriptionExample
operations[ OperationVO ]
totallong

RedVO

NameTypeDescriptionExample
balancenumber
completeHeightlong
completeTimedateTime
creationHeightlong
delegatorstring
denomstring
dstShareslong
dstValidatorstring
initialBalancenumber
srcShareslong
srcValidatorstring

RedsVO

NameTypeDescriptionExample
redelegations[ RedVO ]
totallong

RewardDetailVO

NameTypeDescriptionExample
chainIdstring
delegatorstring
heightlong
rewardnumber
rewardTimedateTime
valNamestring
validatorstring

RewardVO

NameTypeDescriptionExample
chainIdstring
commissionnumber
heightlong
rewardTimedateTime
selfDelegatorstring
totalRewardnumber
valTokensnumber
validatorstring

RewardWithDistributionAddrVO

NameTypeDescriptionExample
chainIdstring
commissionnumber
distributionAddrstring
heightlong
rewardTimedateTime
selfDelegatorstring
totalRewardnumber
valTokensnumber
validatorstring

RewardsDetailVO

NameTypeDescriptionExample
rewardDetails[ RewardDetailVO ]
totallong

RewardsWithDistributionAddrVO

NameTypeDescriptionExample
rewards[ RewardWithDistributionAddrVO ]
totallong

StakingSumVO

NameTypeDescriptionExample
rewardnumber
votingPowernumber

UbdVO

NameTypeDescriptionExample
balancenumber
completeHeightlong
completeTimedateTime
creationHeightlong
delegatorstring
denomstring
initialBalancenumber
validatorstring

UbdsVO

NameTypeDescriptionExample
totallong
unbondingDelegations[ UbdVO ]

ValidatorDetailVO

NameTypeDescriptionExample
aprnumber
commissionMaxChangeRatenumber
commissionMaxRatenumber
commissionRatenumber
detailstring
distributionAddrstring
identitystring
selfDelegatorstring
selfStakenumber
sideConsAddrstring
sideFeeAddrstring
statusinteger
valNamestring
validatorstring
votingPowernumber
votingPowerProportionnumber
websitestring

ValidatorVO

NameTypeDescriptionExample
aprnumber
commissionRatenumber
statusinteger
valNamestring
validatorstring
votingPowernumber
votingPowerProportionnumber

ValidatorsVO

NameTypeDescriptionExample
totallong
validators[ ValidatorVO ]

View

NameTypeDescriptionExample
contentTypestring

VotingPowerVO

NameTypeDescriptionExample
snapshotTimedateTime
votingPowernumber