Merkl Developer Portal logo
get

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

Rewards an address earned on one chain since 00:00 UTC 30 days ago, per token and campaign. 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.

Path parameters

addressstring
required

User wallet address

chainIdnumber | string
required

Chain ID to read

Query parameters

isTestboolean

Include test tokens

Responses

200
Response for status 200
Schema
object
addressstring
required
windowSecondsnumber
required
Seconds since 00:00 UTC, 30 days ago: between 30 and 31 days
totalUSDnumber
required
chainsobject[]
required
chainIdnumber
startRootstring | null
startTimestampnumber | null
endRootstringLive root the current amounts belong to
endTimestampnumber
tokensobject[]
addressstring
symbolstring
decimalsnumber
iconstring
pricenumber | null
amountstringAmount earned in the window, in token base units
amountUSDnumber
campaignsobject[]
campaignIdstring
amountstring
unavailableChainIdsnumber[]
required
The chain, when the route cannot answer for it: no live root, not backfilled yet, or no API row
Example
{
  "address": "string",
  "windowSeconds": 0,
  "totalUSD": 0,
  "chains": [
    {
      "chainId": 0,
      "startRoot": "string",
      "startTimestamp": 0,
      "endRoot": "string",
      "endTimestamp": 0,
      "tokens": [
        {
          "address": "string",
          "symbol": "string",
          "decimals": 0,
          "icon": "string",
          "price": null,
          "amount": "string",
          "amountUSD": 0,
          "campaigns": [
            null
          ]
        }
      ]
    }
  ],
  "unavailableChainIds": [
    0
  ]
}