Users

Changed on

Rewards an address earned on one chain since 00:00 UTC 30 days ago, per token and campaign, optionally for one reward token. Rows of private or hidden-leaderboard campaigns appear only to a caller allowed to read them. When the route cannot answer for the chain yet, it is listed in unavailableChainIds. Requires an API key.

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

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

Path parameters

addressstring required

User address

string integer required
OR
integer required

Chain ID

Query parameters

isTestboolean

Include test tokens

tokenstring

Reward token address. Omit it to get every token.

Response

Response for status 200

addressstring required
windowSecondsnumber required

Seconds since 00:00 UTC, 30 days ago: between 30 and 31 days

totalUSDnumber required
unavailableChainIdsnumber[] required

The chain, when the route cannot answer for it: no live root, not backfilled yet, or no API row

Changes

  • 7bcc71910715Revision changes
    • info

      added the new optional query request parameter token

  • 4207c9b739f0Revision changes
    • breaking

      path request parameter chainId list-of-types was narrowed by removing types number

    • warning

      for the path request parameter chainId, the max was set to 2147483647.00

    • warning

      for the path request parameter chainId, the min was set to 1.00