Interface IMarketProfileBuilderConfig

Configuration interface for building a Market Profile.

IMarketProfileBuilderConfig

Default

false
interface IMarketProfileBuilderConfig {
    candleGroupingPeriod: MARKET_PROFILE_PERIODS;
    candles: ICandle[];
    includeProfileDistribution?: boolean;
    pricePrecision: number;
    tickMultiplier: number;
    tickSize: number;
    timezone: string;
}

Properties

candleGroupingPeriod candles includeProfileDistribution? pricePrecision tickMultiplier tickSize timezone

Properties

candleGroupingPeriod

candleGroupingPeriod: MARKET_PROFILE_PERIODS

Group candles into specific timeframe (daily, weekly, monthly).

candles

candles: ICandle[]

An array of candle objects.

Optional includeProfileDistribution

includeProfileDistribution?: boolean

Optional flag to include the full profile distribution data in the returned profiles.

pricePrecision

pricePrecision: number

The number of decimal places to use when rounding prices. This affects the precision of price levels in the resulting market profile.

tickMultiplier

tickMultiplier: number

A multiplier applied to the tick size. This can be used to adjust the scale of the price levels.

tickSize

tickSize: number

The size of each price tick. This determines the granularity of the price levels in the market profile.

timezone

timezone: string

The timezone to use for time-based calculations, e.g., 'Europe/London'. This ensures consistent time handling across different market sessions.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc