Creator

Returns paginated opportunities for a specific creator. Use page, items, and other query parameters to filter.

get/v4/creators/{creator}/opportunities

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

Path parameters

creatorstring required

Query parameters

string integer
OR
integer

0-indexed page number

string integer
OR
integer

Number of items returned by page

namestring

Filter by name

searchstring

Search amongst multiple values (token, protocols, tags, campaigns)

chainIdunknown
actionstring

A comma seprated list actions. Legal values are: POOL, HOLD, DROP, LEND, BORROW, LONG, SHORT, SWAP, INVALID, STAKE

typestring

A comma separated list of Opportunity type

tagsstring

Filter by tag

testboolean

Include opportunities with test campaigns

minimumTvlnumber

Minimum TVL threshold in USD

maximumTvlnumber

Maximum TVL threshold in USD

minimumAprnumber

Minimum APR threshold

maximumAprnumber

Maximum APR threshold

minimumDailyRewardsnumber

Minimum daily rewards threshold in USD

maximumDailyRewardsnumber

Maximum daily rewards threshold in USD

minimumCreatedAtnumber

Filter opportunities whose last campaign was created at or after this Unix timestamp (seconds)

maximumCreatedAtnumber

Filter opportunities whose last campaign was created at or before this Unix timestamp (seconds)

statusunknown
identifierstring

Filter by opportunity identifier (a.k.a. mainParameter). Free-form string, often a pool/vault/market address (e.g. 0x35Cbe8542E70fa2f7F9cDF129F19e593F4b4f560) or an arbitrary on-chain hash for non-address opportunities. NOT a campaign ID. See ID types.

idstring

A comma-separated list of internal opportunity IDs (Opportunity.id, numeric hash). Example: ?id=5877322385708089533,1234567890. NOT campaign IDs. See ID types.

tokensstring

A comma separated list of token symbol. Use to filter by token

stablecoinboolean

Filter opportunities that include at least one stablecoin token

rewardTokenSymbolstring

Filter by opportunity that have at least 1 campaigns where the reward token has this symbol

sortunknown
orderstring

asc to sort in ascending order or desc to sort in descending order.

mainProtocolIdstring

A comma-separated list of protocol slugs (e.g. aave,morpho,uniswap). NOT numeric IDs. List slugs at GET /v4/protocols. See ID types.

programSlugsstring

A comma separated list of program ids or slugs. You can get the list of all supported programs by calling GET /v4/programs

chainNameunknown
explorerAddressstring

Filter by on-chain pool/vault/market address (20-byte EVM address, e.g. 0x35Cbe8542E70fa2f7F9cDF129F19e593F4b4f560). Often the most reliable way to look up an opportunity if you only know the underlying contract. See ID types.

campaignTypesunknown

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

    • 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

    • info

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

    • info

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