Get Started with the Vaults.fyi SDK

The Vaults.fyi SDK gives you typed access to 1,000+ DeFi yield strategies across 80+ protocols. This guide walks you through installation, authentication, and your first API call.

Install the SDK

Add the SDK to your project using your preferred package manager.

npm install @vaultsfyi/sdk

yarn add @vaultsfyi/sdk

pnpm add @vaultsfyi/sdk

bun add @vaultsfyi/sdk

pip install vaultsfyi

poetry add vaultsfyi

Set your API key

Export your API key as an environment variable so the SDK can authenticate your requests.

export VAULTS_FYI_API_KEY="your_api_key_here"

You need an API key to use the SDK. Sign up at the vaults.fyi portal to generate one. We offer a Pay-As-You-Go plan so you only pay for what you use, with no commitments.

Initialize the client

Import the SDK and create a client instance using your API key from the environment.

import pkg from '@vaultsfyi/sdk';
const { VaultsSdk } = pkg;

const vaultsFyi = new VaultsSdk({
  apiKey: process.env.VAULTS_FYI_API_KEY,
});

import os
from vaultsfyi import VaultsSdk

api_key = os.getenv("VAULTS_FYI_API_KEY")
client = VaultsSdk(api_key=api_key)

Make your first call

Call getDepositOptions to fetch personalized yield opportunities for a wallet address. The response is filtered by the assets you specify.

const depositOptions = await vaultsFyi.getDepositOptions({
  path: { userAddress: '0xdB79e7E9e1412457528e40db9fCDBe69f558777d' },
  query: { allowedAssets: ['USDC', 'USDS'] }
});

console.log(depositOptions);

user_address = "0xdB79e7E9e1412457528e40db9fCDBe69f558777d"
deposit_options = client.get_deposit_options(
    user_address,
    allowed_assets=["USDC", "USDS"]
)

print(deposit_options)

getDepositOptions ranks results by APY and filters out vaults below minimum TVL thresholds. It’s the fastest way to surface relevant opportunities for a specific wallet.

Next steps

Now that your client is working, explore the full set of SDK methods or follow a tutorial for your use case.

SDK Reference — every method, parameter, and response type
Wallet integration tutorial — detect idle assets, build deposit flows, and track positions
Data analytics tutorial — fetch vault data, historical APY, and benchmark comparisons

Start Here

Core Concepts

Methodology

SDK

AI & Agents

Plans & Billing

Resources

Get Started with the Vaults.fyi SDK

Next steps

​Next steps

Next steps