- Create a claim rewards request.
- Sign and send the transaction to the network.
Claiming rewards is not the same as withdrawal.
/staking/withdraw returns unfrozen TRX after the unfreezing period, while /staking/claim-rewards collects voting rewards.1
Create claim rewards request
To claim the rewards, send a POST request to /api/v1/tron/{network}/staking/claim-rewards.Example request (for
testnet-nile network):delegatorAddress— delegator account address to claim accrued voting rewards for.
-
delegatorAddress— delegator account address that claims the rewards. -
rewardAmount— amount of accrued voting rewards to be claimed in SUN (1 TRX = 10⁶ SUN), as an integer string. Reflects the claimable rewards at transaction creation time. -
unsignedTransaction— original unsigned transaction object returned by tronWeb.-
visible— internal SDK parameter; always set tofalse. -
txID— hash of the transaction. -
raw_data_hex— raw payload of the unsigned transaction in the hexadecimal format. -
raw_data— full decoded transaction structure with all the fields and metadata:-
contract— list of TRON contracts:parameter.value.owner_address— TRON account address in the hexadecimal format.parameter.type_url— TRON protocol contract,type.googleapis.com/protocol.WithdrawBalanceContract.type— TRON protocol contract type.
-
ref_block_bytes,ref_block_hash— hash and references of the block in which the transaction has been included. -
expiration— timestamp of the transaction expiration in ms since last epoch. -
timestamp— timestamp of the transaction in ms since last epoch.
-
-
-
unsignedTransactionSerialized— unsigned serialized transaction in Base64 encrypted format ready for signing. -
createdAt— timestamp of the transaction in the ISO 8601 format.
2
Sign and send transaction
Use
unsignedTransactionSerialized to sign and send the signed transaction to the TRON network.After the transaction is confirmed, the claimed rewards are added to the account’s available balance. You can verify the claim by several options:- Get the delegator account summary via /api/v1/tron/{network}/account/{address}.
- Check the transaction status via /api/v1/tron/{network}/transaction/{transactionHash}/status endpoint.
- View your account on Tronscan: Mainnet or Nile testnet.
Error codes
/staking/claim-rewards can return the following 400 Bad request errors in addition to the standard 401 and 429 responses.