forinvest-cli
    Preparing search index...

    Interface IIntradayRepo

    interface IIntradayRepo {
        getChangeStatistics(
            legacyCode: string,
        ): Promise<ChangeStatisticsResponse>;
        getCompareIntraday(
            codes: string[],
            period: string,
            from: string,
            to: string,
            currencies?: string[],
        ): Promise<IntradayCompareResponse[]>;
        getHistorical(
            definition: Definition,
            resolution: string,
            from: string,
            to: string,
            zoneId?: string,
        ): Promise<IntradayResponse[]>;
        getHistoricalAtLast(
            legacyCode: string,
            period: string,
            at: string,
            last: number,
            zoneId?: string,
        ): Promise<IntradayResponse[]>;
        getHistoricalAtLastMultiService(
            period: number,
            at: string,
            last: number,
            params: { c: string | string[]; f?: string; field?: string },
        ): Promise<IntradayResponse[]>;
        getHistoricalFromToMultiService(
            period: number,
            from: string,
            to: string,
            params: {
                c: string | string[];
                f?: string;
                field?: string;
                zoneId?: string;
            },
        ): Promise<IntradayResponse[]>;
        getHistoricalLast(
            definition: Definition,
            resolution: string,
            last: number,
            zoneId?: string,
        ): Promise<IntradayResponse[]>;
        getHistoricalLastMultiService(
            period: number,
            last: number,
            params: { c: string | string[]; f?: string; field?: string },
        ): Promise<IntradayResponse[]>;
        getHistoricalLastWithCurrency(
            definition: Definition,
            resolution: string,
            last: number,
            cur: string,
        ): Promise<IntradayResponse[]>;
        getHistoricalLastWithFieldFilter(
            definition: Definition,
            resolution: string,
            last: number,
            fieldFilter: string,
        ): Promise<IntradayResponse[]>;
        getHistoricalSimpleByTimespan(
            legacyCode: string,
            timespan: SimpleIntradayTimespanEnum,
            zoneId?: string,
        ): Promise<IntradayResponse[]>;
        getHistoricalWithCurrency(
            definition: Definition,
            resolution: string,
            from: string,
            to: string,
            cur: string,
        ): Promise<IntradayResponse[]>;
        getHistoricalWithFieldFilter(
            definition: Definition,
            resolution: string,
            from: string,
            to: string,
            fieldFilter: string,
        ): Promise<IntradayResponse[]>;
        getHistoricalWithShortCode(
            definition: Definition,
            resolution: string,
            from: string,
            to: string,
            shortCode: string,
            zoneId?: string,
        ): Promise<IntradayResponse[]>;
        getHistoricalWithShortCodeAndCurrency(
            definition: Definition,
            resolution: string,
            from: string,
            to: string,
            shortCode: string,
            currency: string,
            zoneId?: string,
        ): Promise<IntradayResponse[]>;
    }
    Index

    Methods

    getChangeStatistics getCompareIntraday getHistorical getHistoricalAtLast getHistoricalAtLastMultiService getHistoricalFromToMultiService getHistoricalLast getHistoricalLastMultiService getHistoricalLastWithCurrency getHistoricalLastWithFieldFilter getHistoricalSimpleByTimespan getHistoricalWithCurrency getHistoricalWithFieldFilter getHistoricalWithShortCode getHistoricalWithShortCodeAndCurrency

    Methods

    • Returns percentage-change statistics (daily, YTD, 1-year, etc.) for the given symbol.

      Parameters

      • legacyCode: string

        Legacy symbol code (e.g., "GARAN.E.BIST").

      Returns Promise<ChangeStatisticsResponse>

      Percentage-change data for multiple timeframes.

    • Parameters

      • codes: string[]

        symbol codes

      • period: string

        intraday period

      • from: string

        start date

      • to: string

        end date

      • Optionalcurrencies: string[]

        currencies to compare

      Returns Promise<IntradayCompareResponse[]>

      Comparison data for the specified symbols.

    • Parameters

      • definition: Definition
      • resolution: string

        time period constant (['1', '3', '5',..., '15', '30', '45', '60', '1h', '2h', '3h', '4h', '5h', 'D', 'W', 'M'])

      • from: string

        YYYYMMDDHHmmss

      • to: string

        YYYYMMDDHHmmss

      • OptionalzoneId: string

      Returns Promise<IntradayResponse[]>

      o,h,l,c,v data series

    • Parameters

      • legacyCode: string
      • period: string

        time period constant (['1', '3', '5',..., '15', '30', '45', '60', '1h', '2h', '3h', '4h', '5h', 'D', 'W', 'M'])

      • at: string

        string

      • last: number

        number

      • OptionalzoneId: string

      Returns Promise<IntradayResponse[]>

      your field filter + date result

    • Parameters

      • period: number

        intraday period - Supported values are integers that divide 1440. Ex 1,2,3,5,10,60 etc, if period is bigger than 60, period must be divisible by 60.

      • at: string

        yyyyMMddhhmmss

      • last: number

        last count

      • params: { c: string | string[]; f?: string; field?: string }

        {f: "Possible values : o,h,l,c,a,v", c: "legacy code", field: "field definition shortCode name should be used. Only daily (1440) period is supported. Also supported shortCodes are; PriceEarning= pE, MarketValue=mv, BookValue=Bv, PriceBookValue=Pb, Rate=r, TopFiveBrokerNetTradeVolume=Fn, TopFiveBrokerNetTradeTurnover=Un, TopTenBrokerNetTradeVolume=fn, TopTenBrokerNetTradeTurnover=un"}

      Returns Promise<IntradayResponse[]>

      {"TCELL.E.BIST":[{"d":1397458800000,"o":11.85,"h":11.85,"l":11.8,"c":11.85,"v":14940.199999999999,"a":1266}],"EUR/USD":[{"d":1397458800000,"o":1.38395,"h":1.3848,"l":1.38395,"c":1.38468,"v":0,"a":0}]}

    • Retrieves intraday historical data for multiple symbols within a specific date range.

      Parameters

      • period: number

        Intraday time period in minutes. Must divide evenly into 1440 (e.g., 1, 5, 10, 60).

      • from: string

        Start date in 'yyyyMMddHHmmss' format.

      • to: string

        End date in 'yyyyMMddHHmmss' format.

      • params: { c: string | string[]; f?: string; field?: string; zoneId?: string }

        Additional query parameters.

        • c: string | string[]

          Symbol code or array of symbol codes (max 10 symbols).

        • Optionalf?: string

          Intraday field filter (e.g., 'o', 'h', 'l', 'c', 'a', 'v', 'w').

        • Optionalfield?: string

          Field short code (e.g., 'pE', 'mv', 'Bv', 'Pb', 'r', etc.).

        • OptionalzoneId?: string

          Optional time zone identifier (e.g., 'Europe/Istanbul').

      Returns Promise<IntradayResponse[]>

      A promise resolving to an array of intraday data per symbol.

    • Parameters

      • definition: Definition
      • resolution: string

        time period constant (['1', '3', '5',..., '15', '30', '45', '60', '1h', '2h', '3h', '4h', '5h', 'D', 'W', 'M'])

      • last: number

        number

      • OptionalzoneId: string

      Returns Promise<IntradayResponse[]>

      your field filter + date result

    • Parameters

      • period: number

        intraday period - Supported values are integers that divide 1440. Ex 1,2,3,5,10,60 etc, if period is bigger than 60, period must be divisible by 60.

      • last: number

        last count - max value 1400

      • params: { c: string | string[]; f?: string; field?: string }

        {f: "Possible values : o,h,l,c,a,v,w", c: "legacy code mmax 10", field: "field definition shortCode name should be used. Only daily (1440) period is supported. Also supported shortCodes are; PriceEarning= pE, MarketValue=mv, BookValue=Bv, PriceBookValue=Pb, Rate=r, TopFiveBrokerNetTradeVolume=Fn, TopFiveBrokerNetTradeTurnover=Un, TopTenBrokerNetTradeVolume=fn, TopTenBrokerNetTradeTurnover=un"}

      Returns Promise<IntradayResponse[]>

      {"EUR/USD": [{"a": 0,"c": 1.3594,"d": 1392328500000,"h": 1.3594,"l": 1.3594,"o": 1.3594,"v": 0,"w": 0}],"TCELL.E.BIST": [{"a": 286292,"c": 11.25,"d": 1392305700000,"h": 11.25,"l": 11.25,"o": 11.25,"v": 3220785,"w": 0}]}

    • Parameters

      • definition: Definition
      • resolution: string

        time period constant (['1', '3', '5',..., '15', '30', '45', '60', '1h', '2h', '3h', '4h', '5h', 'D', 'W', 'M'])

      • last: number

        number

      • cur: string

        Currency value

      Returns Promise<IntradayResponse[]>

      your field filter + date result

    • Parameters

      • definition: Definition
      • resolution: string

        time period constant (['1', '3', '5',..., '15', '30', '45', '60', '1h', '2h', '3h', '4h', '5h', 'D', 'W', 'M'])

      • last: number

        number

      • fieldFilter: string

        o,h,l,c,v

      Returns Promise<IntradayResponse[]>

      your field filter + date result

    • Parameters

      • definition: Definition
      • resolution: string

        time period constant (['1', '3', '5',..., '15', '30', '45', '60', '1h', '2h', '3h', '4h', '5h', 'D', 'W', 'M'])

      • from: string

        YYYYMMDDHHmmss

      • to: string

        YYYYMMDDHHmmss

      • cur: string

        Currency value

      Returns Promise<IntradayResponse[]>

      o,h,l,c,v data series

    • Parameters

      • definition: Definition
      • resolution: string

        time period constant (['1', '3', '5',..., '15', '30', '45', '60', '1h', '2h', '3h', '4h', '5h', 'D', 'W', 'M'])

      • from: string

        YYYYMMDDHHmmss

      • to: string

        YYYYMMDDHHmmss

      • fieldFilter: string

        Possible values : o,h,l,c,a,v

      Returns Promise<IntradayResponse[]>

      your field filter + date result

    • Parameters

      • definition: Definition
      • resolution: string

        time period constant (['1', '3', '5',..., '15', '30', '45', '60', '1h', '2h', '3h', '4h', '5h', 'D', 'W', 'M'])

      • from: string

        YYYYMMDDHHmmss

      • to: string

        YYYYMMDDHHmmss

      • shortCode: string

        Possible values : PriceEarning= pE, MarketValue=mv, BookValue=Bv, PriceBookValue=Pb, Rate=r, TopFiveBrokerNetTradeVolume=Fn, TopFiveBrokerNetTradeTurnover=Un, TopTenBrokerNetTradeVolume=fn, TopTenBrokerNetTradeTurnover=un

      • OptionalzoneId: string

      Returns Promise<IntradayResponse[]>

      your short code + date result

    • Parameters

      • definition: Definition
      • resolution: string

        time period constant (['1', '3', '5',..., '15', '30', '45', '60', '1h', '2h', '3h', '4h', '5h', 'D', 'W', 'M'])

      • from: string

        YYYYMMDDHHmmss

      • to: string

        YYYYMMDDHHmmss

      • shortCode: string

        Possible values : PriceEarning= pE, MarketValue=mv, BookValue=Bv, PriceBookValue=Pb, Rate=r, TopFiveBrokerNetTradeVolume=Fn, TopFiveBrokerNetTradeTurnover=Un, TopTenBrokerNetTradeVolume=fn, TopTenBrokerNetTradeTurnover=un

      • currency: string
      • OptionalzoneId: string

      Returns Promise<IntradayResponse[]>

      your short code + date result

    Settings

    Member Visibility

    On This Page

    Methods