Interface VolumeProfile

Horizontal volume distribution over a price range, plus the derived Point-of-Control and Value-Area summary.

interface VolumeProfile {
    bins: VolumeBin[];
    pocIndex: number;
    totalVolume: number;
    valueAreaHigh: number;
    valueAreaLow: number;
}

Properties

Bins ordered low→high price. Length is the requested bins (≥ 1).

pocIndex: number

Index into bins of the Point of Control — the single bin with the most volume. -1 only when there is no volume at all (every bin empty).

totalVolume: number

Sum of all bin volumes (finite candle volume that fell inside the range).

valueAreaHigh: number

Upper price edge of the value area (the priceHigh of its highest bin).

valueAreaLow: number

Lower price edge of the value area (the priceLow of its lowest bin).