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.
Overview
Yield.xyz uses a compute unit (CU) model for usage-based billing. Compute units measure the resources consumed by API requests, with different endpoints having different CU costs based on complexity.Free data access is provided for positions originated through Yield.xyz. CU billing applies to historic data and positions not originated through the platform.
CU Allotments by Plan
| Plan | CU Allotment |
|---|---|
| Standard | 1,500,000 CU/month |
| Pro | 5,000,000 CU/month |
| Enterprise | Custom |
Get CU Pricing
Contact us for compute unit pricing details
Endpoint CU Costs
- Discovery & Yields
- Positions & Balances
- Actions & Transactions
| Endpoint | Method | CU Cost |
|---|---|---|
/yields | GET | 1 |
/yields/{yieldId} | GET | 1 |
/yields/{yieldId}/validators | GET | 1 |
Example CU Usage
Passive user (views positions once/month)
Passive user (views positions once/month)
| Endpoint | Requests | CU per Request | Total CU |
|---|---|---|---|
| getOpportunities | 1 | 1 | 1 |
| getBalances | 1 | 1 | 1 |
| createAction | 1 | 2 | 2 |
| Total | 4 CU/month |
Active user (multiple actions/month)
Active user (multiple actions/month)
| Endpoint | Requests | CU per Request | Total CU |
|---|---|---|---|
| getOpportunities | 3 | 1 | 3 |
| getBalances | 3 | 1 | 3 |
| createAction | 3 | 2 | 6 |
| getActions | 1 | 1 | 1 |
| getActionById | 1 | 1 | 1 |
| submitTransactionHash | 1 | 1 | 1 |
| submitTransaction | 1 | 1 | 1 |
| getTransaction | 1 | 1 | 1 |
| Total | ~17 CU/month |
Super active user (frequent transactions)
Super active user (frequent transactions)
| Endpoint | Requests | CU per Request | Total CU |
|---|---|---|---|
| getOpportunities | 9 | 1 | 9 |
| getBalances | 9 | 1 | 9 |
| createAction | 9 | 2 | 18 |
| getActions | 3 | 1 | 3 |
| getActionById | 3 | 1 | 3 |
| submitTransactionHash | 3 | 1 | 3 |
| submitTransaction | 3 | 1 | 3 |
| getTransaction | 3 | 1 | 3 |
| Total | ~51 CU/month |
Scaling Example
For 1 million monthly active users (MAU):| User Type | % of Users | Users | CU per User | Total CU |
|---|---|---|---|---|
| Passive | 97.75% | 977,500 | 4 | 3,910,000 |
| Active | 1.79% | 17,900 | 17 | 304,300 |
| Super Active | 0.46% | 4,600 | 51 | 234,600 |
| Total | 1,000,000 | ~4.4M CU |
Free vs Paid Data Access
- Free (originated via Yield.xyz)
Baseline data is free when positions are originated through Yield.xyz:
- Current TVL
- Current rewards
- Yield metadata
- Position balances for Yield.xyz-originated positions
Upgrade Your Plan
Upgrade to Pro
5,000,000 CU/month for high-volume apps
Enterprise Inquiry
Custom CU allotments and enterprise contracts
Next Steps
Plans & Pricing
Compare all plan features
Rate Limits
API rate limit details