Quickstart

1. The simplest way to start using Vaults API is to install an SDK package.

Javascript

Using npm

npm install @vaultsfyi/sdk

Using Yarn

yarn add @vaultsfyi/sdk

Using pnpm

pnpm add @vaultsfyi/sdk

Using Bun

bun add @vaultsfyi/sdk

Using jspm

jspm install @vaultsfyi/sdk

Python

Using PIP

pip install vaultsfyi

Using Poetry

poetry add vaultsfyi

To start tinkering you ned to obtain an API key, the fastest way is to fill this form https://forms.fillout.com/t/tLA9t6HyAFus

1. Set your API key as an environment variable

export VAULTS_FYI_API_KEY="your_api_key_here"

1. Initialize the SDK

Javascript

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

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

Python

from vaultsfyi import VaultsSdk

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

1. To take it for a spin, use one of the SDK functions: getDepositOptions to get best DeFi opportunities for a specific blockchain address

Javascript

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

Python

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

For more detailed example implementation check out our lightning tutorials (<5 mins!)

Wallet Integration

Data Analytics