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.

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.

​
Borrow

Borrow API

Supply collateral, borrow, repay and withdraw through the Borrow API.

Borrow widget

Turn on the Borrow tab in the Yield.xyz widget.

​
Widgets & UI

Yield widget

Embed a complete Earn interface with @stakekit/widget.

Widget Pro

The dashboard layout of the widget, with Borrow, Manage and Activity.

Perps widget

Run, deploy and embed a compact perps trading module.

Perps dashboard

Run and deploy a full desktop trading terminal.
  • Dashboards: fees and payouts, webhooks, SSO and team roles in the dashboard.
  • Transaction signing: sign and submit returned transactions on each chain family, including from a custody or HSM signer.
  • Embedded wallets: build on Yield.xyz with Turnkey, Dynamic, Portal, Crossmint or Sequence.
  • Perps: open and manage a perps position through the Perps API.
  • Legacy and migration: moving an existing integration to the current API.