Skip to main content
GET
/
v2
/
earn
/
vaults
Python (SDK)
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": "Morpho Gauntlet USDC Prime Compounder",
      "address": "0x694e47afd14a64661a04eee674fb331bcdef3737",
      "protocol": "<unknown ERC-4626>",
      "denomination": "USDC",
      "share_token": "ysUSDC",
      "lifetime_return": "<string>",
      "cagr": "<string>",
      "three_months_cagr": "<string>",
      "three_months_sharpe": "<string>",
      "three_months_volatility": "<string>",
      "current_nav": "<string>",
      "peak_nav": "<string>",
      "stablecoinish": true,
      "fee_label": "? / ?",
      "management_fee": "<string>",
      "performance_fee": "<string>",
      "start_date": "2023-11-07T05:31:56Z",
      "last_updated_at": "2023-11-07T05:31:56Z"
    }
  ]
}

Authorizations

x-api-key
string
header
required

Your Compass API Key. Get your key here.

Query Parameters

order_by
string
default:lifetime_return
required

The field to order the results by.

direction
enum<string>
default:desc

The direction to order the results by.

Available options:
asc,
desc
offset
integer
default:0

The offset of the first item to return.

limit
integer
default:50

The number of items to return.

Required range: 0 < x <= 1000
chain
enum<string>
default:ethereum
required
Available options:
arbitrum,
base,
ethereum

Response

Successful Response

Response model for a paginated list of DeFi vaults.

total
integer
required
offset
integer
required
limit
integer
required
vaults
VaultInfo · object[]
required

A list of vault information objects.