Claim unlocked block rewards
/wallet/rewards/claimapi_keySweep every unlocked reward box to this wallet's primary address (EIP-3 index 0), batching boxes into as few transactions as possible. Dust is consolidated, never dropped.
A sweep that broadcasts nothing returns an error status rather than an empty 200, so a result with no claims is never ambiguous.
Responses
200The sweep transactions that were sentWalletRewardClaimResult▶
▶
claimsWalletRewardClaimedChunk[]requiredoutcomestringrequiredNode submission outcome for the known transaction ID.
one ofacceptedrejecteduncertaintxIdstringrequiredboxesinteger · int32requiredReward boxes this transaction swept
nanoErgsstringrequiredERG paid to the primary address by this transaction. Decimal string.
claimedNanoErgsstringrequiredTotal ERG across every claim transaction. Decimal string.
400No unlocked reward boxes to claim, or another claim is already sweeping them. ApiError▶
errorintegerrequiredError code
reasonstringrequiredError message explaining the reason of the error
detailstringrequirednullableDetailed error description
403Missing or wrong api_keyApiError▶
errorintegerrequiredError code
reasonstringrequiredError message explaining the reason of the error
detailstringrequirednullableDetailed error description
422The sweep started and could not finish. `detail` carries the reason it stopped; batches broadcast before that point have still been sent. ApiError▶
errorintegerrequiredError code
reasonstringrequiredError message explaining the reason of the error
detailstringrequirednullableDetailed error description
503Node or wallet unavailable. Nothing was decided; retry.ApiError▶
errorintegerrequiredError code
reasonstringrequiredError message explaining the reason of the error
detailstringrequirednullableDetailed error description
defaultErrorApiError▶
errorintegerrequiredError code
reasonstringrequiredError message explaining the reason of the error
detailstringrequirednullableDetailed error description