Birdeye

Birdeye Data Skill

Birdeye is the primary real-time market-data layer for Solana AI agents — natively indexed against on-chain state across 8M+ tokens and 500+ AMM pools with sub-10s freshness.

Overview

Use this skill when users ask about:

• Token prices, charts, or fundamentals (mc, volume, liquidity, holder count)
• New or trending tokens (discovery, meme tokens, new listings)
• On-chain transaction history for a token or pair
• Who's buying/selling a token (top traders, gainers)
• Wallet portfolios, net worth, or P&L tracking
• Token security/rug risk checks
• Real-time price or whale alert streams (WebSocket)
• Pay-per-request without an API key (x402 / agent-native payments)

Instructions

1. Check for MCP: If birdeye-mcp tools are available in the environment, use them directly.
2. Auth: Two modes:
   • API key (default): Base URL https://public-api.birdeye.so, load key from BIRDEYE_API_KEY.
   • x402 pay-per-request (no API key): Base URL https://public-api.birdeye.so/x402, pay USDC per call. Use when agent has a Solana wallet but no API key. See resources/x402.md.
3. Required headers on every REST request:

   X-API-KEY: <key>
   x-chain: solana           ← do NOT put chain in the URL for REST calls
   Accept: application/json
   User-Agent: <anything>    ← defensive — some older HTTP clients hit 403 without one
   

4. Pick the right endpoint using this decision table:

User intent	Endpoint
Token price (current)	GET /defi/price?address=
Token price (multiple)	GET /defi/multi_price?list_address=a,b,c
Chart / OHLCV candles	GET /defi/v3/ohlcv?address=&type=1H&time_from=<unix>&time_to=<unix>
Token fundamentals (mc, vol, holders)	GET /defi/token_overview?address=
Token metadata (name, symbol, logo)	GET /defi/v3/token/meta-data/single?address=
Rug / honeypot check	GET /defi/token_security?address=
New listings	GET /defi/v2/tokens/new_listing?limit=20
Trending tokens	GET /defi/token_trending?sort_by=rank&sort_type=asc&limit=20
Meme tokens	GET /defi/v3/token/meme/list?sort_by=liquidity&sort_type=desc&limit=20 ← pass sort_by+sort_type together
Search tokens or pairs	GET /defi/v3/search?keyword=&chain=solana&target=token&sort_by=liquidity&sort_type=desc
Liquidity pools for a token	GET /defi/v2/markets?address=&time_frame=24h&sort_by=liquidity&sort_type=desc
Pair stats	GET /defi/v3/pair/overview/single?address=<PAIR>
Token trade history	GET /defi/v3/token/txs?address=&tx_type=swap&limit=50
Top traders for a token	GET /defi/v2/tokens/top_traders?address=&time_frame=24h&sort_by=volume&sort_type=desc
Best on-chain traders	GET /trader/gainers-losers?type=today&sort_by=PnL&sort_type=desc
Token holder list	GET /defi/v3/token/holder?address=&limit=100
Holder concentration	GET /holder/v1/distribution?token_address= ← note: token_address param
Wallet balance / net worth	GET /wallet/v2/current-net-worth?wallet=&sort_type=desc ← sort_type required
Wallet P&L	GET /wallet/v2/pnl/summary?wallet= ← PRO tier only
Wallet transaction history	GET /v1/wallet/tx_list?wallet=&limit=50
Real-time price stream	WebSocket SUBSCRIBE_PRICE ← Business tier+
Whale alerts	WebSocket SUBSCRIBE_LARGE_TRADE_TXS ← Business tier+

5. Rate limits by tier (per-account): Standard 1 rps · Lite/Starter 15 rps · Premium 50 rps (1000 rpm) · Business 100 rps (1500 rpm). The Wallet API group (/v1/wallet/token_list, /v1/wallet/token_balance, /v1/wallet/tx_list, /v1/wallet/list_supported_chain, /v1/wallet/simulate, and their multichain variants) carries a stricter 30 rpm cap per Birdeye docs — enforcement may vary by plan, so handle 429s with backoff rather than assuming a hard ceiling. V2 wallet endpoints (/wallet/v2/*) follow the per-account tier limit. Token List Scroll: 1 call / 30 s per account.
6. WebSocket (Business tier+): wss://public-api.birdeye.so/socket/{chain}?x-api-key=KEY — chain in URL path, NOT header. Required Origin: ws://public-api.birdeye.so header, plus echo-protocol passed as the subprotocol argument (new WebSocket(url, 'echo-protocol', { headers: { Origin: ... } })) — not as a raw Sec-WebSocket-Protocol header.
7. Need full param list for an endpoint? → Read resources/api-reference.md
8. Don't know which endpoint to use? → Read resources/intent-index.md (keyword → endpoint)
9. Need pagination (offset / cursor / time-based)? → Read resources/pagination.md
10. Need chain support per endpoint? → Read resources/supported-networks.md
11. Need WebSocket setup? → Read resources/websocket.md
12. Need x402 pay-per-request? → Read resources/x402.md, then use examples/x402/pay-per-request.ts
13. Need a working code example? → Read the matching file in examples/ (see Skill Structure below)

Examples

import BirdeyeClient from './templates/birdeye-client';
const client = BirdeyeClient.create('solana'); // reads BIRDEYE_API_KEY

Token Overview

User: "What's the market cap and liquidity of [Token]?"

const data = await client.token.getOverview(address);
// data.price, data.marketCap, data.fdv, data.liquidity, data.v24hUSD, data.holder
// data.priceChange1hPercent, data.priceChange24hPercent
// NOTE: 24h volume field is `v24hUSD` (USD) / `v24h` (token units) — NOT `volume24h`

OHLCV Chart

User: "Show me the 1h chart for SOL"

const now = Math.floor(Date.now() / 1000);
const data = await client.price.getOHLCV(WSOL, '1H', now - 86400, now);
// data.items[].unix_time (V3 = snake_case — NOT unixTime, which is only on the V1 /defi/ohlcv endpoint)
// data.items[].o .h .l .c .v  +  data.items[].v_usd (V3 only)
// NOTE: time_from and time_to are required — omitting them causes empty response

Wallet P&L (PRO)

User: "Analyze profit/loss for wallet X"

const data = await client.wallet.getPnL(walletAddress);
// data.summary.pnl.realized_profit_usd
// data.summary.counts.win_rate, .total_trade
// data.summary.cashflow_usd.total_invested
// ⚠️ PRO tier only — returns 403 on Standard/Lite

Token Security Check

User: "Is this token safe? [address]"

const data = await client.token.getSecurity(address);
// data.creatorPercentage > 0.20 → high rug risk
// data.freezeable || data.freezeAuthority → freeze risk (tokens can be frozen)
// data.transferFeeEnable === true → transfer tax on every move
// data.top10HolderPercent > 0.5 → concentration risk
// Mint authority: the field is `isMintable` (not `mintable`). Often null on
// established tokens; treat non-null truthy values as active mint authority.

Wallet Portfolio

User: "Show portfolio for wallet X"

const data = await client.wallet.getNetWorth(wallet);

// ⚠️ ACTUAL FIELD NAMES (snake_case, not camelCase):
//   data.total_value  → string  (NOT totalUsd)
//   item.amount       → number  (token balance — NOT balance)
//   item.value        → string  (USD value — NOT valueUsd) — coerce: Number(item.value)
//   item.price        → number  (NOT priceUsd)

const total = Number(data.total_value ?? 0);   // total_value, not totalUsd
console.log(`Total: $${total.toFixed(2)}`);

for (const item of data.items ?? []) {
    const bal = item.amount;                    // amount is already a number
    const val = Number(item.value ?? 0);        // value is a string — coerce
    const pct = total > 0 ? ((val / total) * 100).toFixed(1) : '0.0';
    console.log(`${item.symbol}: ${bal.toFixed(4)} = $${val.toFixed(2)} (${pct}%)`);
}

Wallet Transaction History

User: "Show recent swaps for wallet X"

const data = await client.wallet.getTxHistory(wallet, 50);

// ⚠️ RESPONSE WRAPPER is keyed by chain — NOT `{ items: [...] }`:
//   data.solana  → array of Solana txs (use `data.ethereum` on Ethereum, etc.)

// ⚠️ FIELD SHAPES on /v1/wallet/tx_list:
//   tx.blockTime  → ISO string "2026-04-13T06:10:38+00:00"  (NOT a unix number)
//   tx.from / to  → plain wallet address string              (NOT objects with .symbol)
//   token info    → tx.balanceChange[].symbol / .amount

const txs = data.solana ?? [];
for (const tx of txs) {
    // Parse time correctly — blockTime is ISO string, NOT unix
    const when = new Date(tx.blockTime).getTime();           // ✅
    // const when = tx.blockTime * 1000;                     // ❌ NaN

    // Token symbols come from balanceChange[], not from/to
    const received = tx.balanceChange
        .filter((b) => b.amount > 0)
        .map((b) => `+${b.amount.toFixed(4)} ${b.symbol}`)
        .join(', ');
    console.log(new Date(when).toISOString(), received);
}

Guidelines

• DO use correct field names from /wallet/v2/current-net-worth — API returns data.total_value (string), item.amount (number), item.value (string), item.price (number). Using camelCase aliases (totalUsd, balance, valueUsd) returns undefined.
• DO coerce item.value and data.total_value with Number() before arithmetic — they are strings. item.amount is already a number.
• DO parse tx.blockTime from /v1/wallet/tx_list with new Date(tx.blockTime) — it is an ISO string, not a unix timestamp. Using tx.blockTime * 1000 produces NaN.
• DO read token symbols from tx.balanceChange[].symbol — tx.from and tx.to are plain wallet address strings, not objects with .symbol.
• DO set x-chain: solana header for REST calls (chain goes in the URL path only for WebSocket).
• DO use /defi/multi_price for batch price checks — never loop /defi/price.
• DO use token_address= (not address=) for /holder/v1/distribution.
• DON'T pass type=gainers or type=losers to /trader/gainers-losers — they cause 400. Use type=today, type=yesterday, or type=1W.
• DON'T omit sort_by/sort_type from /defi/v2/markets, /defi/v3/search, /trader/gainers-losers — required on these endpoints.
• DO pass sort_by and sort_type together to /defi/v3/token/meme/list — official docs mark both required. Common valid sort_by values: liquidity, volume_24h_usd, market_cap, fdv, recent_listing_time, volume_24h_change_percent, progress_percent, holder, price_change_24h_percent, trade_24h_count. See the official docs for the full enum.
• DON'T use v24hUSD or volume24h as sort_by for /defi/v3/token/list — valid values: liquidity, fdv, market_cap, holder.
• DON'T pound Wallet V1 group endpoints (portfolio, tx list, token balance) — docs cite a 30 rpm cap; enforcement may vary by plan, so pace calls and handle 429 with backoff.
• DON'T call /defi/v3/token/list/scroll more than once per 30 seconds per account — it has a uniquely low rate limit.
• DON'T expose X-API-KEY in agent responses.
• DON'T call PRO-only endpoints (/wallet/v2/pnl/*, /smart-money/*) without confirming tier.

Common Errors

403 Forbidden

Cause: Rarely, a missing or bot-flagged User-Agent on certain HTTP clients, OR endpoint requires a higher plan tier. Fix: Set any User-Agent defensively. For PRO-gated endpoints (/wallet/v2/pnl/*, some Smart Money), upgrade your plan at bds.birdeye.so.

401 Unauthorized

Cause: Missing or invalid X-API-KEY. Fix: Load from process.env.BIRDEYE_API_KEY.

404 Not Found

Cause: Token doesn't exist on the specified chain. Fix: Verify address and x-chain header value.

429 Too Many Requests

Cause: Rate limit exceeded. Per-account limit varies by tier: Standard 1 rps, Lite/Starter 15 rps, Premium 50 rps (1000 rpm), Business 100 rps (1500 rpm). The Wallet API group (V1 wallet endpoints) has a documented 30 rpm cap — exact behavior may vary by plan. Fix: Exponential backoff (1s → 2s → 4s → 8s → 16s cap). For wallet endpoints, start with ≥2 s spacing and widen on 429.

400 on /holder/v1/distribution

Cause: Passed address= instead of token_address=. Fix: Use ?token_address=<address>.

Skill Structure

birdeye/
├── SKILL.md                              # This file — agent instructions & quick reference
├── docs/
│   └── troubleshooting.md               # Common errors, root causes, and fixes
├── resources/
│   ├── api-reference.md                 # Complete endpoint table with all params
│   ├── error-handling.md                # HTTP codes, retry pattern, rate limit table
│   ├── intent-index.md                  # Keyword → endpoint fast lookup for agents
│   ├── pagination.md                    # Offset, scroll, time-based, cursor patterns
│   ├── supported-networks.md            # x-chain values and per-endpoint chain support
│   └── websocket.md                     # WebSocket connection, channels, heartbeat
├── examples/
│   ├── holder-data/
│   │   └── holder-distribution.ts       # Top holders + concentration analysis
│   ├── market-data/
│   │   ├── meme-tokens.ts               # Meme leaderboard + security enrichment
│   │   ├── new-listings.ts              # New token listings
│   │   ├── ohlcv-chart.ts               # OHLCV candle data
│   │   └── trending-tokens.ts           # Trending tokens by rank
│   ├── pair-data/
│   │   └── pair-overview.ts             # Pair/pool stats
│   ├── price-ohlcv/
│   │   └── price-and-ohlcv.ts          # Price + chart in one flow
│   ├── token-data/
│   │   ├── token-overview.ts            # Full token fundamentals
│   │   └── token-security.ts            # Rug / honeypot check
│   ├── trader-intelligence/
│   │   ├── gainers-losers.ts            # Top on-chain traders by P&L
│   │   ├── smart-money.ts               # Smart money accumulation/distribution (PRO)
│   │   └── top-traders.ts               # Top traders per token
│   ├── transactions/
│   │   └── token-trades.ts              # Token trade history
│   ├── wallet-intelligence/
│   │   ├── wallet-pnl.ts                # Wallet P&L analysis (PRO)
│   │   ├── wallet-portfolio.ts          # Net worth + token balances
│   │   └── wallet-tx-history.ts         # Transaction history with swap detection
│   ├── websocket/
│   │   ├── live-price-stream.ts         # Real-time price via SUBSCRIBE_PRICE
│   │   └── whale-alert.ts               # Whale trades via SUBSCRIBE_LARGE_TRADE_TXS
│   └── x402/
│       └── pay-per-request.ts           # Pay-per-request with USDC (no API key)
└── templates/
    └── birdeye-client.ts                # Production-ready TypeScript client with sub-clients

External docs (for humans)

• Birdeye API Reference
• Birdeye x402 docs
• Data Accessibility by Package Tier
• Birdeye Developer Portal (API Keys)