Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
Avantis v2 is live as of August 12, 2026. Migrating from v1? Read the migration guide.
Trade history, PnL analytics, and everything the Avantis portfolio page shows.
client.info is the read-only analytics surface. All methods take a trader address explicitly (query any account), return human units, and require no signing key.
trader = client.trade.trader # or any address
history = await client.info.trade_history(trader, page=0, limit=20)
pnl = await client.info.portfolio_pnl(trader)
| Method | Returns |
|---|---|
trade_history(trader, page=0, limit=20) | Fills with full fee breakdown (gross/net PnL, fees, funding) |
order_history(trader, page=0, limit=20) | Order lifecycle history |
recent_trades(pair_index) | Recent market-wide trades for a pair |
| Method | Returns |
|---|---|
portfolio_pnl(trader, grouped=False) | Total profit/loss (grouped=True splits by pair group) |
portfolio_pnl_history(trader, period, date_group="day") | PnL over time |
portfolio_volume(trader, grouped=False) | Total traded size |
win_rate(trader, grouped=False) | Win-rate stats |
total_fees(trader) | Total fees paid |
loss_protection_received(trader) | Loss-protection payouts received |
portfolio_highlights(trader) | Best/worst trade highlights |
leaderboard(trader=None) | Global leaderboard, optionally centered on a trader |
| Method | Returns |
|---|---|
referral_stats(trader) | {asReferrer: {totalFees, totalRebates, totalTraders}, asTrader: {...}} |
referral_count(trader) / referred_fees(trader) | Referral counts and fee volumes |
vault_returns() / vault_share_rate_returns(chart=False) | LP vault APY and share-rate returns |
user_vault_info(vault_type, trader) | A trader’s vault position |
app_status() | API/app status |
ApiError with status 404 rather than crashing the client.client.account.positions(). client.info covers settled history and aggregates.