Users

Changed on

Retrieve claimable rewards for a user scoped to a single protocol. Breakdowns and amounts reflect only campaigns attributed to the requested protocol. The returned proofs and root still claim the full per-token leaf on-chain.

get/v4/users/{address}/protocols/{protocolId}/rewards

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

Path parameters

addressstring required

User wallet address

protocolIdstring required

Main protocol ID to filter rewards by

Query parameters

chainIdstring[] required

List of chain IDs to query rewards for

string numeric
OR
number

An optional chainId to bypass the cache and check if there was very recently a claim on this chain

testboolean

Include test token rewards

claimableOnlyboolean

Include only claimable rewards (to avoid transferring zero amounts)

string numeric
OR
number

0-indexed pagination for rewards[number].breakdowns. 1000 items per page.

string
OR
string
OR
string
showPrivateboolean

When true, decode private campaign IDs instead of returning the zero hash. Requires the caller's identity (JWT or API key owner) to match the queried address — otherwise returns 403. Also bypasses CDN cache.

Response

Response for status 200

Changes

  • 0777cabf732aRevision changes
    • info

      added the optional property //// to the response with the status