SDK Reference

Installation

For installation instructions use Getting Started with the SDK

SDK references

Javascript

Vault Discovery

getAllVaults(params?)

Get information about all available vaults.

const vaults = await sdk.getAllVaults({
  query: {
    page: 0,
    perPage: 100,
    allowedNetworks: ['mainnet', 'polygon'],
    allowedProtocols: ['aave', 'compound'],
    allowedAssets: ['USDC', 'USDT'],
    minTvl: 1000000,
    maxTvl: 100000000,
    onlyTransactional: true,
    onlyAppFeatured: false
  }
})

getVault(params)

Get detailed information about a specific vault.

const vault = await sdk.getVault({
  path: {
    network: 'mainnet',
    vaultAddress: '0x1234...'
  }
})

getAssets(params)

List all tracked assets across networks.

const assets = await sdk.getAssets({
  query: {
    page: 0,
    perPage: 100
  }
})

Historical Data Methods

getVaultHistoricalData(params)

Get historical APY and TVL data for a vault.

const historicalData = await sdk.getVaultHistoricalData({
  path: {
    network: 'mainnet',
    vaultAddress: '0x1234...'
  },
  query: {
    page: 0,
    perPage: 100,
    apyInterval: '30day',
    fromTimestamp: 1640995200,
    toTimestamp: 1672531200
  }
})

getVaultHistoricalApy(params)

Get historical APY data only (lighter response than full historical data).

const apyHistory = await sdk.getVaultHistoricalApy({
  path: {
    network: 'mainnet',
    vaultAddress: '0x1234...'
  },
  query: {
    page: 0,
    perPage: 100,
    fromTimestamp: 1640995200,
    toTimestamp: 1672531200
  }
})

getVaultHistoricalTvl(params)

Get historical TVL data only.

const tvlHistory = await sdk.getVaultHistoricalTvl({
  path: {
    network: 'mainnet',
    vaultAddress: '0x1234...'
  },
  query: {
    page: 0,
    perPage: 100,
    fromTimestamp: 1640995200,
    toTimestamp: 1672531200
  }
})

getVaultHistoricalSharePrice(params)

Get historical share price data only.

const sharePriceHistory = await sdk.getVaultHistoricalSharePrice({
  path: {
    network: 'mainnet',
    vaultAddress: '0x1234...'
  },
  query: {
    page: 0,
    perPage: 100,
    fromTimestamp: 1640995200,
    toTimestamp: 1672531200
  }
})

Portfolio Methods

getPositions(params)

Get all positions for a user address.

const positions = await sdk.getPositions({
  path: {
    userAddress: '0x1234...'
  },
  query: {
    allowedNetworks: ['mainnet', 'polygon']
  }
})

getPosition(params)

Get a single vault position for a user.

const position = await sdk.getPosition({
  path: {
    userAddress: '0x1234...',
    network: 'mainnet',
    vaultAddress: '0x5678...'
  }
})

getDepositOptions(params)

Get the best deposit options for a user.

const options = await sdk.getDepositOptions({
  path: {
    userAddress: '0x1234...'
  },
  query: {
    allowedNetworks: ['mainnet', 'polygon'],
    allowedAssets: ['USDC', 'USDT'],
    allowedProtocols: ['aave', 'compound'],
    minTvl: 1000000,
    minUsdAssetValueThreshold: 1000,
    onlyTransactional: true,
    onlyAppFeatured: false,
    apyInterval: '7day',
    alwaysReturnAssets: ['USDC'],
    maxVaultsPerAsset: 5
  }
})

getIdleAssets(params)

Get idle assets in a user's wallet that could be earning yield.

const idleAssets = await sdk.getIdleAssets({
  path: {
    userAddress: '0x1234...'
  }
})

getUserVaultTotalReturns(params)

Get total returns for a specific user and vault.

const returns = await sdk.getUserVaultTotalReturns({
  path: {
    userAddress: '0x1234...',
    network: 'mainnet',
    vaultAddress: '0x5678...'
  }
})

getUserVaultEvents(params)

Get events (deposits, withdrawals) for a specific user and vault.

const events = await sdk.getUserVaultEvents({
  path: {
    userAddress: '0x1234...',
    network: 'mainnet',
    vaultAddress: '0x5678...'
  }
})

Transaction Methods

getTransactionsContext(params)

Get transaction context for a specific vault interaction. Returns available steps, token balances, allowances, and deposit limits.

const context = await sdk.getTransactionsContext({
  path: {
    userAddress: '0x1234...',
    network: 'mainnet',
    vaultAddress: '0x5678...'
  }
})

getActions(params)

Generate signed-ready transaction calldata for deposit, redeem, or other vault actions.

const actions = await sdk.getActions({
  path: {
    action: 'deposit',
    userAddress: '0x1234...',
    network: 'mainnet',
    vaultAddress: '0x5678...'
  },
  query: {
    assetAddress: '0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48',
    amount: '1000000'
  }
})

The action parameter accepts: deposit, redeem, request-redeem, claim-redeem, request-deposit, claim-deposit, start-redeem-cooldown.

Rewards Methods

getRewardsTransactionsContext(params)

Get claimable rewards context for a wallet across all networks.

const rewardsContext = await sdk.getRewardsTransactionsContext({
  path: {
    userAddress: '0x1234...'
  }
})

getRewardsClaimActions(params)

Generate transaction calldata to claim pending rewards.

const claimActions = await sdk.getRewardsClaimActions({
  path: {
    userAddress: '0x1234...'
  },
  query: {
    claimIds: ['claim-id-1', 'claim-id-2']
  }
})

Benchmark Methods

getBenchmarks(params)

Get current benchmark rates (USD or ETH) for a network.

const benchmarks = await sdk.getBenchmarks({
  path: {
    network: 'mainnet'
  },
  query: {
    code: 'usd'
  }
})

getHistoricalBenchmarks(params)

Get historical benchmark rates with pagination.

const historicalBenchmarks = await sdk.getHistoricalBenchmarks({
  path: {
    network: 'mainnet'
  },
  query: {
    code: 'usd',
    page: 0,
    perPage: 100,
    fromTimestamp: 1640995200,
    toTimestamp: 1672531200
  }
})

Error Handling

The SDK throws HttpResponseError for API errors:

import { VaultsSdk, HttpResponseError } from '@vaultsfyi/sdk'

try {
  const vault = await sdk.getVault({
    path: {
      network: 'mainnet',
      vaultAddress: 'invalid-address'
    }
  })
} catch (error) {
  if (error instanceof HttpResponseError) {
    console.error('API Error:', error.message)
  }
}

TypeScript Support

This SDK is written in TypeScript and provides full type safety. All API responses are properly typed based on the OpenAPI specification.

// Types are automatically inferred
const vaults = await sdk.getAllVaults() // Type: DetailedVault[]
const vault = await sdk.getVault({ /* ... */ }) // Type: DetailedVault

License

MIT License - see the LICENSE file for details.

Python