Skip to main content

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.

​
Yield.xyz Agent Skills

Yield.xyz provides the most complete API for integrating non-custodial, on-chain yield across 80+ blockchain networks. These skills enable AI agents to autonomously interact with the Yield.xyz API to discover yields, manage positions, and track portfolios.

​
Context

Yield.xyz is a unified infrastructure layer for yield and DeFi. It provides:
  • 2,900+ yield opportunities across staking, lending, vaults, restaking, liquid staking, and more
  • 80+ blockchain networks including EVM (Ethereum, Arbitrum, Base, etc.), Cosmos, Solana, Polkadot, and others
  • Non-custodial architecture — all transactions are unsigned and require client-side signing
  • Unified API — one interface for all yield types and networks

​
API Authentication

All endpoints require an API key passed via the x-api-key header: 
curl https://api.yield.xyz/v1/yields -H "x-api-key: YOUR_API_KEY"
API keys are obtained from https://dashboard.yield.xyz.

​
Base URL

  • Production: https://api.yield.xyz/v1
  • Staging: https://api.staging.yield.xyz/v1

​
Skills

​
find-yields

Discover and search yield opportunities. Query the full catalog of yields with filters for network, token, provider, type, and APY. Use when a user wants to find, list, compare, or browse yield opportunities.
  • Endpoint: GET /v1/yields with query parameters
  • Key filters: network, type, token, provider, search
  • Supports: Pagination, multi-value filters, sorting

​
get-yield-info

Get detailed metadata for a specific yield. Retrieve APY/APR rates, token details, validator information, cooldown periods, and action requirements. Use when a user asks about a specific yield or needs details before entering.
  • Endpoints: GET /v1/yields/{yieldId}, GET /v1/yields/{yieldId}/validators
  • Key data: Reward rate, token, provider, status, argument schema

​
enter-position

Enter (deposit into) a yield position. Generate unsigned transactions to stake, deposit, lend, or enter any yield. Covers the full workflow: action creation, transaction signing, and hash submission.
  • Endpoint: POST /v1/actions/enter
  • Required: yieldId, address, arguments.amount
  • Optional: validatorAddress, providerId, inputToken, feeConfigurationId

​
exit-position

Exit (withdraw from) a yield position. Generate unsigned transactions to unstake, withdraw, or exit. Handles cooldown periods and partial withdrawals.
  • Endpoint: POST /v1/actions/exit
  • Required: yieldId, address, arguments.amount
  • Handles: Cooldown periods, partial exits, vault share redemption

​
manage-position

Manage an existing yield position. Claim rewards, restake, claim unstaked tokens, rebond, vote, and other lifecycle operations.
  • Endpoint: POST /v1/actions/manage
  • Required: yieldId, address, action (e.g., CLAIM_REWARDS, RESTAKE_REWARDS, CLAIM_UNSTAKED)
  • Actions: CLAIM_REWARDS, RESTAKE_REWARDS, CLAIM_UNSTAKED, REBOND, VOTE, DELEGATE, and more

​
check-portfolio

View yield portfolio and balances. Retrieve positions, balances, and rewards across multiple networks and protocols. Supports both aggregate and per-yield queries.
  • Endpoints: POST /v1/yields/balances, POST /v1/yields/{yieldId}/balances
  • Balance types: staked, unstaking, unstaked, rewards, locked, claimable
  • Supports: Multi-network scanning, deduplication, partial failure handling

​
programmatic-access

Automate dashboard operations via the Programmatic API. Manage projects, API keys, enabled yields, fee configurations, and reports without manual dashboard interaction. Use when automating client onboarding, provisioning workspaces, or managing platform configuration at scale.
  • Base URL: https://api.stakek.it/v1/programmatic/
  • Auth: X-ADMIN-API-KEY header (separate from project-level X-API-KEY)
  • Resources: Projects, Keys, Enabled Yields, Fee Configuration, Reports

​
Capabilities

An AI agent using these skills can:
  1. Discover — Find the best yield opportunities based on user preferences (network, token, risk profile, APY)
  2. Analyze — Retrieve and present detailed yield metadata, validator information, and historical performance
  3. Execute — Generate enter/exit/manage transactions for yield positions
  4. Monitor — Track portfolio balances, rewards, unstaking progress, and position lifecycle
  5. Optimize — Compare yields across protocols and networks to suggest optimal allocations
  6. Administer — Provision projects, mint keys, enable yields, configure fees, and pull reports via the Programmatic API

​
Workflows

​
End-to-End Staking Flow

  1. Use find-yields to discover staking options for the user’s token
  2. Use get-yield-info to get details and validators for the chosen yield
  3. Use enter-position to generate and sign the staking transaction
  4. Use check-portfolio to verify the position was created
  5. Periodically use check-portfolio to monitor rewards
  6. Use manage-position to claim or restake rewards
  7. When ready, use exit-position to unstake

​
Portfolio Review

  1. Use check-portfolio with the user’s addresses across all networks
  2. For each position, use get-yield-info to get current rates
  3. Identify positions with claimable rewards
  4. Suggest management actions (claim, restake, rebalance)

​
Client Provisioning (Programmatic API)

  1. Use programmatic-access to create a project for the new client
  2. Mint a dedicated API key for the project
  3. Enable a curated set of yield integrations
  4. Configure fees if needed (deposit, management, performance)
  5. Monitor activity via report entries

​
Constraints

  • All transactions are unsigned — the agent cannot sign transactions directly. The user or their signing infrastructure must sign and broadcast.
  • Geoblocking is enforced on enter/exit/manage actions. Blocked regions receive a 403 error.
  • Rate limits vary by plan: Free (10 req/s), Starter (50 req/s), Pro (200 req/s), Enterprise (custom).
  • Amounts must be in base units (e.g., wei for ETH, lamports for SOL).
  • Transactions must be executed sequentially in the order returned by the API.