Merkl Developer Portal logo
get

/v4/users/{address}/rewards/summary

Per-chain rewards rollup with USD totals and per-token raw amounts. A lightweight alternative to /rewards that omits full campaign breakdowns. Supports optional filters: chainId, chains, tokens, protocols, isTest, isPreTGE.

Path parameters

addressstring
required

User address

Query parameters

chainIdstring[]

Filter by chain IDs

tokensstring[]

Filter by reward token addresses

protocolsstring[]

Filter by main protocol IDs

tagsstring[]

Filter by opportunity tags (whitelabel scoping)

isTestboolean

Include test token rewards

isPreTGEboolean

When true, restrict to preTGE (PRETGE) token rewards

reloadChainIdnumber | string

Chain ID to bypass cache and check for recent claims

Responses

200
Response for status 200
Schema
object[]
chainobjectChain
idinteger
required
Chain Id
namestring
required
Legible name of the chain
iconstring
required
URL to the icon of the chain
liveCampaignsnumber
required
Number of campaigns currently live on this chain
endOfDisputePeriodnumber
required
explorersobject[]
typeenumETHERSCANBLOCKSCOUTSOLSCAN
urlstring
chainIdnumber
lastClaimsOnchainFetchTimestampstring | null
required
Timestamp of the last claims onchain fetch
amountUSDstringSum of reward amounts on this chain in USD (live tree — includes claimed). Point tokens are excluded from this total; read `rewards` for point balances.
claimedUSDstringSum of claimed amounts on this chain in USD. Point tokens are excluded.
pendingUSDstringSum of pending amounts on this chain in USD (not yet in any merkle root). Point tokens are excluded.
rewardsobject[]
tokenobjectToken
idstring
required
Unique identifier for the token
namestring | null
required
Full name of the token
chainIdinteger
required
Chain Id
addressstring
required
Address
decimalsnumber
required
Number of decimals for the token
symbolstring
required
Symbol of the token
iconstring
required
URL to the token icon image
verifiedboolean
required
Whether the token is verified
isNativeboolean
required
Whether this is a native blockchain token
isTestboolean
required
Whether this is a test token
typeenum
required
Type of the token (TOKEN, PRETGE, POINT)TOKENPRETGEPOINT
pricenumber | nullCurrent price of the token in USD
updatedAtnumber | nullUnix timestamp of last price update
priceSourcestring | nullSource of the price information
displaySymbolstringCustom display symbol override
underlyingTokenIdstringIf this token is a wrapper, the ID of the underlying token
priceAlertDismissedAtnumber
priceAlertCountnumber
amountstringTotal reward amount in token wei (live tree)
claimedstringAmount already claimed in token wei
pendingstringAmount pending in token wei (not yet in merkle root)
proofsstring[]Merkle proofs required to claim this token reward onchain
Example
[
  {
    "chain": {
      "id": 0,
      "name": "string",
      "icon": "string",
      "liveCampaigns": 0,
      "endOfDisputePeriod": 0,
      "explorers": [
        {
          "type": null,
          "url": "string",
          "chainId": 0
        }
      ],
      "lastClaimsOnchainFetchTimestamp": "string"
    },
    "amountUSD": "string",
    "claimedUSD": "string",
    "pendingUSD": "string",
    "rewards": [
      {
        "token": {
          "id": "string",
          "name": null,
          "chainId": 0,
          "address": "string",
          "decimals": 0,
          "symbol": "string",
          "icon": "string",
          "verified": false,
          "isNative": false,
          "isTest": false,
          "type": null,
          "price": null,
          "updatedAt": null,
          "priceSource": null,
          "displaySymbol": "string",
          "underlyingTokenId": "string",
          "priceAlertDismissedAt": 0,
          "priceAlertCount": 0
        },
        "amount": "string",
        "claimed": "string",
        "pending": "string",
        "proofs": [
          "string"
        ]
      }
    ]
  }
]