Merkl Developer Portal logo
get

/v4/leaves/{recipient}/breakdowns

Returns paginated leaf breakdowns for a recipient, token, and chain, including both distributed and pending amounts. Supports filters on campaignId, opportunityId, and protocolId.

Path parameters

recipientstring
required

Recipient wallet address

Query parameters

tokenAddressstring
required

Reward token address

distributionChainIdstring (integer) | integer
required

Distribution chain ID

campaignIdstring

Filter by campaign ID (exact match)

opportunityIdstring

Filter by opportunity ID (exact match)

protocolIdstring[]
pagestring (integer) | integerdefault: 0

0-indexed page number

itemsstring (integer) | integerdefault: 20

Number of items returned by page

Responses

200
Response for status 200
Schema
object
breakdownsobject[]
required
distributionChainIdstring (integer) | integerChain ID
tokenAddressstring
campaignIdstringHashed campaign ID
reasonstring
amountstring
claimedstring
pendingstring
CampaignanyFull Campaign object with Opportunity include
countnumber | string
required
Example
{
  "breakdowns": [
    {
      "distributionChainId": 0,
      "tokenAddress": "string",
      "campaignId": "string",
      "reason": "string",
      "amount": "string",
      "claimed": "string",
      "pending": "string",
      "Campaign": null
    }
  ],
  "count": 0
}