get

/v4/campaigns/

Search for campaigns matching the criteria provided through query parameters.

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[]
idstringUnique campaign id
computeChainIdnumberChain ID where campaign data is computed
distributionChainIdnumberChain ID where rewards are distributed
campaignIdstringA hash of the campaign, unique per chain. Can be used to identify campaigns across chains
typestringCampaign type identifier
subTypenumber | nullCampaign subtype for protocols like Silo, Radiant, Morpho, Dolomite, Compound, Ajna and Euler
amountstringAmount of reward token units being distributed by the campaign
startTimestampstring | number | string | bigintUnix timestamp when the campaign starts
endTimestampstring | number | string | bigintUnix timestamp when the campaign ends
creatorAddressstringEthereum address of the campaign creator
aprnumberAnnual Percentage Rate for this campaign
dailyRewardsnumberTotal daily rewards distributed in USD
creatorobjectCampaign creator information
addressstring
required
Creator's Ethereum address
tagsstring[]Tag associated with the creator
creatorIdstring | null
paramsanyCampaign-specific parameters
descriptionstringCampaign description
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
rewardTokenIdstringInternal ID of the reward token
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
opportunityIdstringID of the associated opportunity
distributionChainobjectChain
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
distributionTypeenumType of reward distribution mechanismDUTCH_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
campaignStatusobject
campaignIdstring
required
computedUntilstring | number | string
required
processingStartedstring | number | string
required
statusstring
required
preComputeProcessingStartedstring | number | string
required
preComputeStatusstring
required
delaynumber | string
errorstring
detailsany
createdAtstring (date)ISO date when the campaign was created
rootCampaignIdstring | nullID of the root campaign for hierarchical campaigns
parentCampaignIdstring | nullID of the parent campaign for sub-campaigns
childCampaignIdsstring[]List of child campaign IDs
dailyRewardsBreakdownobject[]Daily breakdown of rewards
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
pauseComputestring | nullISO timestamp when computation was paused
pausePrecomputestring | nullReason for pausing precomputation, or null if not paused
hasOverridesbooleanWhether this campaign has previous config overrides
isPrivatebooleanIndicates if the campaign is private
hiddenbooleanWhether the campaign is hidden from non-test API results
hideLeaderboardbooleanWhether leaderboard, ranks and reward breakdowns are hidden for this campaign
campaignEncodingHashstringHash of the campaign configuration encoding
Example
[
  {
    "id": "string",
    "computeChainId": 0,
    "distributionChainId": 0,
    "campaignId": "string",
    "type": "string",
    "subType": 0,
    "amount": "string",
    "startTimestamp": "string",
    "endTimestamp": "string",
    "creatorAddress": "string",
    "apr": 0,
    "dailyRewards": 0,
    "creator": {
      "address": "string",
      "tags": [
        "string"
      ],
      "creatorId": "string"
    },
    "params": null,
    "description": "string",
    "chain": {
      "id": 0,
      "name": "string",
      "icon": "string",
      "liveCampaigns": 0,
      "endOfDisputePeriod": 0,
      "explorers": [
        {
          "type": null,
          "url": null,
          "chainId": null
        }
      ],
      "lastClaimsOnchainFetchTimestamp": "string"
    },
    "rewardTokenId": "string",
    "rewardToken": {
      "id": "string",
      "name": "string",
      "chainId": 0,
      "address": "string",
      "decimals": 0,
      "symbol": "string",
      "icon": "string",
      "verified": false,
      "isNative": false,
      "isTest": false,
      "type": "TOKEN",
      "price": 0,
      "updatedAt": 0,
      "priceSource": "string",
      "displaySymbol": "string",
      "underlyingTokenId": "string",
      "priceAlertDismissedAt": 0,
      "priceAlertCount": 0
    },
    "opportunityId": "string",
    "distributionChain": {
      "id": 0,
      "name": "string",
      "icon": "string",
      "liveCampaigns": 0,
      "endOfDisputePeriod": 0,
      "explorers": [
        {
          "type": null,
          "url": null,
          "chainId": null
        }
      ],
      "lastClaimsOnchainFetchTimestamp": "string"
    },
    "distributionType": "DUTCH_AUCTION",
    "campaignStatus": {
      "campaignId": "string",
      "computedUntil": "string",
      "processingStarted": "string",
      "status": "string",
      "preComputeProcessingStarted": "string",
      "preComputeStatus": "string",
      "delay": 0,
      "error": "string",
      "details": null
    },
    "createdAt": "date",
    "rootCampaignId": "string",
    "parentCampaignId": "string",
    "childCampaignIds": [
      "string"
    ],
    "dailyRewardsBreakdown": [
      {
        "campaignId": "string",
        "value": 0,
        "maxValue": 0,
        "timestamp": null,
        "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
        },
        "amount": null,
        "distributionType": null,
        "onChainCampaignId": "string"
      }
    ],
    "pauseCompute": "string",
    "pausePrecompute": "string",
    "hasOverrides": false,
    "isPrivate": false,
    "hidden": false,
    "hideLeaderboard": false,
    "campaignEncodingHash": "string"
  }
]
get
https://api.merkl.xyz/v4/campaigns/
Merkl API
curl -X GET "https://api.merkl.xyz/v4/campaigns/"