Sign in
Users

Get the rewards associated to a user on a given chain.

Request Examples

Fetch rewards for a user wallet on a specific chain
curl "https://api.merkl.xyz/v4/users/0x742d35Cc6634C0532925a3b844Bc9e7595f0bEb/rewards?chainId=1"

Use the returned proofs to build a claim transaction integrating-user-reward

Retrieve user rewards aggregated by chain. Use query parameters to filter by chain IDs, reward type, and claimability.

get/v4/users/{address}/rewards

Path parameters

addressstring required

User address

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, API key owner, or BackOffice) to match the queried address — otherwise returns 403. Also bypasses CDN cache.

Response

Response for status 200

Changes

No recorded changes to this endpoint across all 2 revisions of this API.