Skip to main content

Footprint

type Footprint = {
  id: string;
  price?: number;
  side: FootprintSide;
  timeMs: number;
};

Source: types/src/index.ts:947

A single filled trade, drawn as a circular badge above the candle it fell in — the "footprint" a trader leaves on the chart: buy marks an entry (a + badge in the bull color), sell marks an exit (a − badge in the bear color).

timeMs is the raw execution time, not a bar-open time. The chart buckets each footprint into whichever candle's window contains it, so the same array renders correctly at every interval — switch from 1m to 1h and the badges re-group onto the wider bars on their own.

At most two badges render per candle: one for that bar's buys and one for its sells, however many trades went into each. Hovering (or tapping) a badge hands every footprint on that candle back through onFootprint, so a bar holding twenty fills still shows one badge and still reports all twenty.

Properties​

id​

id: string;

Source: types/src/index.ts:949

Stable unique id, echoed back in onFootprint.

price?​

optional price?: number;

Source: types/src/index.ts:958

Execution price. Ignored by the renderer (badges sit above the bar, not at the fill), and carried through to onFootprint for your own UI.

side​

side: FootprintSide;

Source: types/src/index.ts:953

Entry ('buy') or exit ('sell') — picks the badge color and glyph.

timeMs​

timeMs: number;

Source: types/src/index.ts:951

Execution time as Unix epoch milliseconds, unsnapped.