> ## Documentation Index
> Fetch the complete documentation index at: https://yieldxyz.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Discover

> Explore the yield catalog and find earning opportunities

## 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`)

<Info>
  The catalog spans **80+ networks**, **30+ staking providers**, and **40+ DeFi protocols** — all accessible through a single API.
</Info>

***

## Core Discovery Objects

<CardGroup cols={2}>
  <Card title="Yields" icon="coins">
    Individual earning opportunities with APY, tokens, fees, and action schemas.
  </Card>

  <Card title="Providers" icon="building">
    Protocols and validators offering yields (e.g., Lido, Morpho, Everstake).
  </Card>

  <Card title="Networks" icon="globe">
    Supported blockchains (Ethereum, Solana, Cosmos, etc.) with chain-specific metadata.
  </Card>

  <Card title="Validators" icon="server">
    For native staking yields — individual validators with commission and performance data.
  </Card>
</CardGroup>

***

## What's in a Yield?

Each yield object contains everything needed to display, filter, and execute:

<AccordionGroup>
  <Accordion title="Identity & classification">
    * `yieldId` — unique identifier
    * `name` — display name
    * `type` — staking, lending, vault, restaking, etc.
    * `provider` — protocol or validator operator
    * `network` — blockchain
  </Accordion>

  <Accordion title="Reward rates">
    * `apy` — annualized percentage yield
    * `rewardRate` — base reward rate
    * `rewardTokens` — tokens earned (may differ from input)
    * `rewardType` — rebasing, exchange rate, or claimable
  </Accordion>

  <Accordion title="Token mechanics">
    * `inputToken` — what users deposit
    * `outputToken` — receipt token (stETH, aUSDC, etc.)
    * `minimumDeposit` — minimum amount to enter
    * `lockPeriod` — if funds are locked or have cooldowns
  </Accordion>

  <Accordion title="Action schemas">
    * `enterArgs` — required inputs for entering
    * `exitArgs` — required inputs for exiting
    * `manageActions` — claim, compound, redelegate, etc.
  </Accordion>

  <Accordion title="Fee structures">
    * `fees` — deposit, performance, management fees
    * `validatorCommission` — for staking yields
  </Accordion>
</AccordionGroup>

***

## Common Discovery Patterns

### Browse and filter

Build product UX that lets users explore yields by network, token, or provider.

```bash theme={null}
# 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.

```bash theme={null}
GET /v1/yields/ethereum-eth-lido-staking
```

### List validators

For native staking, fetch available validators with commission and performance data.

```bash theme={null}
GET /v1/yields/ethereum-eth-everstake-staking/validators
```

***

## How Discovery Fits Your Product

<Tabs>
  <Tab title="Yield browser">
    **Use case:** Let users explore all available opportunities

    * Fetch the full catalog with filters
    * Display APY, tokens, lock periods
    * Link to action flows
  </Tab>

  <Tab title="Asset-first UX">
    **Use case:** "What can I do with my ETH?"

    * Query by `inputToken`
    * Show yields ranked by APY or TVL
    * Present options contextually
  </Tab>

  <Tab title="Curated selection">
    **Use case:** Featured or recommended yields

    * Pre-select yield IDs to display
    * Fetch only those yields
    * Control UX without exposing full catalog
  </Tab>

  <Tab title="Eligibility checks">
    **Use case:** "Can this user enter this yield?"

    * Check `minimumDeposit`
    * Validate network support
    * Respect geoblocking rules
  </Tab>
</Tabs>

***

## API Reference

For full endpoint documentation, schemas, and response examples:

<CardGroup cols={2}>
  <Card title="List Yields" icon="list" href="/api-reference/YieldsController_getYields">
    Query the yield catalog
  </Card>

  <Card title="Get Yield" icon="circle-info" href="/api-reference/YieldsController_getYield">
    Fetch single yield details
  </Card>

  <Card title="List Validators" icon="server" href="/api-reference/YieldsController_getYieldValidators">
    Get validators for staking yields
  </Card>

  <Card title="List Networks" icon="globe" href="/api-reference/NetworksController_getNetworks">
    Supported blockchains
  </Card>
</CardGroup>

***

## Next Steps

<CardGroup cols={2}>
  <Card title="Actions" icon="bolt" href="/documentation/core-concepts/actions">
    Learn how to enter, exit, and manage yields
  </Card>

  <Card title="Quickstart" icon="rocket" href="/documentation/quickstart">
    Run the full integration flow
  </Card>
</CardGroup>