Skip to main content
client.data.misc.getLiveVolume provides real-time volume for a given event. Each entry includes the overall total plus per-market amounts.

Request

const [snapshot] = await client.data.misc.getLiveVolume({ id });

Parameters

NameTypeRequiredNotes
idnumber (≥ 1)Polymarket event ID.

Response

type LiveVolume = {
  total: number;
  markets: Array<{
    market: string;
    value: number;
  }>;
};

Usage example

const [snapshot] = await client.data.misc.getLiveVolume({ id: 35723 });

console.log(`Total volume: ${snapshot.total}`);
snapshot.markets.forEach((entry) => console.log(`${entry.market}: ${entry.value}`));

Failure modes

  • id must be a positive integer.