The API is large. This page maps common tasks to the SDK method that does the job and the recipe that walks through it. Every method shown is a method on the TypeScript SDK client (called as client.namespace.method(...)) and maps to a REST endpoint in the API Reference. Reach for the recipe when there is one, the SDK method when there is not.
New here? Start with Fetching all data for pagination, then jump to the section below that matches what you are building. Search and discovery
| I want to… | SDK method | Recipe |
|---|
| Search events, markets, traders, and builders | search.search | Adding search |
| Look up a wallet by address | search.search (type: "traders") | Adding search |
| Find markets that just moved | markets.getPriceJumps | Finding market movers |
| See platform-wide momentum | analytics.getChanges | Finding market movers |
Markets and prices
| I want to… | SDK method | Recipe |
|---|
| List or filter markets | markets.getMarkets | |
| Get one market | markets.getMarket, markets.getMarketBySlug | |
| Price candlesticks for a market or position | markets.getCandlestick, markets.getPositionCandlestick | TradingView charts |
| A market’s volume over time | markets.getMarketVolumeChart | |
| Recent trades for a market | markets.getTrades | Copy trading |
| Top traders in a market or position | markets.getMarketTopTraders, markets.getPositionTopTraders | |
| Oracle / resolution events | markets.getOracleEvents | |
| Crypto Up/Down price feed | assets.getAssetCandlestick, assets.getAssetHistory | Crypto Up/Down feed |
Events and series
| I want to… | SDK method | Recipe |
|---|
| List or filter events | events.getEvents | Trending events and markets |
| Get one event and its markets | events.getEvent, events.getEventBySlug, events.getEventOutcomes | |
| Event price chart and metrics | events.getEventChart, events.getEventMetrics | |
| Work with recurring series | series.getSeriesList, series.getSeriesEvents, series.getSeriesOutcomes | |
| Browse markets by tag or category | tags.getTags, tags.getTag | |
| Find category leaders | tags.getCategoryTopTraders | |
Traders and PnL
| I want to… | SDK method | Recipe |
|---|
| A trader’s open and closed positions | trader.getTraderOutcomePnl | Open and closed positions |
| Global / market / category PnL for a wallet | trader.getGlobalPnl, trader.getTraderMarketPnl, trader.getTraderCategoryPnl | Live PnL dashboard |
| PnL candlesticks and daily heatmap | trader.getTraderPnlCandles, trader.getTraderPnlCalendar | PnL history charts |
| Best/worst periods and drawdown | trader.getTraderPnlPeriods, trader.getTraderPnlRisk | PnL history charts |
| A wallet’s biggest wins and losses | trader.getTopTradesMarkets | PnL history charts |
| Position exits (win/loss markers) | trader.getTraderPnlExits | PnL chart with exit markers |
| Enrich wallets with profiles | trader.getTraderProfile, trader.getTraderProfilesBatch | |
| A trader’s trades or volume | trader.getTraderTrades, trader.getTraderVolumeChart | |
Holders
| I want to… | SDK method | Recipe |
|---|
| Current holders of a market or position | holders.getMarketHolders, holders.getPositionHolders | |
| Holder count history | holders.getMarketHoldersHistory, holders.getPositionHoldersHistory, holders.getEventHoldersHistory | Holder metrics tracking |
Order book and liquidity
| I want to… | SDK method | Recipe |
|---|
| Current order book | orderBook.getOrderBook, orderBook.getMarketOrderBook | CLOB liquidity dashboard |
| Order book or spread history | orderBook.getOrderBookHistory, orderBook.getSpreadHistory | |
| Bond zone (close-to-bond) markets | bonds.getBonds | Bond zone alerts |
Builders and attribution
| I want to… | SDK method | Recipe |
|---|
| Trades routed via a builder code | markets.getTrades (builder_codes) | Trades by builder code |
| Builder fee revenue over time | builders.getBuilderTimeseries, builders.getBuilderFees | Builder revenue dashboard |
| Your top traders and retention | builders.getBuilderTopTraders, builders.getBuilderRetention | Builder revenue dashboard |
| Volume concentration | builders.getBuilderConcentration | Builder revenue dashboard |
| Rank and search builders | builders.getBuilders, builders.searchBuilders | |
| I want to… | SDK method | Recipe |
|---|
| Platform-wide percentage changes | analytics.getChanges | Finding market movers |
| Activity buckets over time | analytics.getDeltas, analytics.getTimeseries | Finding market movers |
| Per-entity time series | analytics.getMarketTimeseries, analytics.getEventTimeseries, analytics.getTraderTimeseries, analytics.getTagTimeseries | |
Realtime
For push instead of polling, every domain above has a websocket and webhook counterpart.
| I want to… | Where |
|---|
| Stream raw data (trades, prices, PnL, positions, holders) | Websocket rooms |
| Receive event notifications over a socket | Alerts |
| Receive event notifications over HTTP | Webhooks |
| Manage webhook subscriptions | webhooks.create, webhooks.list, webhooks.update, webhooks.test |
Last modified on June 13, 2026
