Skip to main content
GET
Python (SDK)

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,
hyperevm,
tempo,
bsc,
ethereum_sepolia
asset_symbol
string | null

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

min_tvl_usd

Minimum TVL in USD. Vaults with TVL below this value will be excluded.

min_liquidity_usd

Minimum available liquidity in USD. Vaults below this are excluded.

min_deposit_cap_usd

Minimum deposit capacity in USD. Vaults below this are excluded. Set to 0 to exclude paused vaults.

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.

Example: