Users

Changed on

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.

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

Request

  • Base URL: https://api.merkl.xyz (the document declares no server; this is the origin it was published from)
  • URL: https://api.merkl.xyz/v4/users/{address}/rewards/summary
  • Auth: apiKey (a scheme the document does not define)

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

string numeric
OR
number

Chain ID to bypass cache and check for recent claims

Response

Response for status 200

amountUSDstring required

Sum of reward amounts on this chain in USD (live tree — includes claimed). Point tokens are excluded from this total; read rewards for point balances.

claimedUSDstring required

Sum of claimed amounts on this chain in USD. Point tokens are excluded.

pendingUSDstring required

Sum of pending amounts on this chain in USD (not yet in any merkle root). Point tokens are excluded.

Changes

  • b7784c9a78b9Revision changes
    • info

      the //// response's property pattern was changed from ^(0x[a-fA-F0-9]{40}|[1-9A-HJ-NP-Za-km-z]{32,44}|[CG][A-Z0-9]{55})$ to ^(0x[a-fA-F0-9]{40}|[1-9A-HJ-NP-Za-km-z]{32,44}|[CG][A-Z0-9]{55}|0x[a-fA-F0-9]{64})$ for the status