from compass_api_sdk import CompassAPI, models
with CompassAPI(
api_key_auth="<YOUR_API_KEY_HERE>",
) as compass_api:
res = compass_api.earn.earn_vaults(order_by="lifetime_return", chain=models.V2EarnVaultsChain.ETHEREUM, direction=models.Direction.DESC, offset=0, limit=50)
# Handle response
print(res){
"total": 123,
"offset": 123,
"limit": 123,
"vaults": [
{
"name": "<string>",
"address": "<string>",
"protocol": "<string>",
"denomination": "<string>",
"share_token": "<string>",
"stablecoinish": true,
"id": "<string>",
"chain": "<string>",
"chain_id": 123,
"lifetime_return": "<string>",
"lifetime_return_net": "<string>",
"cagr": "<string>",
"cagr_net": "<string>",
"three_months_returns": "<string>",
"three_months_returns_net": "<string>",
"three_months_cagr": "<string>",
"three_months_cagr_net": "<string>",
"three_months_sharpe": "<string>",
"three_months_sharpe_net": "<string>",
"three_months_volatility": "<string>",
"one_month_returns": "<string>",
"one_month_returns_net": "<string>",
"one_month_cagr": "<string>",
"one_month_cagr_net": "<string>",
"current_nav": "<string>",
"peak_nav": "<string>",
"fee_label": "? / ?",
"management_fee": "<string>",
"performance_fee": "<string>",
"deposit_fee": "<string>",
"withdraw_fee": "<string>",
"years": "<string>",
"event_count": 123,
"features": [
"<string>"
]
}
]
}This endpoint fetches a curated list of DeFi vaults.
from compass_api_sdk import CompassAPI, models
with CompassAPI(
api_key_auth="<YOUR_API_KEY_HERE>",
) as compass_api:
res = compass_api.earn.earn_vaults(order_by="lifetime_return", chain=models.V2EarnVaultsChain.ETHEREUM, direction=models.Direction.DESC, offset=0, limit=50)
# Handle response
print(res){
"total": 123,
"offset": 123,
"limit": 123,
"vaults": [
{
"name": "<string>",
"address": "<string>",
"protocol": "<string>",
"denomination": "<string>",
"share_token": "<string>",
"stablecoinish": true,
"id": "<string>",
"chain": "<string>",
"chain_id": 123,
"lifetime_return": "<string>",
"lifetime_return_net": "<string>",
"cagr": "<string>",
"cagr_net": "<string>",
"three_months_returns": "<string>",
"three_months_returns_net": "<string>",
"three_months_cagr": "<string>",
"three_months_cagr_net": "<string>",
"three_months_sharpe": "<string>",
"three_months_sharpe_net": "<string>",
"three_months_volatility": "<string>",
"one_month_returns": "<string>",
"one_month_returns_net": "<string>",
"one_month_cagr": "<string>",
"one_month_cagr_net": "<string>",
"current_nav": "<string>",
"peak_nav": "<string>",
"fee_label": "? / ?",
"management_fee": "<string>",
"performance_fee": "<string>",
"deposit_fee": "<string>",
"withdraw_fee": "<string>",
"years": "<string>",
"event_count": 123,
"features": [
"<string>"
]
}
]
}The field to order the results by.
The direction to order the results by.
asc, desc The offset of the first item to return.
The number of items to return.
x <= 1000arbitrum, base, ethereum Successful Response
Response model for a paginated list of DeFi vaults.
A list of vault information objects.
Show child attributes
The name of the vault.
The vault contract address.
The DeFi protocol name.
The denomination token symbol (underlying asset).
The vault share token symbol.
Whether the vault is denominated in a stablecoin.
Unique vault identifier.
Blockchain name (e.g., 'ethereum', 'base').
Blockchain chain ID.
Total lifetime return as a decimal (e.g., 0.093 = 9.3%).
Total lifetime return after fees as a decimal.
Compound Annual Growth Rate as a decimal.
Compound Annual Growth Rate after fees as a decimal.
3-month returns as a decimal.
3-month returns after fees as a decimal.
3-month CAGR as a decimal.
3-month CAGR after fees as a decimal.
3-month Sharpe ratio.
3-month Sharpe ratio after fees.
3-month volatility.
1-month returns as a decimal.
1-month returns after fees as a decimal.
1-month CAGR as a decimal.
1-month CAGR after fees as a decimal.
Current Net Asset Value in denomination token.
Peak Net Asset Value in denomination token.
Human-readable fee structure label.
"? / ?"
Management fee as a decimal.
Performance fee as a decimal.
Deposit fee as a decimal.
Withdrawal fee as a decimal.
Age of the vault in years.
Number of events/transactions in the vault.
List of vault features and capabilities.
Was this page helpful?