Skip to main content

Installation

The package ships with TypeScript declarations and supports both ESM and CommonJS.

Modules

API Client

Client Options

Exit Intelligence Stream Session

Lane Splitting

For high throughput scenarios, split the Exit Intelligence Stream into priority lanes:

Liquidity Snapshots and Partial Sells

Tier 1+ only. Requires a Professional or Advanced subscription. See the announcement for full details.
StreamSession caches the latest liquidity snapshot per position. Query slippage bands, maximum sellable amounts, and liquidity trends:
Use buildPartialSellTx() to sell a portion of a position based on slippage data:

Mirror Trading

Configure watch wallets to mirror trades from other wallets. When a watched wallet opens a position on a supported market, the stream sends a mirror_buy_signal with an unsigned transaction for your wallet to execute.
The watch_wallets array specifies which wallets to mirror. Each entry includes an auto_buy configuration that controls how much to spend when mirroring a trade, and a mirror_sell flag that determines whether to also mirror sell transactions. The mirror_config object sets global limits: max_positions_per_wallet caps concurrent mirrored positions, cooldown_sec enforces a delay between mirror buys, max_active_sol limits total SOL exposure, and buy_slippage_bps sets the slippage tolerance for mirror buy transactions.

Transaction Helpers

Error Handling

Complete Example

See the Quickstart for a full working example that builds, signs, and submits a sell transaction.