From 8c322b4e817075ff2510324aaa07ad8b53b8cd55 Mon Sep 17 00:00:00 2001
From: Thomas Kaul <4159106+dtslvr@users.noreply.github.com>
Date: Sat, 7 Sep 2024 21:21:02 +0200
Subject: [PATCH] Bugfix/fix historical market data gathering in yahoo finance
 service (#3737)

* Switch from historical() to chart()

* Update changelog
---
 CHANGELOG.md                                  |  1 +
 .../yahoo-finance/yahoo-finance.service.ts    | 62 +++++++++++++------
 2 files changed, 43 insertions(+), 20 deletions(-)

diff --git a/CHANGELOG.md b/CHANGELOG.md
index a1bb6525f..5f1102d92 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -32,6 +32,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Fixed an issue in the view mode toggle of the holdings tab on the home page (experimental)
 - Fixed an issue on the portfolio activities page by loading the data only once
 - Fixed an issue in the carousel component for the testimonial section on the landing page
+- Fixed the historical market data gathering in the _Yahoo Finance_ service by switching from `historical()` to `chart()`
 - Handled an exception in the historical market data component of the asset profile details dialog in the admin control panel
 
 ## 2.105.0 - 2024-08-21
diff --git a/apps/api/src/services/data-provider/yahoo-finance/yahoo-finance.service.ts b/apps/api/src/services/data-provider/yahoo-finance/yahoo-finance.service.ts
index e0d88f0c6..a8f7d261e 100644
--- a/apps/api/src/services/data-provider/yahoo-finance/yahoo-finance.service.ts
+++ b/apps/api/src/services/data-provider/yahoo-finance/yahoo-finance.service.ts
@@ -20,6 +20,11 @@ import { Injectable, Logger } from '@nestjs/common';
 import { DataSource, SymbolProfile } from '@prisma/client';
 import { addDays, format, isSameDay } from 'date-fns';
 import yahooFinance from 'yahoo-finance2';
+import { ChartResultArray } from 'yahoo-finance2/dist/esm/src/modules/chart';
+import {
+  HistoricalDividendsResult,
+  HistoricalHistoryResult
+} from 'yahoo-finance2/dist/esm/src/modules/historical';
 import { Quote } from 'yahoo-finance2/dist/esm/src/modules/quote';
 
 @Injectable()
@@ -60,18 +65,19 @@ export class YahooFinanceService implements DataProviderInterface {
     }
 
     try {
-      const historicalResult = await yahooFinance.historical(
-        this.yahooFinanceDataEnhancerService.convertToYahooFinanceSymbol(
-          symbol
-        ),
-        {
-          events: 'dividends',
-          interval: granularity === 'month' ? '1mo' : '1d',
-          period1: format(from, DATE_FORMAT),
-          period2: format(to, DATE_FORMAT)
-        }
+      const historicalResult = this.convertToDividendResult(
+        await yahooFinance.chart(
+          this.yahooFinanceDataEnhancerService.convertToYahooFinanceSymbol(
+            symbol
+          ),
+          {
+            events: 'dividends',
+            interval: granularity === 'month' ? '1mo' : '1d',
+            period1: format(from, DATE_FORMAT),
+            period2: format(to, DATE_FORMAT)
+          }
+        )
       );
-
       const response: {
         [date: string]: IDataProviderHistoricalResponse;
       } = {};
@@ -108,15 +114,17 @@ export class YahooFinanceService implements DataProviderInterface {
     }
 
     try {
-      const historicalResult = await yahooFinance.historical(
-        this.yahooFinanceDataEnhancerService.convertToYahooFinanceSymbol(
-          symbol
-        ),
-        {
-          interval: '1d',
-          period1: format(from, DATE_FORMAT),
-          period2: format(to, DATE_FORMAT)
-        }
+      const historicalResult = this.convertToHistoricalResult(
+        await yahooFinance.chart(
+          this.yahooFinanceDataEnhancerService.convertToYahooFinanceSymbol(
+            symbol
+          ),
+          {
+            interval: '1d',
+            period1: format(from, DATE_FORMAT),
+            period2: format(to, DATE_FORMAT)
+          }
+        )
       );
 
       const response: {
@@ -302,6 +310,20 @@ export class YahooFinanceService implements DataProviderInterface {
     return { items };
   }
 
+  private convertToDividendResult(
+    result: ChartResultArray
+  ): HistoricalDividendsResult {
+    return result.events.dividends.map(({ amount: dividends, date }) => {
+      return { date, dividends };
+    });
+  }
+
+  private convertToHistoricalResult(
+    result: ChartResultArray
+  ): HistoricalHistoryResult {
+    return result.quotes;
+  }
+
   private async getQuotesWithQuoteSummary(aYahooFinanceSymbols: string[]) {
     const quoteSummaryPromises = aYahooFinanceSymbols.map((symbol) => {
       return yahooFinance.quoteSummary(symbol).catch(() => {