Opportunities

Changed on

Get a unique opportunity by ID (hash) or composite identifier (chainId-type-identifier), including related campaigns. Use query parameters to filter results.

get/v4/opportunities/{id}/campaigns

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

Path parameters

idstring required

Opportunity ID (path-only). Two accepted forms: (1) internal numeric hash, ≤20 digits (e.g. 7673870997270712040), or (2) composite {chainId}-{type}-{identifier} (e.g. 1-ERC20LOGPROCESSOR-0x35Cbe8542E70fa2f7F9cDF129F19e593F4b4f560). The composite form is path-only — query filters (?id=, ?opportunityId=) only accept the numeric form. NOT a campaign ID. See ID types.

Query parameters

testboolean

Include test campaigns

pointboolean

Include point campaigns

campaignsboolean

Include campaign data. Will slow down the request

excludeSubCampaignsboolean

Exclude subcampaigns from the results.

Response

Response for status 200

idstring required
typestring required
identifierstring required
chainIdnumber required
namestring required
descriptionstring required
howToStepsstring[] required
tagsstring[] required
mainProtocolstring
depositUrlstring
explorerAddressstring
hiddenboolean
tvlnumber required
aprnumber required
dailyRewardsnumber required
maxDailyRewardsnumber
liveCampaignsnumber required
lastCampaignCreatedAtnumber required
earliestCampaignStartstring
latestCampaignStartstring
earliestCampaignEndstring
latestCampaignEndstring
nativeAprnumber
totalAprnumber
maxAprnumber
liveCampaignsForCreatornumber
soonCampaignsForCreatornumber
pastCampaignsForCreatornumber
distributionTypestring

Changes

  • b7784c9a78b9Revision changes
    • info

      added subschema #1 subschema #2 to the response body allOf list for the response status

    • info

      removed subschema #1 subschema #2 from the response body allOf list for the response status