Every stream channel lives on one connection,
wss://ws.serialized.xyz/v1/stream, and is open to every key. Each pane can also run on its REST column, polled at your own pace, with the same shapes.
Every endpoint page in this doc has an interactive playground. The market endpoints used below (pulse, screener, search, token, stats, candles, trades) run live without a key: open one and hit Send to see the full response next to the code below.
Ground rules
Three conventions carry the whole build:- Auth is one header,
Authorization: YOUR_API_KEY, on every call, and the first frame of the stream. - Every response is
{ data, meta }, camelCase, millisecond timestamps, andnullalways means unknown, never a fabricated zero. - Chains are
evm:<id>(evm:8453for Base,evm:1for Ethereum) orsolana; a token is always(chain, address).
lib/serialized.ts
id:
lib/stream.ts
INVALID_PARAM, NOT_FOUND, RATE_LIMITED, the full catalog), and you are only billed for 2xx responses: your own errors never cost credits. On the stream, a refused subscribe fails that subscription only, never the connection.
The discovery columns
The three launchpad lifecycle columns every terminal opens on are one view each:new (created under 24h), bonding (curves of the last 7 days, sorted by bonding progress), graduated (graduated in the last 14 days). Every launchpad of GET /v1/meta/factories is tracked natively, and EVM and Solana merge in a single view: list the chains you want and the column comes back ranked.
Live: one pulse subscription per column. You receive the full column right after the ack, then a delta each time a token enters, changes or leaves; filters and sorting run on our side.
discovery.ts
GET /v1/pulse call each (view=new|bonding|graduated, chains=evm:8453,solana), to poll every few seconds if you prefer polling.
Each card already carries everything the column renders: identity and metadata (icon on our CDN, socials, dexPaid), live figures over the column window (priceChangePct, volumeUsd, txns, buys, sells), feesUsd, marketCapUsd, liquidityUsd, bondingProgress, migrated, ageSeconds, and the creator wallet with its display name when known. No second call per row.
The trending tab
Discovery beyond launchpads is the market screener: the actively traded markets, ranked.sortBy=trending (the default) weighs 24h activity by real participation, so wash-traded markets sink; sortBy=volume with a window gives you the “top last hour” tab.
Live: one screener subscription. Every token trading above the quality floor on the chains you ask for, filtered and sorted for you on the timeframe you pick, kept up to date like a Pulse column (same messages):
GET /v1/screener serves the most active markets of each chain, paginated, every row with a stats object per window (5m/1h/6h/24h); sortBy=createdAt lists the newest markets.
The search bar
One endpoint handles both things users paste into a terminal: an exact address (token or pool, EVM hex or Solana base58) and free text on name or symbol. Leavechain out and it searches EVM and Solana in parallel, ranked by relevance: the most significant token behind the text comes first, so the search bar is chain-agnostic by default.
The token page
The header
Two calls fill the whole top of the page.GET /v1/token is the snapshot: price (native and USD), market cap, FDV, liquidity, supplies, the token’s main pool, launchpad state (bondingProgress, graduatedAt), deployer, socials and icon, plus stats24h. GET /v1/token/stats adds the windowed row of every terminal header: 5m / 1h / 6h / 24h by default (15m, 30m, 4h and 12h on request), each with volume, buys/sells split and price change, in one call. Or pass windows to GET /v1/token and the snapshot itself ends with the same blocks, in a single call.
token-page.ts
token-updates pushes the mutable fields of /v1/token (price, market cap, liquidity, bonding progress, stats24h) as they change, grouped by updatePeriod (100 ms by default, or "block" for one message per block); ask windows: ['5m', '1h', '6h'] and each state also carries the rolling windows of the stats row. Patch them over the snapshot.
The chart
GET /v1/token/ohlcv serves chart-ready candles from 1s to 1M, up to 2000 per page. Two behaviors matter for a terminal chart:
- The series survives graduation. By default candles follow the pool the token is priced from, with the bonding-curve history stitched in front: a token that migrated from Pump.fun or a Virtuals curve draws one continuous line, no gap at migration, nothing to handle on your side.
- Only traded buckets, connected. Each candle opens at the previous traded close, so a thin token still draws one connected series; pass
fill=truefor a dense axis with a flat zero-volume candle for every quiet bucket.
time is unix seconds, intervals use the same keys (aliases like 1min and 60 are accepted), and paging backwards is endTime plus meta.hasMore:
datafeed.ts
ohlcv pushes the forming candle of the same series (same main pool, same candle shape) as it changes, then each closed candle the moment its bucket rolls over. The first event continues the history you just loaded: replace the candle at data.time with each event.
quote=usd for USD candles: on REST it works on every chain except Story (evm:1514), on the live ohlcv stream on Solana. For a live EVM chart in USD, multiply the streamed native candle by the native USD spot from GET /v1/prices/native, one cached call for all your charts. Native coins (ETH, SOL, BNB…) are charted in USD on every chain.
For the complete TradingView wiring (resolveSymbol, the microcap pricescale trick, live bars, Lightweight Charts), see TradingView Charts.
The tape
GET /v1/token/trades seeds the tape: token-wide by default, newest first, cursor pagination for infinite scroll (meta.nextCursor until hasMore is false). Each row is ready to render (trimmed here):
maker is the wallet actually trading, resolved through relays, solvers and smart accounts, with isProTrader / isSniper badges on every row and isWash on Solana: the tape is attribution-correct out of the box. Filters cover side, trade size, date range and maker lists when you add tape controls.
Live: trades events are the exact tape row above, one per trade as it lands. Prepend, and dedup by id.
The side panels
The due-diligence column is three endpoints, one call each, same shape on EVM and Solana:/v1/token/holders: top holders with share of supply, full PnL, behavioral labels and named entities (the “Coinbase” row), plusmeta.totalHoldersfor the header count./v1/token/top-traders: ranked PnL leaderboard, lifetime or any rolling window from1hto30d, with win rate and dev/sniper/pro badges./v1/token/security: the pre-trade checklist in one shape: mint/freeze authorities, top-10 concentration, dev/sniper/bundler holdings, LP burn/lock, taxes,dexPaid.
/v1/token/pools for the market selector: rank 1 is the exact pool the terminal is pricing from, the next ranks are the markets that would take over from it, each with its own stats. Switching the tape and the chart to one market is pools=<address> on both channels and both REST calls.
The watchlist
Batch twins keep pinned lists at one round-trip per refresh, whatever the size:POST /v1/token serves up to 25 full snapshots per call, billed per 25 tokens, EVM and Solana mixed freely, per-item error slots so one dead token never breaks the list. POST /v1/token/sparklines draws the row charts: up to 100 tokens per call, best pool resolved for you, curve history stitched so freshly graduated tokens draw one continuous line.
token-updates subscription on a tokens list keeps the whole watchlist moving: one message per period carrying every token that changed. Each token counts as one subscription, up to 50 per account by default.
The portfolio tab
GET /v1/wallet/positions is the whole holdings screen in one call: every position with amount, live USD value, average entry, realized + unrealized + total PnL and holdingSince, plus meta.summary for the wallet-level totals at the top. Add includeNative=true&includeStables=true and the SOL/ETH and stablecoin rows are read on-chain at request time, so the total is the real account value.
wallet-portfolio keeps the same rows with their live value, unrealized PnL and share of the portfolio, repriced as the market moves, plus a summary for the totals; wallet-positions is the lighter variant that moves only on the wallet’s own trades. Same snapshot and delta messages as a discovery column.
GET /v1/wallet/pnl draws the performance curve (realized PnL over the window, with win rate: any period up to all, or your own from / to), and /v1/wallet/closed-positions fills the trade-history tab with every completed round trip. Following other wallets (copy-trading, smart money) is the Wallet Tracker guide.
Production patterns
- Reconnect: every event of a single-entity subscription carries a
cursor. On reconnect, subscribe again with"since": "<last cursor you received>": missed trades and closed candles are replayed (up to 5 minutes back), flagged"replay": true, then live; view channels send the deltas you missed, or a fresh snapshot. Beyond that window aREPLAY_TOO_OLDnotice givesdetails.restFromMs: backfill withGET /v1/token/trades?fromAt=(or the candles) from there. The tape never misses or doubles a trade. Details in Reconnect & resume. - Cost control: every subscription accepts
updatePeriod, how often at most it receives a message (you always get the latest state), or"block"for one message per block, and therefore its cost: a longer period never costs more. A live view costs 1 credit per message; the other channels cost 1 credit per element with on-chain activity in each message (Streams billing). The connection itself is free. - Limits: per account, 100 concurrent connections and 200 subscriptions in total across your keys, connections and channels, raised on request;
token-updatesandpool-updatestake up to 50 of them each,ohlcvup to 20. One connection per browser tab is the comfortable pattern; unsubscribe by id as the user leaves a pane, the connection stays.
What a session costs
Credits map one-to-one to the calls above, so a terminal’s burn is easy to model before you ship it:
Only
2xx responses are billed, the watchlist batches bill one call per tranche of tokens, 25 for token details and sparklines (Batches), and every billable response carries X-Credits-Remaining so your backend can watch its own burn. Prices are on Plans, rate limits on Authentication & Limits.
Ship it
You never built the hard parts: trader attribution through relays and solvers, candle continuity across launchpad migrations, a registry of launchpads and their bonding thresholds, wash and sniper detection, USD conversion, icon hosting, server-side views kept live. That is the point: the panes above are the product, the pipeline behind them is ours.Get a key
Create an account, add a card to unlock 100,000 free credits, and create your key in the portal.
Migrate an existing terminal
Endpoint-by-endpoint maps from Mobula, Codex and Birdeye.
Streams reference
Channels, limits, reconnect semantics, billing.
Conventions
Envelope, chain ids, null semantics, timestamps.