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

# Getting started

> How the Yield.xyz APIs are organized: one project and API key, three products, three hosts, and where each endpoint reference begins.

Yield.xyz offers three HTTP APIs, Earn, Trade and Borrow, and any API key from your project works on all three. Each API has its own host and its own OpenAPI spec. Everything is served under the `/v1` path prefix, except `GET /health`.

| Product | Host | What it serves | Start here | Objects |
| - | - | - | - | - |
| Earn | `https://api.yield.xyz` | Yields, balances, actions, transactions, validators, networks, providers, KYC status | [List yields](/api-reference/YieldsController_getYields) | [Earn objects](/api-reference/earn-objects) |
| Trade (Perps API) | `https://perps.yield.xyz` | Perpetual-futures providers, markets, positions, orders, actions | [List providers](/api-reference/perps-api/discovery/list-providers) | [Trade objects](/api-reference/perps-api/objects) |
| Borrow | `https://borrow.yield.xyz` | Lending integrations, markets, positions, actions | [List integrations](/api-reference/borrow/integrations/list-integrations) | [Borrow objects](/api-reference/borrow/objects) |

## Contract at a glance

* **Auth.** Send `x-api-key: <project API key>` on every request. The same key works on all three hosts. See [Authentication](/api-reference/authentication).
* **Base URLs.** Production only. See [Base URLs](/api-reference/base-urls).
* **Project scoping.** Discovery and per-yield calls are scoped to the project that owns the key. Earn returns only yields enabled for that project.
* **Unsigned transactions.** Action endpoints return unsigned transactions. You sign them, then either broadcast them yourself or return them for Yield.xyz to submit, and Yield.xyz never holds keys. The submit bodies differ per API, so follow each product's transaction page.
* **Errors and limits.** Every API returns an error envelope and rate-limit headers. See [Errors and retries](/api-reference/errors-retries).
* **Typed client.** [`@yieldxyz/sdk`](/api-reference/sdks) wraps most Earn endpoints (not tokens, campaigns, KYC status or simulation).

> **[Make your first calls](/documentation/get-started/quickstart)**
>
> The quickstart walks through discovery, an action, signing and submission for each product.

## Next

> **[Authentication](/api-reference/authentication)**
>
> Key format, headers and 401 behavior.

> **[Errors and retries](/api-reference/errors-retries)**
>
> Error envelope, rate limits and what is safe to retry.


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