API client

The ApiClient provides access to off-chain data from the Yo REST API (https://api.yo.xyz).

Usage via YoClient

The YoClient creates an ApiClient internally:

const client = createYoClient({ chainId: 8453 })

const snapshot = await client.getVaultSnapshot(vaultAddress)
const yieldHistory = await client.getVaultYieldHistory(vaultAddress)
const tvlHistory = await client.getVaultTvlHistory(vaultAddress)
const userHistory = await client.getUserHistory(vaultAddress, userAddress, 50)
const points = await client.getUserPoints(userAddress)

Standalone Usage

import { createApiClient } from '@yo-protocol/core'

const api = createApiClient()
// or with custom base URL:
const api = createApiClient({ baseUrl: 'https://custom-api.example.com' })

Pending Redemptions

Query pending async redemptions for a user or an entire vault.

// User-specific pending redemptions
const pending = await client.getPendingRedemptions(vaultAddress, userAddress)
console.log(pending.assets?.formatted)  // e.g. "100.50"
console.log(pending.shares?.formatted)  // e.g. "95.20"

// Vault-level pending redeems
const vaultPending = await client.getVaultPendingRedeems(vaultAddress)

PendingRedeem

Field	Type	Description
assets	FormattedValue | undefined	Pending asset amount
shares	FormattedValue | undefined	Pending share amount

Response Types

VaultSnapshot

Field	Type	Description
address	string	Vault address
name	string	Vault name
symbol	string	Vault symbol
tvl	FormattedValue	Total value locked
apy	number	Current APY percentage
underlying	object	Underlying token info
pools	Pool[]	Optional pool allocations

TimeseriesPoint

Field	Type	Description
timestamp	number	Unix timestamp
value	number	APY or TVL value

UserHistoryItem

Field	Type	Description
type	'deposit' | 'withdraw' | 'redeem'	Transaction type
timestamp	number	Unix timestamp
assets	FormattedValue	Asset amount
shares	FormattedValue	Share amount
txHash	string	Transaction hash

Error Handling

API errors throw ApiError with a statusCode property:

import { ApiError } from '@yo-protocol/core'

try {
  await client.getVaultSnapshot(address)
} catch (err) {
  if (err instanceof ApiError) {
    console.error(err.statusCode, err.message)
  }
}