Sign in
Discovery

Get yield metadata

Retrieve detailed information about a specific yield opportunity including APY, tokens, protocol details, and more.

get/v1/yields/{yieldId}

Request

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

Path parameters

yieldIdstring required
Example:ethereum-eth-lido-staking

The unique identifier of the yield

Response

Returns yield metadata including network, APR, TVL, and token information

idstring required

Unique identifier for this yield opportunity

network'ethereum' | 'ethereum-goerli' | 'ethereum-holesky' | 'ethereum-sepolia' | 'ethereum-hoodi' | 'arbitrum' | 'base' | 'base-sepolia' | 'gnosis' | 'optimism' | 'polygon' | 'polygon-amoy' | 'starknet' | 'zksync' | 'linea' | 'unichain' | 'plume' | 'monad-testnet' | 'monad' | 'robinhood' | 'robinhood-testnet' | 'arc-testnet' | 'arc' | 'avalanche-c' | 'avalanche-c-atomic' | 'avalanche-p' | 'binance' | 'celo' | 'fantom' | 'harmony' | 'moonriver' | 'okc' | 'viction' | 'core' | 'sonic' | 'plasma' | 'katana' | 'hyperevm' | 'tempo' | 'pharos' | 'xlayer' | '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' | 'aptos' | 'binancebeacon' | 'cardano' | 'near' | 'solana' | 'solana-devnet' | 'stellar' | 'stellar-testnet' | 'sui' | 'tezos' | 'tron' | 'ton' | 'ton-testnet' | 'hyperliquid' required

Network this yield opportunity is on

chainIdstring

EVM chain ID for this network (only for EVM networks)

providerIdstring required

The provider ID this yield belongs to

primeboolean required

Whether this yield meets the Prime quality criteria. Evaluated globally by a scheduled job, so the value is the same for every consumer. Use ?prime=true to filter the catalog to Prime yields only. Prime is true only when a yield passes every applicable v1 gate: (1) TVL — at least $100M, reduced to $50M for staking, liquid-staking, restaking and real-world-asset yields; (2) Risk — the provider risk grade is no worse than B, enforced only for providers that report a letter grade (missing or numeric-only ratings skip this gate); (3) APY outlier (vault and lending yields only) — the spot rate is between 0% and 40% and within 3x of the yield’s own 30-day trailing average.

tagsstring[]

Optional tags for filtering or categorization

Example response

{
  "id": "ethereum-eth-lido-staking",
  "chainId": "1",
  "inputTokens": [
    {
      "symbol": "ETH",
      "name": "Ethereum",
      "decimals": 18,
      "network": "Ethereum",
      "address": "0x...",
      "logoURI": "https://...",
      "isPoints": true,
      "coinGeckoId": "ethereum"
    }
  ],
  "outputToken": {
    "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"
  },
  "tokens": [
    {
      "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"
      }
    ]
  },
  "feeConfigurations": [
    {
      "id": "66f299cd-aaaa-bbbb-cccc-d1f26e3a02db",
      "default": true,
      "statistics": {
        "tvlUsd": "1,200,000",
        "tvl": "500.25",
        "tvlRaw": "500250000000000000000",
        "uniqueUsers": 348,
        "averagePositionSizeUsd": "3,448.27",
        "averagePositionSize": "1.44"
      }
    }
  ],
  "statistics": {
    "tvlUsd": "1,200,000",
    "tvl": "500.25",
    "tvlRaw": "500250000000000000000",
    "uniqueUsers": 348,
    "averagePositionSizeUsd": "3,448.27",
    "averagePositionSize": "1.44"
  },
  "risk": {
    "ratings": [
      {
        "rating": "AA",
        "source": "credora"
      }
    ]
  },
  "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",
    "supportsCampaigns": true
  },
  "mechanics": {
    "requiresValidatorSelection": true,
    "gasFeeToken": {
      "symbol": "ETH",
      "name": "Ethereum",
      "decimals": 18,
      "network": "Ethereum",
      "address": "0x...",
      "logoURI": "https://...",
      "isPoints": true,
      "coinGeckoId": "ethereum"
    },
    "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",
      "subsequentMinimum": "10000"
    },
    "requirements": {
      "kyc": {
        "kycMode": "oauth_redirect",
        "eligibility": {
          "defaultPolicy": "deny",
          "countries": [
            "US"
          ],
          "blockedCountries": [
            "US",
            "CA",
            "CN"
          ],
          "blockedSubdivisions": [
            "UA-43",
            "UA-14"
          ],
          "investorEligibility": [
            {
              "jurisdiction": "US",
              "tier": "us_qualified_purchaser",
              "verificationLevel": "third_party_attestation",
              "expiresAfterDays": 90
            }
          ],
          "subjectTypes": [
            "KYC",
            "KYB"
          ]
        },
        "selfAttestation": {
          "documents": [
            {
              "name": "Risk Disclosures"
            }
          ]
        }
      }
    },
    "arguments": {
      "enter": {
        "fields": [
          {
            "name": "amount",
            "type": "string",
            "label": "Amount to Enter",
            "required": true,
            "options": [
              "individual",
              "batched"
            ],
            "optionsRef": "/api/v1/validators?integrationId=eth-lido",
            "minimum": "1.0",
            "maximum": "100.0"
          }
        ]
      },
      "exit": {
        "fields": [
          {
            "name": "amount",
            "type": "string",
            "label": "Amount to Enter",
            "required": true,
            "options": [
              "individual",
              "batched"
            ],
            "optionsRef": "/api/v1/validators?integrationId=eth-lido",
            "minimum": "1.0",
            "maximum": "100.0"
          }
        ]
      },
      "balance": {
        "fields": [
          {
            "name": "amount",
            "type": "string",
            "label": "Amount to Enter",
            "required": true,
            "options": [
              "individual",
              "batched"
            ],
            "optionsRef": "/api/v1/validators?integrationId=eth-lido",
            "minimum": "1.0",
            "maximum": "100.0"
          }
        ]
      }
    }
  },
  "providerId": "lido",
  "tags": [
    "restaking",
    "ETH",
    "LST"
  ],
  "state": {
    "pricePerShareState": {
      "price": 1.05,
      "shareToken": {
        "symbol": "ETH",
        "name": "Ethereum",
        "decimals": 18,
        "network": "Ethereum",
        "address": "0x...",
        "logoURI": "https://...",
        "isPoints": true,
        "coinGeckoId": "ethereum"
      },
      "quoteToken": {
        "symbol": "ETH",
        "name": "Ethereum",
        "decimals": 18,
        "network": "Ethereum",
        "address": "0x...",
        "logoURI": "https://...",
        "isPoints": true,
        "coinGeckoId": "ethereum"
      }
    },
    "concentratedLiquidityPoolState": {
      "baseApr": 0.12,
      "price": 3950.42,
      "tickSpacing": 50,
      "minTick": -887272,
      "maxTick": 887272,
      "volume24hUsd": 149550871.99,
      "fee24hUsd": 14955.09,
      "tvlUsd": 9213550.2,
      "feeTier": 0.0005,
      "baseToken": {
        "symbol": "ETH",
        "name": "Ethereum",
        "decimals": 18,
        "network": "Ethereum",
        "address": "0x...",
        "logoURI": "https://...",
        "isPoints": true,
        "coinGeckoId": "ethereum"
      },
      "quoteToken": {
        "symbol": "ETH",
        "name": "Ethereum",
        "decimals": 18,
        "network": "Ethereum",
        "address": "0x...",
        "logoURI": "https://...",
        "isPoints": true,
        "coinGeckoId": "ethereum"
      }
    },
    "allocations": [
      {
        "address": "0x1234567890abcdef1234567890abcdef12345678",
        "network": "base",
        "name": "Morpho Moonwell USDC",
        "yieldId": "base-usdc-morpho-moonwell-usdc",
        "providerId": "morpho",
        "allocation": "50000.00",
        "allocationUsd": "50000.00",
        "weight": 50.5,
        "targetWeight": 50,
        "rewardRate": {
          "total": 5.25,
          "rateType": "APY"
        },
        "tvl": "500.25",
        "tvlUsd": "10000000.00",
        "maxCapacity": "1000000.00",
        "remainingCapacity": "500000.00"
      }
    ]
  },
  "investmentSchedule": {
    "timezone": "America/New_York",
    "subscription": {
      "paths": [
        {
          "cutoffTime": "16:00",
          "currentWindow": {
            "opensAt": "2026-07-21T08:00:00Z",
            "closesAt": "2026-07-27T20:00:00Z"
          },
          "nextWindow": {
            "opensAt": "2026-07-21T08:00:00Z",
            "closesAt": "2026-07-27T20:00:00Z"
          },
          "settlement": {
            "marketDays": 1,
            "estimatedDuration": {
              "seconds": 86400
            },
            "instantPortion": 0.93
          },
          "accrual": {
            "minimumHold": {
              "seconds": 86400
            }
          },
          "limits": {
            "maxFractionOfNav": 0.05,
            "availableLiquidity": "323155"
          },
          "fee": {
            "rate": 0.0007
          }
        }
      ]
    },
    "redemption": {
      "paths": [
        {
          "cutoffTime": "16:00",
          "currentWindow": {
            "opensAt": "2026-07-21T08:00:00Z",
            "closesAt": "2026-07-27T20:00:00Z"
          },
          "nextWindow": {
            "opensAt": "2026-07-21T08:00:00Z",
            "closesAt": "2026-07-27T20:00:00Z"
          },
          "settlement": {
            "marketDays": 1,
            "estimatedDuration": {
              "seconds": 86400
            },
            "instantPortion": 0.93
          },
          "accrual": {
            "minimumHold": {
              "seconds": 86400
            }
          },
          "limits": {
            "maxFractionOfNav": 0.05,
            "availableLiquidity": "323155"
          },
          "fee": {
            "rate": 0.0007
          }
        }
      ]
    }
  },
  "executionContracts": {
    "enter": [
      "0x16D5A408e807db8eF7c578279BEeEe6b228f1c1C"
    ],
    "exit": [
      "0xae78736Cd615f374D3085123A210448E74Fc6393",
      "0x1231DEB6f5749EF6cE6943a275A1D3E7486F4EaE"
    ]
  }
}

Changes

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