get

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

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

Path parameters

addressstring
required
chainIdnumber | string
required

Query parameters

tokensstring[]
protocolsstring[]
tagsstring[]
isTestboolean
isPreTGEboolean

Responses

200
Response for status 200
Schema
object
chainobject
required
Chain
idinteger
required
Chain Id
namestring
required
Legible name of the chain
iconstring
required
URL to the icon of the chain
liveCampaignsnumber
required
Number of campaigns currently live on this chain
endOfDisputePeriodnumber
required
explorersobject[]
typeenumETHERSCANBLOCKSCOUTSOLSCAN
urlstring
chainIdnumber
lastClaimsOnchainFetchTimestampstring | null
required
Timestamp of the last claims onchain fetch
opportunitiesobject[]
required
opportunityobject
idstring
typestring
identifierstring
chainIdnumber
namestring
descriptionstring
howToStepsstring[]
statusenumNONEPASTLIVESOON
actionenumPOOLHOLDDROPLENDBORROWLONGSHORTSWAPINVALIDSTAKE
tagsstring[]
mainProtocolstring
depositUrlstring
depositUrlsobject[]
idstring
titlestring
urlstring
subtitlestring
iconstring
prioritynumber
explorerAddressstring
hiddenboolean
tvlnumber
aprnumber
dailyRewardsnumber
maxDailyRewardsnumber | null
liveCampaignsnumber
lastCampaignCreatedAtnumber
earliestCampaignStartbigint | string
latestCampaignStartbigint | string
earliestCampaignEndbigint | string
latestCampaignEndbigint | string
nativeAprnumber
totalAprnumber
maxAprnumber | null
liveCampaignsForCreatornumber
soonCampaignsForCreatornumber
pastCampaignsForCreatornumber
distributionTypestring
tokensobject[]
idstringUnique identifier for the token
namestring | nullFull name of the token
chainIdintegerChain Id
addressstringAddress
decimalsnumberNumber of decimals for the token
symbolstringSymbol of the token
iconstringURL to the token icon image
verifiedbooleanWhether the token is verified
isNativebooleanWhether this is a native blockchain token
isTestbooleanWhether this is a test token
typeenumType of the token (TOKEN, PRETGE, POINT)TOKENPRETGEPOINT
pricenumber | nullCurrent price of the token in USD
updatedAtnumber | nullUnix timestamp of last price update
priceSourcestring | nullSource of the price information
displaySymbolstringCustom display symbol override
underlyingTokenIdstringIf this token is a wrapper, the ID of the underlying token
priceAlertDismissedAtnumber
priceAlertCountnumber
chainobjectChain
idinteger
required
Chain Id
namestring
required
Legible name of the chain
iconstring
required
URL to the icon of the chain
liveCampaignsnumber
required
Number of campaigns currently live on this chain
endOfDisputePeriodnumber
required
explorersobject[]
typeenumETHERSCANBLOCKSCOUTSOLSCAN
urlstring
chainIdnumber
lastClaimsOnchainFetchTimestampstring | null
required
Timestamp of the last claims onchain fetch
activeProgramsobject[]
idstring
namestring
slugstring | null
descriptionstring
iconstring
protocolobject | null
idstring
namestring
iconstring
tagsstring[]
descriptionstring
urlstring
dailyRewardsnumber
numberOfLiveCampaignsnumber
opportunityLiveTagsstring[]
bannerstring | null
opportunityBannerLightstring | null
opportunityBannerDarkstring | null
trustDataobject | null
slugstring
categorystring | null
auditsstring | null
audit_linksstring[]
audit_notestring | null
githubstring[]
twitterstring | null
listedAtnumber | null
parentProtocolstring | null
tvlnumber | null
hacksobject[]
datenumber
namestring | null
amountUSDnumber | null
techniquestring | null
sourcestring | null
syncedAtnumber
aprRecordobject
cumulatednumber
required
timestampbigint | string
required
breakdownsobject[]
required
identifierstring
typeenumCAMPAIGNTOKENPROTOCOL
valuenumber
timestampbigint | string
distributionTypeenumDUTCH_AUCTIONFIX_REWARD_VALUE_PER_LIQUIDITY_VALUEFIX_REWARD_AMOUNT_PER_LIQUIDITY_VALUEFIX_REWARD_VALUE_PER_LIQUIDITY_AMOUNTFIX_REWARD_AMOUNT_PER_LIQUIDITY_AMOUNTMAX_REWARD_VALUE_PER_LIQUIDITY_VALUEMAX_REWARD_AMOUNT_PER_LIQUIDITY_VALUEMAX_REWARD_VALUE_PER_LIQUIDITY_AMOUNTMAX_REWARD_AMOUNT_PER_LIQUIDITY_AMOUNTAAVE_NET_APRERC4626_APRERC4626_SPREAD_CAPPEDAAVE_V4_NET_APRDEEL_DISTRIBUTIONSOFR_SPREAD_RATCHETERC4626_TARGET_APR_WITH_MERKLTARGET_APR_WITH_MERKLNET_APRBORROW_SUBSIDYNET_APR_WITH_MERKLYIELD_BASIS_PID
nativeAprRecordobject
titlestring
required
descriptionstring
valuenumber
required
timestampbigint | string
required
amountbigint
rewardTokenobjectToken
idstring
required
Unique identifier for the token
namestring | null
required
Full name of the token
chainIdinteger
required
Chain Id
addressstring
required
Address
decimalsnumber
required
Number of decimals for the token
symbolstring
required
Symbol of the token
iconstring
required
URL to the token icon image
verifiedboolean
required
Whether the token is verified
isNativeboolean
required
Whether this is a native blockchain token
isTestboolean
required
Whether this is a test token
typeenum
required
Type of the token (TOKEN, PRETGE, POINT)TOKENPRETGEPOINT
pricenumber | nullCurrent price of the token in USD
updatedAtnumber | nullUnix timestamp of last price update
priceSourcestring | nullSource of the price information
displaySymbolstringCustom display symbol override
underlyingTokenIdstringIf this token is a wrapper, the ID of the underlying token
priceAlertDismissedAtnumber
priceAlertCountnumber
tvlRecordobject
totalnumber
required
timestampbigint | string
required
breakdownsobject[]
required
identifierstring
typeenumTOKENPROTOCOL
valuenumber
rewardsRecordobject
totalnumber
required
timestampbigint | string
required
breakdownsobject[]
required
campaignIdstring
valuenumber
maxValuenumber
timestampbigint | string
tokenobjectToken
idstring
required
Unique identifier for the token
namestring | null
required
Full name of the token
chainIdinteger
required
Chain Id
addressstring
required
Address
decimalsnumber
required
Number of decimals for the token
symbolstring
required
Symbol of the token
iconstring
required
URL to the token icon image
verifiedboolean
required
Whether the token is verified
isNativeboolean
required
Whether this is a native blockchain token
isTestboolean
required
Whether this is a test token
typeenum
required
Type of the token (TOKEN, PRETGE, POINT)TOKENPRETGEPOINT
pricenumber | nullCurrent price of the token in USD
updatedAtnumber | nullUnix timestamp of last price update
priceSourcestring | nullSource of the price information
displaySymbolstringCustom display symbol override
underlyingTokenIdstringIf this token is a wrapper, the ID of the underlying token
priceAlertDismissedAtnumber
priceAlertCountnumber
amountbigint | string
distributionTypeenumDUTCH_AUCTIONFIX_REWARD_VALUE_PER_LIQUIDITY_VALUEFIX_REWARD_AMOUNT_PER_LIQUIDITY_VALUEFIX_REWARD_VALUE_PER_LIQUIDITY_AMOUNTFIX_REWARD_AMOUNT_PER_LIQUIDITY_AMOUNTMAX_REWARD_VALUE_PER_LIQUIDITY_VALUEMAX_REWARD_AMOUNT_PER_LIQUIDITY_VALUEMAX_REWARD_VALUE_PER_LIQUIDITY_AMOUNTMAX_REWARD_AMOUNT_PER_LIQUIDITY_AMOUNTAAVE_NET_APRERC4626_APRERC4626_SPREAD_CAPPEDAAVE_V4_NET_APRDEEL_DISTRIBUTIONSOFR_SPREAD_RATCHETERC4626_TARGET_APR_WITH_MERKLTARGET_APR_WITH_MERKLNET_APRBORROW_SUBSIDYNET_APR_WITH_MERKLYIELD_BASIS_PID
onChainCampaignIdstring
tokensobject[]
tokenobjectToken
idstring
required
Unique identifier for the token
namestring | null
required
Full name of the token
chainIdinteger
required
Chain Id
addressstring
required
Address
decimalsnumber
required
Number of decimals for the token
symbolstring
required
Symbol of the token
iconstring
required
URL to the token icon image
verifiedboolean
required
Whether the token is verified
isNativeboolean
required
Whether this is a native blockchain token
isTestboolean
required
Whether this is a test token
typeenum
required
Type of the token (TOKEN, PRETGE, POINT)TOKENPRETGEPOINT
pricenumber | nullCurrent price of the token in USD
updatedAtnumber | nullUnix timestamp of last price update
priceSourcestring | nullSource of the price information
displaySymbolstringCustom display symbol override
underlyingTokenIdstringIf this token is a wrapper, the ID of the underlying token
priceAlertDismissedAtnumber
priceAlertCountnumber
claimedstringAlready-claimed amount in token wei
pendingstringPending amount (not yet in merkle root) in token wei
claimablestringClaimable now in token wei (live tree amount minus claimed) — computed server-side
Example
{
  "chain": {
    "id": 0,
    "name": "string",
    "icon": "string",
    "liveCampaigns": 0,
    "endOfDisputePeriod": 0,
    "explorers": [
      {
        "type": "ETHERSCAN",
        "url": "string",
        "chainId": 0
      }
    ],
    "lastClaimsOnchainFetchTimestamp": "string"
  },
  "opportunities": [
    {
      "opportunity": {},
      "tokens": [
        {
          "token": {
            "id": null,
            "name": null,
            "chainId": null,
            "address": null,
            "decimals": null,
            "symbol": null,
            "icon": null,
            "verified": null,
            "isNative": null,
            "isTest": null,
            "type": null,
            "price": null,
            "updatedAt": null,
            "priceSource": null,
            "displaySymbol": null,
            "underlyingTokenId": null,
            "priceAlertDismissedAt": null,
            "priceAlertCount": null
          },
          "claimed": "string",
          "pending": "string",
          "claimable": "string"
        }
      ]
    }
  ]
}
get
https://api.merkl.xyz/v4/users/{address}/rewards/chains/{chainId}/breakdowns
Merkl API
curl -X GET "https://api.merkl.xyz/v4/users/{address}/rewards/chains/{chainId}/breakdowns"
Fill the required path parameters address, chainId to send.