> ## 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 yields

> Understand the yield object, its stable ID, and how to find the yields enabled for your project.

A yield is yield.xyz's normalized object for a single earning opportunity: one network, one provider, one set of tokens, and one reward rate, in a consistent schema whether the opportunity is a validator delegation, a lending market, or a tokenized treasury.

Every yield has a stable string `id`, such as `ethereum-eth-lido-staking`. You pass this `id` into every later call: reading full metadata, requesting an `enter`, `exit`, or `manage` action, and checking balances. See [Yield metadata](/documentation/earn/core-concepts/yield-metadata) for the full object reference.

## Availability is project-scoped

`GET /v1/yields` does not return a global catalog. It returns only the yields enabled for the API key's project, plus any of the project's active OAVs (Optimized Allocator Vaults). A project with nothing enabled yet gets an empty list.

Calling a per-yield endpoint, such as an action or a balance check, on a yield that isn't enabled for the project returns `400 Bad Request`.

Enable yields for a project from the [dashboard](https://dashboard.yield.xyz), or programmatically through [Programmatic access](/documentation/advanced-setup/programmatic-access). See [Projects & API keys](/documentation/get-started/projects-api-keys) for how projects, keys, and enabled yields relate.

## Network, provider, and token

Each yield belongs to exactly one `network` and one `providerId`, the protocol or validator operator behind it, for example Lido or Morpho.

Its tokens (`inputTokens`, `token`, and `outputToken`) say what you can enter with, what balances are denominated in, and what you receive back, if anything. See [Yield metadata](/documentation/earn/core-concepts/yield-metadata#tokens).

## Filter your yields

`GET /v1/yields` accepts these filters, composable with each other:

| Filter | Matches |
| - | - |
| `network`, `networks` | One network, or a comma-separated list |
| `chainId` | EVM chain ID, for example `1` for Ethereum or `137` for Polygon |
| `type`, `types` | One yield type, or a comma-separated list, using the values under [Yield types](/api-reference/earn-objects#yield-types) |
| `token` | The yield's underlying token, by symbol or address |
| `inputToken`, `inputTokens` | Tokens accepted for entry, by symbol or address |
| `provider`, `providers` | One provider ID, or a comma-separated list |
| `yieldId`, `yieldIds` | One yield ID, or a comma-separated list, to fetch a known set |
| `search` | Free-text match on yield name |
| `prime` | `true` for Prime yields only, `false` for non-Prime only; omit it to return both |
| `hasCooldownPeriod`, `hasWarmupPeriod` | Only yields with, or without, that lifecycle period |
| `sort` | Sort by status or reward rate |
| `offset`, `limit` | Pagination |

`GET /v1/yields/{yieldId}` returns a single yield by its `id`, for example `GET /v1/yields/ethereum-eth-lido-staking`.

Three related endpoints support discovery:

* `GET /v1/networks` returns the networks with at least one enabled yield for your project. Like `/v1/yields`, it's project-scoped and returns an empty list for a project with nothing enabled.
* `GET /v1/tokens` returns tokens with at least one enabled yield for your project, filterable by exact token address or symbol, network, yield type, and enter/exit availability. It's project-scoped in the same way.
* `GET /v1/providers` returns the full provider catalog (protocols and validator providers), paginated by `offset` and `limit`. Unlike the other three endpoints, it isn't scoped to your project's enabled yields.

For what's live in each category, see [RWA coverage](/documentation/earn/coverage/rwas), [DeFi coverage](/documentation/earn/coverage/defi), and [Staking coverage](/documentation/earn/coverage/staking).

## Next steps

<CardGroup cols={2}>
  <Card title="Yield metadata" icon="tags" href="/documentation/earn/core-concepts/yield-metadata">
    Read the full field reference: reward rates, fees, limits, and argument schemas.
  </Card>

  <Card title="Quickstart" icon="rocket" href="/documentation/get-started/quickstart">
    Run the full discover, act, and track flow end to end.
  </Card>

  <Card title="Discover yields guide" icon="compass" href="/guides/earn/discover-yields">
    Build yield browsing and asset-first UX patterns.
  </Card>

  <Card title="List yields" icon="code" href="/api-reference/YieldsController_getYields">
    Full request and response reference for `GET /v1/yields`.
  </Card>
</CardGroup>


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.