Discover Top-Performing Vaults

Find vaults that fit your product, compare their performance, and decide what to offer users.

Initialize

import { GauntletClient } from '@gauntlet-xyz/sdk'
import { createPublicClient, http } from 'viem'
import { base } from 'viem/chains'

const client = new GauntletClient({
  evmClients: {
    [base.id]: createPublicClient({ chain: base, transport: http(process.env.RPC_URL_BASE!) }),
  },
})

const API_BASE_URL = 'https://api.gauntlet.xyz'
const API_KEY = process.env.GAUNTLET_API_KEY!

async function apiGet(path: string) {
  const resp = await fetch(`${API_BASE_URL}${path}`, {
    headers: { Authorization: `Bearer ${API_KEY}` },
  })
  if (!resp.ok) throw new Error(`${resp.status} ${resp.statusText}`)
  return resp.json()
}

List and Filter Vaults

import { getVaults } from '@gauntlet-xyz/sdk/evm'

const candidates = await getVaults(client, { chainId: base.id })
// returns:
// [
//   {
//     vaultId: "gtusda",         // SDK manifest slug — short identifier used by SDK methods
//     name: "gtUSDa",
//     protocol: "aera",
//     strategy: "...",
//     deployments: [
//       {
//         chain: "evm",
//         chainId: 8453,
//         vaultAddress: "0x...",
//         vaultType: "multi-depositor",
//         depositMode: "async",
//         supplyToken: [{ symbol: "USDC", address: "0x...", decimals: 6 }]
//       }
//     ]
//   },
//   ...
// ]

const { data: vaults } = await apiGet(
  '/v1/vaults?chain=base&strategy=lending&risk_tier=prime&limit=50'
)
// returns:
// [
//   {
//     name: "gtUSDa",
//     metrics: {
//       apy_net: "8.2",
//       tvl_usd: "45000000"
//     }
//   },
//   ...
// ]

The SDK getVaults function reads from the bundled vault manifest — no network request. For live metrics such as APY and TVL, use the API.

Get Vault Detail — gtUSDa

The API identifies vaults by a chain_id:address string (e.g. gtUSDa on Base is 8453:0x000000000001cdb57e58fa75fe420a0f4d6640d5). Use a deployment’s chain ID and vault address from /v1/vaults or the SDK manifest.

API

const GTUSDA_BASE = '8453:0x000000000001cdb57e58fa75fe420a0f4d6640d5'

const [{ data: detail }, { data: latest }] = await Promise.all([
  apiGet(`/v1/vaults/${GTUSDA_BASE}`),
  apiGet(`/v1/vaults/${GTUSDA_BASE}/latest`),
])
// detail → {
//   name: "gtUSDa",
//   deployments: [
//     { chain: "base", address: "0x000000000001CdB57E58Fa75Fe420a0f4D6640D5" }
//   ]
// }
// latest → {
//   metrics: {
//     apy: { value: "8.2" },
//     tvl_usd: { value: "45000000" },
//     share_price: { value: "1.032" }
//   }
// }

Chart Historical Performance

For gtUSDa’s total TVL, request history by slug. This sums USD TVL across linked deployments; querying only its Base deployment omits the other chains.

API

const { data: points, meta } = await apiGet(
  '/v1/vaults/slug/gtusda/timeseries?granularity=day&start=2026-09-17&end=2026-09-18'
)
// TVL fields shown below (other metrics omitted; illustrative values):
// [
//   { timestamp: "2026-09-17T00:00:00Z", tvl: { usd: "57611266.15" } },
//   { timestamp: "2026-09-18T00:00:00Z", tvl: { usd: "52184730.68" } },
// ]
// Follow meta.next_cursor, when present, to read the rest of the window.

Render tvl.usd: null as a gap. It means a deployment’s snapshot or USD price is missing; treating it as zero or omitting it could misrepresent a withdrawal. The same response also includes aggregate share supply, with APY and share price from the selected primary deployment. Request primary history separately when TVL and supply should also be limited to that deployment:

SDK

const { data: primaryPoints, meta } = await client.api.primaryVaultTimeseriesBySlug(
  'gtusda', { granularity: 'day', start: '2026-09-17', end: '2026-09-18' }
)
// primaryPoints expose apy_7d, apy_30d, apy_90d, unit_price, total_supply,
// and this deployment's tvl. meta.resolved_vault_id identifies the deployment.

const { data: vaultHistory } = await client.api.vaultTimeseriesBySlug(
  'gtusda', { granularity: 'day', start: '2026-09-17', end: '2026-09-18' }
)
// vaultHistory includes aggregate tvl.usd and total_supply plus primary APY and unit_price.

What’s Next

Once you’ve picked gtUSDa (or another vault), move to the deposit flow.

Deposit Your First Dollar

Use the SDK to deposit 1,000 USDC into gtUSDa on Base.

Vault API Reference

Full vault listing, detail, metrics, timeseries, and events endpoints.

Onboarding

Integrate

SDK

Attribution

API

Agents

Contracts

Discover Top-Performing Vaults

Initialize

List and Filter Vaults

Get Vault Detail — gtUSDa

Chart Historical Performance

What’s Next

Deposit Your First Dollar

Vault API Reference

​Initialize

​List and Filter Vaults

​Get Vault Detail — gtUSDa

​Chart Historical Performance

​What’s Next

Deposit Your First Dollar

Vault API Reference

Initialize

List and Filter Vaults

Get Vault Detail — gtUSDa

Chart Historical Performance

What’s Next