List all yield opportunities

Retrieve a paginated list of available yield opportunities across all supported networks and protocols.

GET /v1/yields

List all yield opportunities

cURL

curl --request GET \
  --url https://api.yield.xyz/v1/yields \
  --header 'x-api-key: <api-key>'

200

{
  "total": 100,
  "offset": 0,
  "limit": 20,
  "items": [
    {
      "id": "ethereum-eth-lido-staking",
      "network": "ethereum",
      "inputTokens": [
        {
          "symbol": "ETH",
          "name": "Ethereum",
          "decimals": 18,
          "network": "Ethereum",
          "address": "0x...",
          "logoURI": "https://...",
          "isPoints": true,
          "coinGeckoId": "ethereum"
        }
      ],
      "token": {
        "symbol": "ETH",
        "name": "Ethereum",
        "decimals": 18,
        "network": "Ethereum",
        "address": "0x...",
        "logoURI": "https://...",
        "isPoints": true,
        "coinGeckoId": "ethereum"
      },
      "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"
          }
        ]
      },
      "status": {
        "enter": true,
        "exit": true
      },
      "metadata": {
        "name": "Lido Staking",
        "logoURI": "https://lido.fi/logo.png",
        "description": "Stake ETH with Lido to earn auto-compounding validator rewards via stETH.",
        "documentation": "https://docs.lido.fi",
        "underMaintenance": false,
        "deprecated": false,
        "supportedStandards": [
          "ERC20"
        ]
      },
      "mechanics": {
        "type": "staking",
        "rewardSchedule": "block",
        "rewardClaiming": "auto",
        "gasFeeToken": {
          "symbol": "ETH",
          "name": "Ethereum",
          "decimals": 18,
          "network": "Ethereum",
          "address": "0x...",
          "logoURI": "https://...",
          "isPoints": true,
          "coinGeckoId": "ethereum"
        },
        "requiresValidatorSelection": true,
        "lockupPeriod": {
          "seconds": 86400
        },
        "cooldownPeriod": {
          "seconds": 86400
        },
        "warmupPeriod": {
          "seconds": 86400
        },
        "fee": {
          "deposit": "0.00",
          "withdrawal": "0.00",
          "management": "2.00",
          "performance": "20.00"
        },
        "entryLimits": {
          "minimum": "0.01",
          "maximum": "1000.0"
        },
        "supportsLedgerWalletApi": true,
        "extraTransactionFormatsSupported": [
          "raw"
        ],
        "arguments": {
          "enter": {
            "fields": [
              {
                "name": "amount",
                "type": "string",
                "label": "Amount to Enter",
                "description": "<string>",
                "required": true,
                "options": [
                  "individual",
                  "batched"
                ],
                "optionsRef": "/api/v1/validators?integrationId=eth-lido",
                "default": {},
                "placeholder": "<string>",
                "minimum": "1.0",
                "maximum": "100.0",
                "isArray": false
              }
            ],
            "notes": "<string>"
          },
          "exit": {
            "fields": [
              {
                "name": "amount",
                "type": "string",
                "label": "Amount to Enter",
                "description": "<string>",
                "required": true,
                "options": [
                  "individual",
                  "batched"
                ],
                "optionsRef": "/api/v1/validators?integrationId=eth-lido",
                "default": {},
                "placeholder": "<string>",
                "minimum": "1.0",
                "maximum": "100.0",
                "isArray": false
              }
            ],
            "notes": "<string>"
          },
          "manage": {},
          "balance": {
            "fields": [
              {
                "name": "amount",
                "type": "string",
                "label": "Amount to Enter",
                "description": "<string>",
                "required": true,
                "options": [
                  "individual",
                  "batched"
                ],
                "optionsRef": "/api/v1/validators?integrationId=eth-lido",
                "default": {},
                "placeholder": "<string>",
                "minimum": "1.0",
                "maximum": "100.0",
                "isArray": false
              }
            ],
            "notes": "<string>"
          }
        },
        "possibleFeeTakingMechanisms": {
          "depositFee": false,
          "managementFee": false,
          "performanceFee": false,
          "validatorRebates": false
        }
      },
      "providerId": "lido",
      "outputToken": {
        "symbol": "ETH",
        "name": "Ethereum",
        "decimals": 18,
        "network": "Ethereum",
        "address": "0x...",
        "logoURI": "https://...",
        "isPoints": true,
        "coinGeckoId": "ethereum"
      },
      "statistics": {
        "tvlUsd": "1,200,000",
        "tvl": "500.25",
        "tvlRaw": "500250000000000000000",
        "uniqueUsers": 348,
        "averagePositionSizeUsd": "3,448.27",
        "averagePositionSize": "1.44"
      },
      "tags": [
        "restaking",
        "ETH",
        "LST"
      ]
    }
  ]
}

Authorizations

x-api-key · string · header · required

Query Parameters

offset · number · default: 0

Offset for pagination

Required range: x >= 0

limit · number · default: 20

Number of items per page

Required range: 1 <= x <= 100

network · enum<string>

Filter by network

Available options: ethereum, ethereum-goerli, ethereum-holesky, ethereum-sepolia, ethereum-hoodi, arbitrum, base, base-sepolia, gnosis, optimism, polygon, polygon-amoy, starknet, zksync, linea, unichain, monad-testnet, avalanche-c, avalanche-c-atomic, avalanche-p, binance, celo, fantom, harmony, moonriver, okc, viction, core, sonic, katana, hyperevm, agoric, akash, axelar, band-protocol, bitsong, canto, chihuahua, comdex, coreum, cosmos, crescent, cronos, cudos, desmos, dydx, evmos, fetch-ai, gravity-bridge, injective, irisnet, juno, kava, ki-network, mars-protocol, nym, okex-chain, onomy, osmosis, persistence, quicksilver, regen, secret, sentinel, sommelier, stafi, stargaze, stride, teritori, tgrade, umee, sei, mantra, celestia, saga, zetachain, dymension, humansai, neutron, polkadot, kusama, westend, bittensor, binancebeacon, cardano, near, solana, solana-devnet, stellar, stellar-testnet, sui, tezos, tron, ton, ton-testnet

networks · string

Filter by multiple networks (comma separated)

yieldId · string

Maximum string length: 200

yieldIds · string[]

Maximum array length: 100

type · enum<string>

Filter by yield type

Available options: staking, restaking, lending, vault, fixed_yield, real_world_asset

types · enum<string>[]

Filter by multiple yield types (comma separated)

Available options: staking, restaking, lending, vault, fixed_yield, real_world_asset

hasCooldownPeriod · boolean

Filter by cooldown period

hasWarmupPeriod · boolean

Filter by warmup period

token · string

Filter by token symbol or address

inputToken · string

Filter by input token symbol or address

inputTokens · string[]

Filter by multiple input token symbol or address (comma separated)

provider · string

Filter by provider ID

providers · string[]

Filter by multiple provider IDs (comma separated)

search · string

Search by yield name

sort · enum<string>

Sort by yield status

Available options: statusEnterAsc, statusEnterDesc, statusExitAsc, statusExitDesc

Response

200

application/json

Returns a paginated list of yield opportunities

total · number · required

Total number of items available

Example:

100

offset · number · required

Offset of the current page

Example:

0

limit · number · required

Limit of the current page

Example:

20

items · object[]

Show child attributes