Public trades

client.marketData reads and streams public spot trade prints, and exposes the raw spot configuration. It uses the public transport, so no authentication is required.

Prices and quantities are decimal strings. Trade timestamps are nanosecond epochs (tsNs), with a millisecond convenience field (tsMs) alongside.

Methods

listTrades(input, options?)

Returns { trades, nextPageToken }, ordered newest-first by execution time. Only symbolId is required.

const { trades } = await client.marketData.listTrades({
	symbolId: 1,
	limit: 100,
	side: "buy",
});

for (const t of trades) {
	console.log(t.tsMs, t.sideLabel, t.price, t.qty);
}

Page through history with the returned token:

let pageToken = "";
do {
	const page = await client.marketData.listTrades({ symbolId: 1, pageToken, limit: 200 });
	console.log(page.trades.length);
	pageToken = page.nextPageToken;
} while (pageToken !== "");

GetMarketTradesInput

getSpotConfig(options?)

Returns the raw SpotConfig snapshot: asset metadata, pair trading constraints, display scales, and market slippage defaults. This is the reference data the catalog is built from.

const config = await client.marketData.getSpotConfig();
console.log(config.assets.length, config.pairs.length);

Most of the time you want the parsed, indexed catalog instead of raw config: reach for getSpotConfig only when you need the untransformed snapshot.

subscribeTrades(input)

Streams live trade prints for one symbol. Returns an idempotent unsubscribe function.

const unsubscribe = client.marketData.subscribeTrades({
	symbolId: 1,
	onEvent: (trade) => console.log(trade.sideLabel, trade.price, trade.qty),
	onError: (ctx) => console.error(ctx.channel, ctx.error),
});

// later
unsubscribe();

onEvent is required. onOpen, onClose, and onError are optional. See the realtime client reference for the handler contract.

The MarketTrade shape

listTrades rows and subscribeTrades events share this shape.

interface MarketTrade {
	symbolId: number;
	matchId: string; // stable print id, also the pagination tie-breaker
	isBuy: boolean; // true when the aggressor bought
	sideLabel: "buy" | "sell";
	qty: string; // decimal string
	price: string; // decimal string
	tsNs: string; // execution time, epoch nanoseconds
	tsMs: number; // same time, epoch milliseconds
}

Related

• Market data guide for the task-oriented walkthrough.
• Streaming guide for the subscription model.
• Catalog reference for the parsed reference data.
• Order book for depth.
• Candles for OHLCV series.

Related Topics