Leaves

Changed on

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

get/v4/leaves/{recipient}/breakdowns

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

Path parameters

recipientstring required

Recipient wallet address

Query parameters

tokenAddressstring required

Reward token address

string numeric required
OR
number required

Distribution chain ID

campaignIdstring

Filter by campaign ID (exact match)

opportunityIdstring

Filter by opportunity ID (exact match)

protocolIdstring[]
string integer
OR
integer

0-indexed page number

string integer
OR
integer

Number of items returned by page

Response

Response for status 200

Changes

  • 545c27b01dd9Revision changes
    • breaking

      query request parameter items list-of-types was narrowed by removing types number

    • breaking

      query request parameter page list-of-types was narrowed by removing types number

    • warning

      for the query request parameter page, the max was set to 1000000.00