Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.vaults.fyi/llms.txt

Use this file to discover all available pages before exploring further.

​
Base URL

https://api.vaults.fyi/v2

​
Authentication

Every request must include your API key as a header: 
x-api-key: YOUR_API_KEY
All API keys have access to all endpoints. Keys are rate-limited to 10 requests per minute by default — contact support to increase your limit.

​
Networks

The API tracks vaults across 20+ EVM-compatible networks. Networks can be identified by name or CAIP-2 identifier:
NameChain IDCAIP-2
mainnet1eip155:1
arbitrum42161eip155:42161
base8453eip155:8453
optimism10eip155:10
polygon137eip155:137
gnosis100eip155:100
unichain130eip155:130
bsc56eip155:56
avalanche43114eip155:43114
hyperliquid999eip155:999
plasma9745eip155:9745
monad143eip155:143
berachain80094eip155:80094
Use GET /v2/networks for the complete current list.

​
APY values

All APY fields are raw decimals. Multiply by 100 to display as a percentage: 
// API returns: 0.0543
// Display as:  5.43%
const displayApy = (rawApy * 100).toFixed(2) + '%';

​
Pagination

All list endpoints use offset pagination with page (zero-indexed) and perPage: 
GET /v2/detailed-vaults?page=0&perPage=50   # first page
GET /v2/detailed-vaults?page=1&perPage=50   # second page
The response includes nextPage — it is null when you are on the last page.

​
Error responses

StatusMeaning
400Invalid parameters
401Missing or invalid API key
403API key has exhausted available credits
404Resource not found
429Rate limit exceeded
500Internal server error
503Service temporarily unavailable
Error bodies follow this shape: 
{
  "error": "Internal Server Error",
  "message": "Descriptive error message",
  "errorId": "abc-123"
}

​
Quick start

Fetch the top 5 USDC vaults by 7-day APY on Ethereum mainnet: 
curl -H "x-api-key: YOUR_API_KEY" \
  "https://api.vaults.fyi/v2/detailed-vaults\
?allowedAssets=USDC\
&allowedNetworks=mainnet\
&minTvl=1000000\
&sortBy=apy7day\
&sortOrder=desc\
&perPage=5"
Check a user’s idle assets and suggest vaults to deposit into: 
# Step 1 — find idle assets
curl -H "x-api-key: YOUR_API_KEY" \
  "https://api.vaults.fyi/v2/portfolio/idle-assets/0xYourWallet"

# Step 2 — get ranked deposit suggestions
curl -H "x-api-key: YOUR_API_KEY" \
  "https://api.vaults.fyi/v2/portfolio/best-deposit-options/0xYourWallet\
?onlyTransactional=true&maxVaultsPerAsset=3"