Get yield metadata

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

GET /v1/yields/{yieldId}

Get yield metadata

cURL

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

200

{
  "id": "ethereum-eth-lido-staking",
  "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": []
  },
  "mechanics": {
    "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": [],
    "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

Path Parameters

yieldId · string · required

The unique identifier of the yield

Response

200

application/json

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

id · string · required

Unique identifier for this yield opportunity

Example:

"ethereum-eth-lido-staking"

network · enum<string> · required

Network this yield opportunity is on

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

inputTokens · object[] · required

Accepted input tokens (auto-converted as needed)

Show child attributes

token · object · required

Canonical deposit token - used for balances

Show child attributes

rewardRate · object · required

Total effective yield broken down by source and token.

Show child attributes

status · object · required

Current availability of user actions like enter, exit, claim

Show child attributes

metadata · object · required

Descriptive metadata including name, logo, description, and documentation

Show child attributes

mechanics · object · required

Operational mechanics including constraints, fees, and capabilities

Show child attributes

providerId · string · required

The provider ID this yield belongs to

Example:

"lido"

outputToken · object

Token received from the protocol

Show child attributes

statistics · object

Key statistics and analytics for this yield opportunity

Show child attributes

tags · string[]

Optional tags for filtering or categorization

Example:

["restaking", "ETH", "LST"]