Are you an LLM? Read llms.txt for a summary of the docs, or llms-full.txt for the full context.
Skip to content

claimBuilderRewards

Claims the acting builder's full unclaimedRewards balance. The action fails with No unclaimed builder rewards when the claimable balance is zero.

POST/exchangetype claimBuilderRewards

Claim a builder’s full unclaimed reward balance.Agent-signed

Not this?
Action fields
typestringrequired

Must be `claimBuilderRewards`; there are no additional action fields.

"claimBuilderRewards"
Request example
curl -X POST https://rpc.txflow-testnet.xyz/exchange \
  -H "Content-Type: application/json" \
  -H "x-api-version: 2026-08-16" \
  -d '{
  "action": {
    "type": "claimBuilderRewards"
  },
  "signature": {
    "r": "0x<r>",
    "s": "0x<s>",
    "v": 27
  },
  "nonce": 1757992743994,
  "vaultAddress": null,
  "signatureChainId": null
}'
Try it
testnet · no account yet
Generates a throwaway key in your browser, claims testnet USDC and authorizes an agent key. The account is kept while you browse the docs and lost on reload.
Response · ClaimBuilderRewards 200
codeinteger

`0` on success.

dataobject
dataobject
typestring

The action's internal name, which does not always match the request `type`.

"ClaimBuilderRewards"
statusstring

A rejected request returns `err` with a non-zero `code` and the reason in `message` (or `response`).

"ok"
Response example
{
  "status": "ok",
  "code": 0,
  "data": {
    "type": "ClaimBuilderRewards",
    "data": {
      "statuses": [
        "success"
      ]
    }
  }
}

Signing

This is an agent-signed action. Unlike older field-less actions, its MessagePack preimage is the whole tagged action:

{ "type": "claimBuilderRewards" }

Serialize that map with named fields, then append the outer nonce as eight big-endian bytes and the vault flag/address before computing the action hash. Omitting type produces the wrong signing hash.

An authorized agent may submit the claim for its owner. When vaultAddress is present, normal vault-agent authorization rules apply. See Builder-fee actions.

Next steps

A claim moves the full claimable balance into totalClaimed; totalEarned is unchanged. Read those balances — and whether the address is eligible to accrue at all — with builderState.