Skip to main content

Documentation Index

Fetch the complete documentation index at: https://yieldxyz.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

​
The Yield Catalog

The Yield.xyz API exposes a yield catalog — a normalized, queryable index of earning opportunities across staking, liquid staking, restaking, DeFi lending, vaults, and more. Each yield represents a specific opportunity with:
  • A unique yieldId (e.g., ethereum-eth-lido-staking)
  • Metadata describing mechanics, tokens, and constraints
  • Real-time reward rates and TVL signals
  • Supported actions (enter, exit, manage)
The catalog spans 80+ networks, 30+ staking providers, and 40+ DeFi protocols — all accessible through a single API.

​
Core Discovery Objects

Yields

Individual earning opportunities with APY, tokens, fees, and action schemas.

Providers

Protocols and validators offering yields (e.g., Lido, Morpho, Everstake).

Networks

Supported blockchains (Ethereum, Solana, Cosmos, etc.) with chain-specific metadata.

Validators

For native staking yields — individual validators with commission and performance data.

​
What’s in a Yield?

Each yield object contains everything needed to display, filter, and execute:
  • yieldId — unique identifier
  • name — display name
  • type — staking, lending, vault, restaking, etc.
  • provider — protocol or validator operator
  • network — blockchain
  • apy — annualized percentage yield
  • rewardRate — base reward rate
  • rewardTokens — tokens earned (may differ from input)
  • rewardType — rebasing, exchange rate, or claimable
  • inputToken — what users deposit
  • outputToken — receipt token (stETH, aUSDC, etc.)
  • minimumDeposit — minimum amount to enter
  • lockPeriod — if funds are locked or have cooldowns
  • enterArgs — required inputs for entering
  • exitArgs — required inputs for exiting
  • manageActions — claim, compound, redelegate, etc.
  • fees — deposit, performance, management fees
  • validatorCommission — for staking yields

​
Common Discovery Patterns

​
Browse and filter

Build product UX that lets users explore yields by network, token, or provider. 
# Filter by network
GET /v1/yields?network=ethereum

# Filter by input token
GET /v1/yields?inputToken=USDC

# Filter by provider
GET /v1/yields?provider=lido

​
Get yield details

Fetch full metadata for a specific yield before showing details or initiating an action. 
GET /v1/yields/ethereum-eth-lido-staking

​
List validators

For native staking, fetch available validators with commission and performance data. 
GET /v1/yields/ethereum-eth-everstake-staking/validators

​
How Discovery Fits Your Product

Use case: Let users explore all available opportunities
  • Fetch the full catalog with filters
  • Display APY, tokens, lock periods
  • Link to action flows

​
API Reference

For full endpoint documentation, schemas, and response examples:

List Yields

Query the yield catalog

Get Yield

Fetch single yield details

List Validators

Get validators for staking yields

List Networks

Supported blockchains

​
Next Steps

Actions

Learn how to enter, exit, and manage yields

Quickstart

Run the full integration flow