Product
What does Yield.xyz provide?
What does Yield.xyz provide?
Yield.xyz is a non-custodial API platform for offering on-chain yield, trading and borrowing to your users. It has three products, Earn, Trade and Borrow, each with its own API: the Earn API, the Perps API (Trade, today) and the Borrow API. All three use the same project API key and the same flow: find an opportunity, request an action, sign the transactions that come back, and track the result. See the Quickstart and Why use Yield.xyz.
What are Earn, Trade and Borrow?
What are Earn, Trade and Borrow?
Earn covers more than 4,000 yields across 85+ networks and 100+ protocols, including staking, lending, vaults, restaking, liquid staking and RWAs, through the Earn API. Trade offers Hyperliquid perps today through the Perps API, including markets that track stock prices. The Trade API, coming soon, adds Lighter perps, Hyperliquid spot and prediction markets, and stocks from Dinari and Ondo Global Markets behind the same
buy, sell and manage calls. Borrow lets users supply collateral and borrow against it across about 960 markets on Aave V3, SparkLend, Morpho Blue and Lista, with Compound V3 being added, through the Borrow API. See Earn, Trade and Borrow.What is the difference between Yield.xyz and StakeKit?
What is the difference between Yield.xyz and StakeKit?
Yield.xyz is the current name of the product previously called StakeKit. The rename reflects the move from staking alone to Earn, Trade and Borrow. The
@stakekit/widget npm package keeps its name.Which networks and yields are covered?
Which networks and yields are covered?
Coverage changes over time, so the coverage pages are the reference. See Networks for the network list, and the Earn coverage pages for staking, DeFi, stablecoins and RWAs. Borrow and Trade have their own pages: Borrow coverage and Trade coverage.
Why does GET /v1/yields not return every yield?
Why does GET /v1/yields not return every yield?
GET /v1/yields is project-scoped. It returns the yields enabled for the project that owns the API key. A yield can be missing because it is not enabled for your project, because of region or policy restrictions, or because it is temporarily disabled. Contact support with the yield ID and your project. For Borrow, GET /v1/markets is project-scoped by default in the same way.Custody and security
Does Yield.xyz hold user funds or private keys?
Does Yield.xyz hold user funds or private keys?
No. Yield.xyz builds every transaction and returns it unsigned. You sign it in your own stack, with a browser wallet, MPC, a smart contract account or institutional custody, then either broadcast it yourself or return it for Yield.xyz to submit. See Transaction signing.
What is Shield?
What is Shield?
Shield checks each unsigned transaction before you sign it by comparing it with the pattern expected for it, including the target contract, receiver, spender and calldata. It reduces the risk of payload tampering and blind signing. See Shield and the security overview.
How do I report a security issue?
How do I report a security issue?
Email security@yield.xyz and do not disclose the issue publicly. For security review material such as reports and data-handling details, ask your account team.
API keys and plans
How do API keys and projects work?
How do API keys and projects work?
A project holds your configuration and API key. Send the key in the
x-api-key header. The same project key works across the Earn API (https://api.yield.xyz), the Perps API (https://perps.yield.xyz) and the Borrow API (https://borrow.yield.xyz). Keep keys server-side. See Onboarding.What are the rate limits and plans?
What are the rate limits and plans?
Limits are enforced per API key by plan. See Rate limits and Plans. For pricing questions, email hello@yield.xyz.
How do fees and monetization work?
How do fees and monetization work?
You set your own fees on each product, and they are paid to you on-chain. Earn supports deposit, management and performance fees, Trade a builder fee on perps trades, and Borrow a fee on Morpho Blue loans. You also receive a share of the revenue earned by validators and vault curators. For Earn, see Monetization. Trade and Borrow have their own pages: Trade monetization and Borrow monetization.
How does geo-blocking work?
How does geo-blocking work?
Yield.xyz can block requests by country or region at the API level. A blocked request returns
403. See Geo-blocking.Exits, KYC and history
Why is my exit not withdrawable yet?
Why is my exit not withdrawable yet?
Some yields have a cooldown or unbonding period. After an
exit action, the balance moves to exiting, then to withdrawable once the cooldown ends. On some yields you then complete a withdrawal with a pending action. Read the balance’s pendingActions instead of assuming funds return automatically. See Balances and positions and Enter and exit flows.How do KYC and eligibility work for RWA yields?
How do KYC and eligibility work for RWA yields?
Some RWA products require the issuer to approve the depositing address. Check
GET /v1/yields/{yieldId}/kyc/status before building an action. See KYC and Check RWA eligibility.Where do I find historical data?
Where do I find historical data?
Reward-rate history and TVL history are public endpoints. Rewards history and balances history are not public. See Rewards and history.
How do I troubleshoot API errors?
How do I troubleshoot API errors?
401 means the key is missing or invalid, 429 means you exceeded your rate limit, and 400 means invalid parameters. Errors and retries lists which errors are safe to retry.Support
How do I get help or request a new integration?
How do I get help or request a new integration?
Email hello@yield.xyz with the endpoint, timestamp, request or action ID and yield ID. To request a network, protocol or yield, include the name, target assets and expected volume. For onboarding steps, see Onboarding.
Where do I track changes?
Where do I track changes?
See the changelog.
Quickstart
Run the full integration loop with your first requests.