Function build

  • build(config): IVolumeProfile[]

  • Calculates the volume profile for a given set of candlestick data based on the specified configuration.

    The function analyses the candlestick data to construct a series of v profiles, each corresponding to a day. It calculates key volume profile elements such as value area, initial balance, and various types of market observations (e.g., failed auctions, excess points, poor highs and lows, etc.).

    Parameters

    • config: IVolumeProfileConfig

      Configuration for how you want to construct the profile. The session (London / Frankfurt / New York), and the tick size.

    Returns IVolumeProfile[]

    List of generated Volume Profiles.

    Each volume profile includes:

    • Value Area: The range of prices where a significant portion of volume occurred.
    • Initial Balance: The price range established during the first hour of trading.
    • Various observations: Failed Auction, Excess, Poor High / low, Single Print.

    Example

    // Assuming 'candles' is an array of ICandle objects representing the price data
    // Create a volume profile with a specified tick size
    const volumeProfile: IVolumeProfile = VolumeProfile.build({ candles, tickSize: 0.5, period: MARKET_PROFILE_PERIODS.DAILY, timezone: 'Europe/London' });

Settings

Member Visibility

Theme

Generated using TypeDoc