Claim unlocked block rewards

post/collateral/rewards/claimapi_key

Sweep 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 sentCollateralRewardClaimResult▶

▶
claimsCollateralRewardClaimedChunk[]required
- outcomestringrequired
  Node submission outcome for the known transaction ID.
  one ofacceptedrejecteduncertain
- txIdstringrequired
- boxesinteger · int32required
  Reward boxes this transaction swept
- nanoErgsstringrequired
  ERG paid to the primary address by this transaction. Decimal string.
claimedNanoErgsstringrequired
Total ERG across every claim transaction. Decimal string.

400No unlocked reward boxes to claim, or another claim is already sweeping them. ApiError▶

errorintegerrequired
Error code
reasonstringrequired
Error message explaining the reason of the error
detailstringrequirednullable
Detailed 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▶

errorintegerrequired
Error code
reasonstringrequired
Error message explaining the reason of the error
detailstringrequirednullable
Detailed error description

503Node or wallet unavailable. Nothing was decided; retry.ApiError▶

errorintegerrequired
Error code
reasonstringrequired
Error message explaining the reason of the error
detailstringrequirednullable
Detailed error description

defaultErrorApiError▶

errorintegerrequired
Error code
reasonstringrequired
Error message explaining the reason of the error
detailstringrequirednullable
Detailed error description

← PreviousYour locked block rewards Next →Quote joining the queue