@pond-ts/financial API Reference
    Preparing search index...

    Interface HistoricalVolatilityOptions<S, Output>

    interface HistoricalVolatilityOptions<
        S extends SeriesSchema,
        Output extends string,
    > {
        annualize?: number;
        column?: NumericColumnNameForSchema<S>;
        output?: Output;
        period?: number;
    }

    Type Parameters

    • S extends SeriesSchema
    • Output extends string
    Index

    Properties

    annualize?: number

    Bars per year, applied as √annualize. Default 252 (trading days, for daily bars). Pass 1 for the raw per-bar σ, or your own bar count — 252 × 6.5 × 60 for one-minute bars on a 6.5-hour session, 365 for a market that trades every calendar day.

    column?: NumericColumnNameForSchema<S>

    Source column. Default 'close'.

    output?: Output

    Name of the appended column. Default 'hv'.

    period?: number

    Window length in bars — how many log returns the σ is taken over. Default 20.