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

Query parameters

tokenAddressstring

required

distributionChainIdnumber | string

required

campaignIdstring

opportunityIdstring

protocolIdstring[]

pagenumber | stringdefault: 0

itemsnumber | stringdefault: 20

Responses

200

Response for status 200

Schema

object

breakdownsobject[]

required

distributionChainIdnumber | string

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
}

get

https://api.merkl.xyz/v4/leaves/{recipient}/breakdowns

Merkl API

curl -X GET "https://api.merkl.xyz/v4/leaves/{recipient}/breakdowns"

Fill the required path parameter recipient to send.