Skip to main content
Each guide takes one task to a verifiable result. For what the product is and how it works, see Documentation. For exact request and response schemas, see the API reference. Building your first integration? Start with the quickstart rather than this section.

AI & Agents

AI guides

Connect an editor or agent to yield.xyz, generate integration code, and write reviewable prompts.

Earn

Discover yields

Filter and page through your project’s enabled yields.

Enter and exit flows

Build, sign, and submit a deposit or withdrawal.

Tracking balances

Read positions, balance types, and pending actions.

Monitoring and alerting

Poll actions and transactions through to a terminal state.

Recipes

Runnable examples for common flows.

Lending

Supply an asset to a lending market and withdraw it.

Vaults

Deposit into a third-party vault, including a queued exit.

Deposit and redeem RWAs

Check eligibility, enter a real-world-asset yield, and redeem it.

Stake a token

Stake, including validator selection, then exit and withdraw.
  • Yield widget: embed the yield flow in your own UI.
  • Dashboards: request a Meta Vault, and set up fees and payouts.
  • Deeplink into the widget: open a widget deployment on a specific yield or pending action.
  • Transaction signing: sign and submit returned transactions on each chain family.
  • Embedded wallets: drive the same flow from an embedded or MPC wallet.
  • Enterprise: webhooks, SSO, team roles, programmatic access, and custody flows.
  • Borrow: supply collateral and borrow through the Borrow API.
  • Perps: open and manage a perps position through the Perps API.
  • Legacy and migration: moving an existing integration to the current API.