Documentation Index
Fetch the complete documentation index at: https://yieldxyz.mintlify.app/llms.txt
Use this file to discover all available pages before exploring further.
What Actions Do
Actions turn protocol-specific yield operations into a single, normalized interface. Instead of integrating each protocol’s SDK or smart contract, you call one API and receive ordered, unsigned transactions ready for signing.Enter
Deposit assets to start earning yield
Exit
Withdraw assets from a position
Manage
Claim rewards, compound, redelegate, or perform other operations
How Actions Work
Request an action
Call
POST /v1/actions/enter (or exit, manage) with the yieldId, user address, and required arguments.Receive unsigned transactions
The API returns one or more ordered transactions with gas estimates. These are ready to sign — no protocol-specific logic required.
Sign and submit
Route the unsigned payloads through your signing infrastructure (browser wallet, hardware device, custody platform, or smart account).
Yield.xyz never holds keys or executes transactions. You retain full custody and signing control.
Ordered Unsigned Transactions
Actions may return multiple transactions that must be executed in order:| Step | Example |
|---|---|
| 1 | Approve token spending |
| 2 | Deposit into protocol |
| 3 | (Optional) Stake receipt token |
unsignedTransaction— the payload to signgasEstimate— suggested gas parameterstype— describes the operation (approve, stake, claim, etc.)
Signing Responsibility
Yield.xyz is signer-agnostic. The API returns unsigned payloads that work with any signing infrastructure:- Browser wallets
- Hardware wallets
- Smart accounts
- MPC & custody
MetaMask, Phantom, Keplr, etc.Pass
unsignedTransaction to the wallet’s signing method.Management Actions
Beyond enter and exit, yields may support additional operations:CLAIM_REWARDS
CLAIM_REWARDS
Claim pending rewards to the user’s wallet. Common for Cosmos staking, some DeFi protocols.
RESTAKE_REWARDS
RESTAKE_REWARDS
Compound rewards back into the position. Available where protocols support auto-compounding.
CLAIM_UNSTAKED
CLAIM_UNSTAKED
Claim funds after an unbonding period completes. Required for protocols with cooldowns.
REDELEGATE
REDELEGATE
Move staked assets from one validator to another without unstaking. Common for Cosmos, Polkadot.
WITHDRAW
WITHDRAW
Finalize a vault withdrawal after any required waiting period.
Smart Routing
If a user holds a different token than the yield expects, the API can return a route that includes swaps or bridges before the deposit. This is handled transparently — you receive the full transaction sequence.Monetization
Actions can include fee collection as part of the transaction flow. See Fees for details on:- Deposit fees (deducted at entry)
- Performance fees (on rewards)
- Management fees (on AUM)
API Reference
For complete endpoint documentation:Enter
POST /v1/actions/enter
Exit
POST /v1/actions/exit
Manage
POST /v1/actions/manage
Get Action
GET /v1/actions/
Next Steps
Balances & Positions
Track positions and lifecycle states
Quickstart
Run the complete flow end-to-end

