Skip to main content

SDK Methods

Complete reference for all ATVClient methods.

ENS / Identity​

getProfile(name)​

Get complete ENS profile.

const profile = await client.getProfile('vitalik.eth');
// Returns: ENSProfile
PropertyTypeDescription
namestringENS name
addressstringEthereum address
avatarstringAvatar URL
recordsobjectText records
expirationstringExpiry date

resolveENS(name)​

Quick address resolution.

const { address } = await client.resolveENS('vitalik.eth');
// Returns: { name: string, address: string }

reverseResolve(address)​

Get primary ENS name for address.

const { name } = await client.reverseResolve('0xd8dA...');
// Returns: { address: string, name: string | null }

batchResolve(names)​

Resolve multiple names at once.

const results = await client.batchResolve(['vitalik.eth', 'nick.eth']);
// Returns: { name: string, address: string }[]

Farcaster / Social​

getFarcasterUser(identifier)​

Get Farcaster profile by FID, username, or address.

const user = await client.getFarcasterUser('dwr.eth');
// Returns: FarcasterUser
PropertyTypeDescription
fidnumberFarcaster ID
usernamestringUsername
displayNamestringDisplay name
biostringProfile bio
followersnumberFollower count
followingnumberFollowing count

getFarcasterCasts(fid, options?)​

Get user's recent casts.

const casts = await client.getFarcasterCasts(3, { limit: 10 });
// Returns: { casts: Cast[], nextCursor?: string }

Prices / Market​

getPrice(symbol)​

Get current price for a token.

const price = await client.getPrice('ETH');
console.log(price.price); // 3245.67
// Returns: PriceData

batchPrices(symbols)​

Get multiple prices at once.

const prices = await client.batchPrices(['ETH', 'BTC', 'USDC']);
// Returns: { [symbol: string]: PriceData }

getSmartPrice(symbol)​

Multi-source aggregated price.

const price = await client.getSmartPrice('ETH');
console.log(price.sources); // Multiple price sources
// Returns: SmartPriceData

getPriceHistory(symbol, options?)​

Historical price data.

const history = await client.getPriceHistory('ETH', { days: 30 });
// Returns: { history: { date: string, price: number }[] }

Authentication​

signIn()​

Authenticate with SIWE for 2x rate limits.

await client.signIn();
console.log(client.isAuthenticated); // true

signOut()​

End authenticated session.

await client.signOut();

sessionStatus()​

Get current session info.

const session = await client.sessionStatus();
// Returns: { address: string, expiresAt: string } | null

Usage & Limits​

getUsage()​

Check remaining free tier calls.

const usage = await client.getUsage();
console.log(usage.remaining); // 73
// Returns: { used: number, limit: number, remaining: number, tier: string }

myUsage()​

Get authenticated user's usage (requires SIWE).

await client.signIn();
const usage = await client.myUsage();
// Returns: detailed usage by wallet

Wallet / Balances​

getBalances(address)​

Get token balances for an address.

const balances = await client.getBalances('0x...');
// Returns: { tokens: TokenBalance[], totalValueUSD: number }

getTransactions(address, options?)​

Get recent transactions.

const txs = await client.getTransactions('0x...', { limit: 20 });
// Returns: { transactions: Transaction[] }

DeFi​

getTVL(protocol)​

Get protocol TVL.

const tvl = await client.getTVL('aave');
// Returns: { protocol: string, tvl: number, change24h: number }

getYields(options?)​

Get yield farming opportunities.

const yields = await client.getYields({ minApy: 5 });
// Returns: { pools: YieldPool[] }

Low-Level​

fetch(endpoint, options?)​

Direct API call with automatic auth/payment.

const data = await client.fetch('/api/custom/endpoint');

payAndRetry(error)​

Manually handle payment for a 402 error.

try {
  await client.getProfile('nick.eth');
} catch (error) {
  if (error.code === 'PAYMENT_REQUIRED') {
    const result = await client.payAndRetry(error);
  }
}