Add economic indicators (#70)

Matthiee · web-flow · commit 2de35365d18d · 2022-11-19T13:29:59.000+01:00
diff --git a/FinancialModelingPrepApi/Abstractions/Economics/IEconomicsProvider.cs b/FinancialModelingPrepApi/Abstractions/Economics/IEconomicsProvider.cs
@@ -0,0 +1,19 @@
+﻿using MatthiWare.FinancialModelingPrep.Model;
+using MatthiWare.FinancialModelingPrep.Model.Economics;
+using System.Collections.Generic;
+using System.Threading.Tasks;
+
+namespace MatthiWare.FinancialModelingPrep.Abstractions.Economics
+{
+    public interface IEconomicsProvider
+    {
+        /// <summary>
+        /// Gets the economic indicator result for a given timeframe
+        /// </summary>
+        /// <param name="indicator">Economic indicator to use</param>
+        /// <param name="from">Format YYYY-MM-DD</param>
+        /// <param name="to">Format YYYY-MM-DD</param>
+        /// <returns><see cref="EconomicIndicatorResponse"/></returns>
+        public Task<ApiResponse<List<EconomicIndicatorResponse>>> GetEconomicIndicatorAsync(EconomicIndicator indicator, string from, string to);
+    }
+}
diff --git a/FinancialModelingPrepApi/Abstractions/IFinancialModelingPrepApiClient.cs b/FinancialModelingPrepApi/Abstractions/IFinancialModelingPrepApiClient.cs
@@ -1,6 +1,7 @@
 ﻿using MatthiWare.FinancialModelingPrep.Abstractions.AdvancedData;
 using MatthiWare.FinancialModelingPrep.Abstractions.Calendars;
 using MatthiWare.FinancialModelingPrep.Abstractions.CompanyValuation;
+using MatthiWare.FinancialModelingPrep.Abstractions.Economics;
 using MatthiWare.FinancialModelingPrep.Abstractions.Fund;
 using MatthiWare.FinancialModelingPrep.Abstractions.InstitutionalFund;
 using MatthiWare.FinancialModelingPrep.Abstractions.MarketIndexes;
@@ -19,51 +20,60 @@ public interface IFinancialModelingPrepApiClient
         /// Advanced Data Endpoints are grouped here
         /// Note: most of these endpoints require a premium API Key
         /// </summary>
-        IAdvancedDataProvider AdvancedData { get; }
+        public IAdvancedDataProvider AdvancedData { get; }
 
         /// <summary>
         /// All Company Valuation Endpoints are grouped here
         /// </summary>
-        ICompanyValuationProvider CompanyValuation { get; }
+        public ICompanyValuationProvider CompanyValuation { get; }
 
         /// <summary>
         /// All Market Index Endpoints are grouped here
         /// </summary>
-        IMarketIndexesProvider MarketIndexes { get; }
+        public IMarketIndexesProvider MarketIndexes { get; }
 
         /// <summary>
         /// All Calendar related Endpoints are grouped here (Earnings, IPO, stock splits, Dividends, Economic)
         /// </summary>
-        ICalendarsProvider Calendars { get; }
+        public ICalendarsProvider Calendars { get; }
 
         /// <summary>
         /// All Instituational Fund Endpoints are grouped here
         /// </summary>
-        IInstitutionalFundProvider InstitutionalFund { get; }
+        public IInstitutionalFundProvider InstitutionalFund { get; }
 
         /// <summary>
         /// All Stock Time Series Endpoints are grouped here
         /// </summary>
-        IStockTimeSeriesProvider StockTimeSeries { get; }
+        public IStockTimeSeriesProvider StockTimeSeries { get; }
 
         /// <summary>
         /// All Stock Market Related Endpoints are grouped here (Most Active, Gainers, Losers)
         /// </summary>
-        IStockMarketProvider StockMarket { get; }
+        public IStockMarketProvider StockMarket { get; }
 
         /// <summary>
         /// Statistic Related Endpoint are grouped here (Estimates)
         /// </summary>
-        IStockStatisticsProvider StockStatistics { get; }
+        public IStockStatisticsProvider StockStatistics { get; }
 
         /// <summary>
         /// Cryptomarket related enpoints
         /// </summary>
-        ICryptoMarketProvider Crypto { get; }
+        public ICryptoMarketProvider Crypto { get; }
 
         /// <summary>
         /// ETF/Mutual Fund related enpoints
         /// </summary>
-        IFundProvider Fund { get; }
+        public IFundProvider Fund { get; }
+
+
+        /// <summary>
+        /// Economics related endpoints
+        /// - Market risk premium
+        /// - Treasury rates
+        /// - Economic indicators
+        /// </summary>
+        public IEconomicsProvider Economics { get; }
     }
 }
diff --git a/FinancialModelingPrepApi/Core/Economics/EconomicsProvider.cs b/FinancialModelingPrepApi/Core/Economics/EconomicsProvider.cs
@@ -0,0 +1,40 @@
+﻿using MatthiWare.FinancialModelingPrep.Abstractions.Economics;
+using MatthiWare.FinancialModelingPrep.Core.Http;
+using MatthiWare.FinancialModelingPrep.Model;
+using MatthiWare.FinancialModelingPrep.Model.Economics;
+using System;
+using System.Collections.Generic;
+using System.Collections.Specialized;
+using System.Threading.Tasks;
+
+namespace MatthiWare.FinancialModelingPrep.Core.Economics
+{
+    public class EconomicsProvider : IEconomicsProvider
+    {
+        private readonly FinancialModelingPrepHttpClient client;
+
+        public EconomicsProvider(FinancialModelingPrepHttpClient client)
+        {
+            this.client = client ?? throw new System.ArgumentNullException(nameof(client));
+        }
+
+        /// <inheritdoc/>
+        public Task<ApiResponse<List<EconomicIndicatorResponse>>> GetEconomicIndicatorAsync(EconomicIndicator indicator, string from, string to)
+        {
+            const string url = "[version]/economic";
+
+            var pathParams = new NameValueCollection()
+            {
+                { "version", ApiVersion.v4.ToString() },
+            };
+
+            var queryString = new QueryStringBuilder();
+
+            queryString.Add("name", indicator.ToFMP());
+            queryString.Add("from", from);
+            queryString.Add("to", to);
+
+            return client.GetJsonAsync<List<EconomicIndicatorResponse>>(url, pathParams, queryString);
+        }
+    }
+}
diff --git a/FinancialModelingPrepApi/Core/FinancialModelingPrepApiClient.cs b/FinancialModelingPrepApi/Core/FinancialModelingPrepApiClient.cs
@@ -1,6 +1,7 @@
 ﻿using MatthiWare.FinancialModelingPrep.Abstractions.AdvancedData;
 using MatthiWare.FinancialModelingPrep.Abstractions.Calendars;
 using MatthiWare.FinancialModelingPrep.Abstractions.CompanyValuation;
+using MatthiWare.FinancialModelingPrep.Abstractions.Economics;
 using MatthiWare.FinancialModelingPrep.Abstractions.Fund;
 using MatthiWare.FinancialModelingPrep.Abstractions.InstitutionalFund;
 using MatthiWare.FinancialModelingPrep.Abstractions.MarketIndexes;
@@ -43,6 +44,9 @@ public class FinancialModelingPrepApiClient : IFinancialModelingPrepApiClient
         /// <inheritdoc/>
         public IFundProvider Fund { get; }
 
+        /// <inheritdoc/>
+        public IEconomicsProvider Economics { get; }
+
         /// <inheritdoc/>
         public FinancialModelingPrepApiClient(ICompanyValuationProvider companyValuation,
                                               IMarketIndexesProvider marketIndexes,
@@ -53,7 +57,8 @@ public FinancialModelingPrepApiClient(ICompanyValuationProvider companyValuation
                                               IStockMarketProvider stockMarket,
                                               IStockStatisticsProvider stockStatistics,
                                               ICryptoMarketProvider cryptoMarket,
-                                              IFundProvider fund)
+                                              IFundProvider fund,
+                                              IEconomicsProvider economics)
         {
             CompanyValuation = companyValuation;
             MarketIndexes = marketIndexes;
@@ -65,6 +70,7 @@ public FinancialModelingPrepApiClient(ICompanyValuationProvider companyValuation
             StockStatistics = stockStatistics;
             Crypto = cryptoMarket;
             Fund = fund;
+            Economics = economics;
         }
     }
 }
diff --git a/FinancialModelingPrepApi/DependencyInjectionExtensions.cs b/FinancialModelingPrepApi/DependencyInjectionExtensions.cs
@@ -1,6 +1,7 @@
 ﻿using MatthiWare.FinancialModelingPrep.Abstractions.AdvancedData;
 using MatthiWare.FinancialModelingPrep.Abstractions.Calendars;
 using MatthiWare.FinancialModelingPrep.Abstractions.CompanyValuation;
+using MatthiWare.FinancialModelingPrep.Abstractions.Economics;
 using MatthiWare.FinancialModelingPrep.Abstractions.Fund;
 using MatthiWare.FinancialModelingPrep.Abstractions.Http;
 using MatthiWare.FinancialModelingPrep.Abstractions.InstitutionalFund;
@@ -12,6 +13,7 @@
 using MatthiWare.FinancialModelingPrep.Core.AdvancedData;
 using MatthiWare.FinancialModelingPrep.Core.Calendars;
 using MatthiWare.FinancialModelingPrep.Core.CompanyValuation;
+using MatthiWare.FinancialModelingPrep.Core.Economics;
 using MatthiWare.FinancialModelingPrep.Core.Fund;
 using MatthiWare.FinancialModelingPrep.Core.Http;
 using MatthiWare.FinancialModelingPrep.Core.InstitutionalFund;
@@ -54,6 +56,7 @@ public static void AddFinancialModelingPrepApiClient(this IServiceCollection ser
             services.TryAddTransient<ICryptoMarketProvider, CryptoMarketProvider>();
             services.TryAddTransient<IStockStatisticsProvider, StockStatisticsProvider>();
             services.TryAddTransient<IFundProvider, FundProvider>();
+            services.TryAddTransient<IEconomicsProvider, EconomicsProvider>();
         }
     }
 }
diff --git a/FinancialModelingPrepApi/FinancialModelingPrepApi.xml b/FinancialModelingPrepApi/FinancialModelingPrepApi.xml
diff --git a/FinancialModelingPrepApi/Model/Economics/EconomicIndicator.cs b/FinancialModelingPrepApi/Model/Economics/EconomicIndicator.cs
@@ -0,0 +1,65 @@
+﻿using System;
+
+namespace MatthiWare.FinancialModelingPrep.Model.Economics
+{
+    public enum EconomicIndicator
+    {
+        GDP,
+        RealGDP, 
+        NominalPotentialGDP,
+        RealGDPPerCapita, 
+        FederalFunds, 
+        CPI,
+        InflationRate, 
+        Inflation,
+        RetailSales,
+        ConsumerSentiment,
+        DurableGoods, 
+        UnemploymentRate,
+        TotalNonfarmPayroll,
+        InitialClaims,
+        IndustrialProductionTotalIndex,
+        NewPrivatelyOwnedHousingUnitsStartedTotalUnits,
+        TotalVehicleSales,
+        RetailMoneyFunds, 
+        SmoothedUSRecessionProbabilities,
+        CertificatesOfDeposit3MonthOr90DayRatesAndYields,
+        CommercialBankInterestRateOnCreditCardPlansAllAccounts,
+        FixedRateMortgageAverage30Year,
+        FixedRateMortgageAverage15Year,
+    }
+
+    public static class EconomicIndicatorExtensions
+    {
+        public static string ToFMP(this EconomicIndicator indicator)
+        {
+            return indicator switch
+            {
+                EconomicIndicator.GDP => "GDP",
+                EconomicIndicator.RealGDP => "realGDP",
+                EconomicIndicator.NominalPotentialGDP => "nominalPotentialGDP",
+                EconomicIndicator.RealGDPPerCapita => "realGDPPerCapita",
+                EconomicIndicator.FederalFunds => "federalFunds",
+                EconomicIndicator.CPI => "CPI",
+                EconomicIndicator.InflationRate => "inflationRate",
+                EconomicIndicator.Inflation => "inflation",
+                EconomicIndicator.RetailSales => "retailSales",
+                EconomicIndicator.ConsumerSentiment => "consumerSentiment",
+                EconomicIndicator.DurableGoods => "durableGoods",
+                EconomicIndicator.UnemploymentRate => "unemploymentRate",
+                EconomicIndicator.TotalNonfarmPayroll => "totalNonfarmPayroll",
+                EconomicIndicator.InitialClaims => "initialClaims",
+                EconomicIndicator.IndustrialProductionTotalIndex => "industrialProductionTotalIndex",
+                EconomicIndicator.NewPrivatelyOwnedHousingUnitsStartedTotalUnits => "newPrivatelyOwnedHousingUnitsStartedTotalUnits",
+                EconomicIndicator.TotalVehicleSales => "totalVehicleSales",
+                EconomicIndicator.RetailMoneyFunds => "retailMoneyFunds",
+                EconomicIndicator.SmoothedUSRecessionProbabilities => "smoothedUSRecessionProbabilities",
+                EconomicIndicator.CertificatesOfDeposit3MonthOr90DayRatesAndYields => "3MonthOr90DayRatesAndYieldsCertificatesOfDeposit",
+                EconomicIndicator.CommercialBankInterestRateOnCreditCardPlansAllAccounts => "commercialBankInterestRateOnCreditCardPlansAllAccounts",
+                EconomicIndicator.FixedRateMortgageAverage15Year => "15YearFixedRateMortgageAverage",
+                EconomicIndicator.FixedRateMortgageAverage30Year => "30YearFixedRateMortgageAverage",
+                _ => throw new NotImplementedException(),
+            };
+        }
+    }
+}
diff --git a/FinancialModelingPrepApi/Model/Economics/EconomicIndicatorResponse.cs b/FinancialModelingPrepApi/Model/Economics/EconomicIndicatorResponse.cs
@@ -0,0 +1,13 @@
+﻿using System.Text.Json.Serialization;
+
+namespace MatthiWare.FinancialModelingPrep.Model.Economics
+{
+    public class EconomicIndicatorResponse
+    {
+        [JsonPropertyName("date")]
+        public string Date { get; set; }
+
+        [JsonPropertyName("value")]
+        public double Value { get; set; }
+    }
+}
diff --git a/Tests/ClientFactoryTests.cs b/Tests/ClientFactoryTests.cs
@@ -65,5 +65,11 @@ public void API_Contains_Fund_Provider()
         {
             Assert.NotNull(api.Fund);
         }
+
+        [Fact]
+        public void API_Contains_Economics_Provider()
+        {
+            Assert.NotNull(api.Economics);
+        }
     }
 }
diff --git a/Tests/Economics/EconomicsTest.cs b/Tests/Economics/EconomicsTest.cs
diff --git a/Tests/ResolveApiTests.cs b/Tests/ResolveApiTests.cs

Original file line number	Diff line number	Diff line change
`@@ -65,5 +65,11 @@ public void API_Contains_Fund_Provider()`
`65`	`65`	`{`
`66`	`66`	`Assert.NotNull(api.Fund);`
`67`	`67`	`}`
	`68`	`+`
	`69`	`+ [Fact]`
	`70`	`+ public void API_Contains_Economics_Provider()`
	`71`	`+ {`
	`72`	`+ Assert.NotNull(api.Economics);`
	`73`	`+ }`
`68`	`74`	`}`
`69`	`75`	`}`