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="tvl_usd", direction=models.Direction.DESC, offset=0, limit=50)

    # Handle response
    print(res)
{
  "total": 123,
  "offset": 123,
  "limit": 123,
  "vaults": [
    {
      "vault_address": "<string>",
      "chain": "<string>",
      "owner": "<string>",
      "asset": "<string>",
      "name": "<string>",
      "symbol": "<string>",
      "asset_name": "<string>",
      "asset_symbol": "<string>",
      "tvl_usd": "<string>",
      "apy_7d": "<string>",
      "apy_30d": "<string>",
      "apy_90d": "<string>"
    }
  ]
}

Authorizations

x-api-key
string
header
required

Your Compass API Key. Get your key here.

Query Parameters

order_by
string
default:tvl_usd
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: x <= 1000
chain
enum<string> | null

Optional chain filter. If not provided, returns vaults for all chains. The chain to use.

Available options:
base,
ethereum,
arbitrum
asset_symbol
string | null

Filter vaults by underlying asset symbol (e.g., 'USDC', 'WETH').

Response

Successful Response

Response model for a paginated list of ERC-4626 vaults.

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

A list of vault information objects.