Users

Lightweight USD totals for a user — total earned, currently claimable, and pending. Supports optional filters: chainId, chains, tokens, protocols, isTest, isPreTGE.

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

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/stats
  • 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

Response

Response for status 200

totalEarnedUSDstring required

All-time earned (claimed + claimable + pending) in USD

pendingUSDstring required

Earned but not yet claimable (not in any merkle root), in USD

claimableUSDstring required

Currently claimable (in live root, not yet claimed onchain), in USD

Changes

No recorded changes to this operation across all 36 revisions of this API.