Protocols

Changed on

List protocols supported and integrated by Merkl. Use query parameters to filter by chain ID, tags, or other criteria.

get/v4/protocols/

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/protocols/
  • Auth: apiKey (a scheme the document does not define)

Query parameters

string integer
OR
integer

0-indexed page number

string integer
OR
integer

Number of items returned by page

idstring

Filter by protocol slug (e.g. aave, morpho, uniswap). NOT a numeric ID. See ID types.

testboolean

Includes protocols that have only test opportunities

idsstring[]

Filter by multiple protocol slugs (e.g. aave, morpho).

namestring

Search protocols by name

tagsstring[]

Filter by tags

opportunityTagstring

Filter by underlying tag opportunities

string numeric
OR
number

Filter by underlying opportunity chains

statusunknown
excludeSubCampaignsboolean

Exclude sub-campaigns from the campaigns counted in numberOfLiveCampaigns and dailyRewards. Default: false.

Response

Response for status 200

idstring required
namestring required
iconstring required
tagsstring[] required
descriptionstring required
urlstring required
dailyRewardsnumber
numberOfLiveCampaignsnumber
opportunityLiveTagsstring[]
bannerstring required
opportunityBannerLightstring required
opportunityBannerDarkstring required

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