get

/v4/campaigns/aggregate

Aggregate all campaigns matching the provided filters and return a per-token breakdown of total amounts and USD values. Useful for analyzing program-level reward distribution (e.g. all rewards on a chain, all UNI rewards, or all campaigns by a creator).

Query parameters

pagenumber | stringdefault: 0
itemsnumber | stringdefault: 20
idstring
creatorTagstring
creatorAddressstring
creatorAddressesstring[]
creatorIdstring
chainIdnumber | string
searchstring
distributionChainIdsnumber | string[]
typestring
typesstring[]
subTypenumber
campaignIdstring
campaignIdsstring[]
mainParameterstring
tokenSymbolstring
tokenAddressstring
testbooleandefault: false
tokenTypesenum[]
TOKENPRETGEPOINT
pointboolean
opportunityIdstring
opportunityIdsstring[]
statusstring
startTimestampstring
endTimestampstring
withOpportunityboolean
distributionTypesenum[]
FIX_REWARDMAX_REWARDDUTCH_AUCTION
createdAfterDate | string (date-time) | string (date) | number | null
createdBeforeDate | string (date-time) | string (date) | number | null
excludeSubCampaignsbooleandefault: false
onlySubCampaignsbooleandefault: false
rootCampaignIdstring
parentCampaignIdstring
mainProtocolIdstring
pauseComputestring
showPrivateboolean
listOwnerstring
campaignListsstring

Responses

200
Response for status 200
Schema
object
totalCampaignsnumber
required
Total number of campaigns matching filters
totalUsdnumber
required
Total USD value of all priced token rewards
periodobject
required
startstring | null
required
ISO date of earliest campaign start, null if none
endstring | null
required
ISO date of latest campaign end, null if none
uniqueCreatorsnumber
required
Number of distinct campaign creators
uniqueOpportunitiesnumber
required
Number of distinct opportunities targeted
tokensobject[]
required
Priced token breakdowns sorted by USD desc
tokenIdstringUnique token identifier (chain+address)
symbolstringReward token symbol (not unique across chains)
totalAmountnumberTotal raw token amount (amount / 10^decimals)
currentPricenumberCurrent token price in USD
totalUsdnumberTotal USD value at current price
campaignCountnumberNumber of campaigns distributing this token
campaignIdsstring[]IDs of campaigns distributing this token
pointsTokensobject[]
required
Point and preTGE token breakdowns
tokenIdstringUnique token identifier (chain+address)
symbolstringPoints token symbol (not unique across chains)
totalAmountnumberTotal raw token amount
campaignCountnumberNumber of campaigns distributing this token
campaignIdsstring[]IDs of campaigns distributing this token
Example
{
  "totalCampaigns": 0,
  "totalUsd": 0,
  "period": {
    "start": "string",
    "end": "string"
  },
  "uniqueCreators": 0,
  "uniqueOpportunities": 0,
  "tokens": [
    {
      "tokenId": "string",
      "symbol": "string",
      "totalAmount": 0,
      "currentPrice": 0,
      "totalUsd": 0,
      "campaignCount": 0,
      "campaignIds": [
        "string"
      ]
    }
  ],
  "pointsTokens": [
    {
      "tokenId": "string",
      "symbol": "string",
      "totalAmount": 0,
      "campaignCount": 0,
      "campaignIds": [
        "string"
      ]
    }
  ]
}
get
https://api.merkl.xyz/v4/campaigns/aggregate
Merkl API
curl -X GET "https://api.merkl.xyz/v4/campaigns/aggregate"