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

builderState

Accrual, payout history, and eligibility for one builder — the address that collects a builder code fee on the orders it submits. user is the builder's own address, not the trader's.

POST/infotype builderState

Read a builder’s on-chain claimable balance and fee eligibility before claimBuilderRewards.

Request body
typestringrequired
userstringrequired

Builder address to read state for.

Request example
curl -X POST https://rpc.txflow-testnet.xyz/info \
  -H "Content-Type: application/json" \
  -H "x-api-version: 2026-08-16" \
  -d '{
  "type": "builderState",
  "user": "0x4916d34209A2E010912dE8b412A90ECcEc77D8aC"
}'
Try it
POST https://rpc.txflow-testnet.xyz/info
Response · BuilderStateResponse 200
codeinteger

`0` on success.

dataBuilderStateResponse
accruedRewardsstring

Builder fees accrued to this address over its lifetime, in USDC.

activeUserCountinteger · int64

Number of users currently approving this builder.

claimableRewardsstring

Currently unclaimed balance, in USDC. This is what `claimBuilderRewards` pays out.

claimedRewardsstring

Total already claimed, in USDC.

eligibleboolean

Whether the address currently qualifies to accrue builder fees.

isStandardAccountboolean

Whether the address is a standard account. LP and vault addresses are never eligible.

perpsAccountValuestring

The address's available perp-account balance, in USDC. Builder fees accrue only while this is at least 100.

successboolean

`false` on error, with `code` set and the text in `message` instead of `data`.

Response example
{
  "success": true,
  "code": 0,
  "data": {
    "accruedRewards": "0.000000",
    "claimableRewards": "0.000000",
    "claimedRewards": "0.000000",
    "eligible": true,
    "perpsAccountValue": "200.012971",
    "isStandardAccount": true,
    "activeUserCount": 0
  }
}

Balances

The three USDC figures are the same balances claimBuilderRewards acts on:

FieldMeaning
accruedRewardsLifetime total accrued to this builder. A claim does not change it.
claimableRewardsCurrently unclaimed. This is what a claim pays out; claiming with 0 here fails with No unclaimed builder rewards.
claimedRewardsTotal already claimed. A claim moves claimableRewards into this.

Eligibility

Builder fees accrue only while the address qualifies. eligible is the answer; the two fields beside it are the inputs:

FieldMeaning
eligibleWhether the address currently qualifies to accrue builder fees.
perpsAccountValueThe builder's available perp-account balance in USDC — fees accrue only while this is at least 100.
isStandardAccountWhether the address is a standard account. LP and vault addresses are never eligible.

activeUserCount is the number of users currently approving this builder.