Discovery

Get yield campaigns

Returns campaign metadata for the given yield opportunity within the API key project scope.

get/v1/yields/{yieldId}/campaigns

Request

  • Base URL: https://api.yield.xyz
  • URL: https://api.yield.xyz/v1/yields/{yieldId}/campaigns
  • Auth: API key in header x-api-key

Path parameters

yieldIdstring required
Example:cosmos-atom-native-staking

Yield integration ID.

Query parameters

offsetnumber

Offset for pagination

limitnumber
Example:20

Maximum number of items to return

status'draft' | 'active' | 'paused' | 'ended'

Campaign status filter. Defaults to active.

Response

Campaign metadata for the given yield

totalnumber required

Total number of items available

offsetnumber required

Offset of the current page

limitnumber required

Limit of the current page

Example response

{
  "total": 100,
  "limit": 20,
  "items": [
    {
      "rewardRate": {
        "total": 6.5,
        "rateType": "APR",
        "components": [
          {
            "rate": 0.04,
            "rateType": "APR",
            "token": {
              "symbol": "ETH",
              "name": "Ethereum",
              "decimals": 18,
              "network": "Ethereum",
              "address": "0x...",
              "logoURI": "https://...",
              "isPoints": true,
              "coinGeckoId": "ethereum"
            },
            "yieldSource": "protocol_incentive",
            "description": "LDO distributed to incentivize stETH adoption via Lido Boost"
          }
        ]
      },
      "apyCeiling": 0.125,
      "qualificationConfig": {
        "threshold": "100",
        "maxIncentivizedTvlToken": "1000000"
      },
      "rewardToken": {
        "symbol": "ETH",
        "name": "Ethereum",
        "decimals": 18,
        "network": "Ethereum",
        "address": "0x...",
        "logoURI": "https://...",
        "isPoints": true,
        "coinGeckoId": "ethereum"
      }
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.