The Yield.xyz Yield Data API exposes a single, unified interface across every chain and protocol Yield.xyz supports. It provides all the metadata needed to build a staking and yield experience — discovering yield opportunities, reading real‑time reward rates and protocol state, fetching a user’s positions and rewards, listing validators, and constructing and tracking enter / exit / manage transactions. Protocol‑specific quirks are absorbed internally and never leaked to the response surface.

Endpoints

Method Path Summary
GET /v1/yields List all yield opportunities (paginated, filterable).
GET /v1/yields/{yieldId} Get metadata for a single yield opportunity.
GET /v1/yields/{yieldId}/risk Get risk scores and provider ratings for a yield.
GET /v1/yields/{yieldId}/validators List validators available for a yield.
GET /v1/yields/{yieldId}/campaigns Get campaign metadata for a yield.
POST /v1/yields/{yieldId}/balances Get a user’s balances for a single yield.
GET /v1/yields/{yieldId}/balances/history Get historical balance snapshots for a yield.
GET /v1/yields/{yieldId}/rewards/history Get reward history for a yield.
GET /v1/yields/{yieldId}/reward-rate/history Get historical reward rate snapshots for a yield.
GET /v1/yields/{yieldId}/tvl/history Get historical TVL snapshots for a yield.
GET /v1/yields/{yieldId}/kyc/status Get the KYC status of an address for a yield.
POST /v1/yields/balances Get balances across multiple yields, addresses, and networks (portfolio / chain scan).
GET /v1/tokens List tokens with available yields.
GET /v1/networks List all supported networks.
GET /v1/providers List all protocol / validator providers.
GET /v1/providers/{providerId} Get a single provider by ID.
POST /v1/actions/enter Create an enter (deposit / stake) action.
POST /v1/actions/exit Create an exit (unstake / withdraw) action.
POST /v1/actions/manage Create a manage action (claim rewards, restake, etc.).
GET /v1/actions List a user’s actions.
GET /v1/actions/{actionId} Get details for a single action.
POST /v1/transactions/{transactionId}/submit Submit a signed transaction for broadcast.
PUT /v1/transactions/{transactionId}/submit-hash Submit the hash of an already‑broadcast transaction.
GET /v1/transactions/{transactionId} Get transaction status and details.
GET /health Health check.

Yield Metadata Data Dictionary

YieldDto

The core object of the API. Encapsulates everything needed to describe, price, and transact against a yield opportunity.

Field Type Description
id string Unique identifier for the yield opportunity (e.g. ethereum-eth-lido-staking). Used for all yield‑related interactions.
network Networks Network this yield is on.
chainId string (optional) EVM chain ID (only for EVM networks), e.g. 1.
inputTokens TokenDto[] Accepted input tokens (auto‑converted as needed).
outputToken TokenDto (optional) Token received from the protocol (e.g. the LST / vault share token).
token TokenDto Canonical deposit token — used for balances.
tokens TokenDto[] Canonical deposit tokens — used for balances.
rewardRate RewardRateDto Total effective yield, broken down by source and token.
statistics YieldStatisticsDto (optional) Key statistics and analytics (TVL, unique users, avg position size).
risk YieldRiskSummaryDto (optional) Risk scores and third‑party provider ratings.
status YieldStatusDto Current availability of user actions (enter / exit).
metadata YieldMetadataDto Descriptive metadata (name, logo, description, documentation).
mechanics YieldMechanicsDto Operational mechanics — constraints, fees, periods, capabilities, action arguments.
providerId string The provider this yield belongs to (e.g. lido).
curator CuratorDto (optional) Curator information (for curated vaults).
tags string[] (optional) Optional tags for filtering / categorization (e.g. ["restaking","ETH","LST"]).
state YieldStateDto (optional) Dynamic, real‑time protocol‑level state affecting entry/exit (pool price, capacity, price per share, liquidity, allocations).

TokenDto

Detailed information about a token involved in a yield.

Field Type Description
name string Token name (e.g. Ethereum).
symbol string Token ticker (e.g. ETH).
decimals number Number of decimal places (0–255).
network Networks Network the token belongs to.
address string (optional) Token contract address (omitted for native tokens).
logoURI string (optional) URI of the token logo (typically Yield.xyz CDN).
coinGeckoId string (optional) CoinGecko ID used to fetch token prices.
isPoints boolean (optional) Whether this “token” represents points rather than a fungible asset.

RewardRateDto

Structured, total effective yield for a yield opportunity or validator, split into contributing components.