Users

Changed on

Per-chain opportunity breakdown for a user. Aggregated by opportunity with one row per token carrying claimed, pending, and server-computed claimable amounts.

get/v4/users/{address}/rewards/chains/{chainId}/breakdowns

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/chains/{chainId}/breakdowns
  • Auth: apiKey (a scheme the document does not define)

Path parameters

addressstring required

User wallet address

string numeric required
OR
number required

Chain ID to fetch breakdown for

Query parameters

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

Changes

  • b7784c9a78b9Revision changes
    • info

      added subschema #1 subschema #2 to the // response property allOf list for the response status

    • info

      removed subschema #1 subschema #2 from the // response property allOf list for the response status

    • 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