Add MarketIndexes API

Author: Matthiee

FinancialModelingPrepApi/Abstractions/IFinancialModelingPrepApiClient.cs

@@ -1,9 +1,11 @@
 using MatthiWare.FinancialModelingPrepApi.Abstractions.CompanyValuation;
+using MatthiWare.FinancialModelingPrepApi.Abstractions.MarketIndexes;
 
 namespace MatthiWare.FinancialModelingPrepApi
 {
     public interface IFinancialModelingPrepApiClient
     {
         ICompanyValuation CompanyValuation { get; }
+        IMarketIndexes MarketIndexes { get; }
     }
 }

FinancialModelingPrepApi/Abstractions/MarketIndexes/IMarketIndexes.cs

@@ -0,0 +1,14 @@
+using MatthiWare.FinancialModelingPrepApi.Model;
+using MatthiWare.FinancialModelingPrepApi.Model.MarketIndexes;
+using System.Collections.Generic;
+using System.Threading.Tasks;
+
+namespace MatthiWare.FinancialModelingPrepApi.Abstractions.MarketIndexes
+{
+    public interface IMarketIndexes
+    {
+        Task<ApiResponse<List<IndexConstituentResponse>>> GetSP500CompaniesAsync();
+        Task<ApiResponse<List<IndexConstituentResponse>>> GetNasdaqCompaniesAsync();
+        Task<ApiResponse<List<IndexConstituentResponse>>> GetDowJonesCompaniesAsync();
+    }
+}

FinancialModelingPrepApi/Core/FinancialModelingPrepApiClient.cs

@@ -1,14 +1,18 @@
 using MatthiWare.FinancialModelingPrepApi.Abstractions.CompanyValuation;
+using MatthiWare.FinancialModelingPrepApi.Abstractions.MarketIndexes;
 
 namespace MatthiWare.FinancialModelingPrepApi.Core
 {
     public class FinancialModelingPrepApiClient : IFinancialModelingPrepApiClient
     {
         public ICompanyValuation CompanyValuation { get; private set; }
 
-        public FinancialModelingPrepApiClient(ICompanyValuation companyValuation)
+        public IMarketIndexes MarketIndexes { get; private set; }
+
+        public FinancialModelingPrepApiClient(ICompanyValuation companyValuation, IMarketIndexes marketIndexes)
         {
-            this.CompanyValuation = companyValuation;
+            CompanyValuation = companyValuation;
+            MarketIndexes = marketIndexes;
         }
     }
 }

FinancialModelingPrepApi/Core/MarketIndexes/MarketIndexes.cs

@@ -0,0 +1,57 @@
+using MatthiWare.FinancialModelingPrepApi.Abstractions.MarketIndexes;
+using MatthiWare.FinancialModelingPrepApi.Core.Http;
+using MatthiWare.FinancialModelingPrepApi.Model;
+using MatthiWare.FinancialModelingPrepApi.Model.CompanyValuation;
+using MatthiWare.FinancialModelingPrepApi.Model.MarketIndexes;
+using System.Collections.Generic;
+using System.Collections.Specialized;
+using System.Threading.Tasks;
+
+namespace MatthiWare.FinancialModelingPrepApi.Core.MarketIndexes
+{
+    public class MarketIndexes : IMarketIndexes
+    {
+        private readonly FinancialModelingPrepHttpClient client;
+
+        public MarketIndexes(FinancialModelingPrepHttpClient client)
+        {
+            this.client = client ?? throw new System.ArgumentNullException(nameof(client));
+        }
+
+        public Task<ApiResponse<List<IndexConstituentResponse>>> GetDowJonesCompaniesAsync()
+        {
+            const string url = "[version]/dowjones_constituent";
+
+            var pathParams = new NameValueCollection()
+            {
+                { "version", ApiVersion.v3.ToString() },
+            };
+
+            return client.GetAsync<List<IndexConstituentResponse>>(url, pathParams, null);
+        }
+
+        public Task<ApiResponse<List<IndexConstituentResponse>>> GetNasdaqCompaniesAsync()
+        {
+            const string url = "[version]/nasdaq_constituent";
+
+            var pathParams = new NameValueCollection()
+            {
+                { "version", ApiVersion.v3.ToString() },
+            };
+
+            return client.GetAsync<List<IndexConstituentResponse>>(url, pathParams, null);
+        }
+
+        public Task<ApiResponse<List<IndexConstituentResponse>>> GetSP500CompaniesAsync()
+        {
+            const string url = "[version]/sp500_constituent";
+
+            var pathParams = new NameValueCollection()
+            {
+                { "version", ApiVersion.v3.ToString() },
+            };
+
+            return client.GetAsync<List<IndexConstituentResponse>>(url, pathParams, null);
+        }
+    }
+}

FinancialModelingPrepApi/DependencyInjectionExtensions.cs

@@ -1,7 +1,9 @@
 using MatthiWare.FinancialModelingPrepApi.Abstractions.CompanyValuation;
+using MatthiWare.FinancialModelingPrepApi.Abstractions.MarketIndexes;
 using MatthiWare.FinancialModelingPrepApi.Core;
 using MatthiWare.FinancialModelingPrepApi.Core.CompanyValuation;
 using MatthiWare.FinancialModelingPrepApi.Core.Http;
+using MatthiWare.FinancialModelingPrepApi.Core.MarketIndexes;
 using Microsoft.Extensions.DependencyInjection;
 using Microsoft.Extensions.DependencyInjection.Extensions;
 using System;
@@ -21,6 +23,7 @@ public static void AddFinancialModelingPrepApiClient(this IServiceCollection ser
 
             services.TryAddSingleton<IFinancialModelingPrepApiClient, FinancialModelingPrepApiClient>();
             services.TryAddScoped<ICompanyValuation, CompanyValuation>();
+            services.TryAddScoped<IMarketIndexes, MarketIndexes>();
         }
     }
 }

FinancialModelingPrepApi/Model/MarketIndexes/IndexConstituentResponse.cs

@@ -0,0 +1,31 @@
+using System.Text.Json.Serialization;
+
+namespace MatthiWare.FinancialModelingPrepApi.Model.MarketIndexes
+{
+    public class IndexConstituentResponse
+    {
+        [JsonPropertyName("symbol")]
+        public string Symbol { get; set; }
+
+        [JsonPropertyName("name")]
+        public string Name { get; set; }
+
+        [JsonPropertyName("sector")]
+        public string Sector { get; set; }
+
+        [JsonPropertyName("subSector")]
+        public string SubSector { get; set; }
+
+        [JsonPropertyName("headQuarter")]
+        public string HeadQuarter { get; set; }
+
+        [JsonPropertyName("dateFirstAdded")]
+        public string DateFirstAdded { get; set; }
+
+        [JsonPropertyName("cik")]
+        public string Cik { get; set; }
+
+        [JsonPropertyName("founded")]
+        public string Founded { get; set; }
+    }
+}

Tests/MarketIndexes/MarketIndexesTests.cs

@@ -0,0 +1,52 @@
+using MatthiWare.FinancialModelingPrepApi;
+using MatthiWare.FinancialModelingPrepApi.Model;
+using Microsoft.Extensions.DependencyInjection;
+using System.Threading.Tasks;
+using Xunit;
+using Xunit.Abstractions;
+
+namespace Tests.CompanyValuation
+{
+    public class MarketIndexesTests : TestingBase
+    {
+        public MarketIndexesTests(ITestOutputHelper testOutput) : base(testOutput)
+        {
+        }
+
+        [Fact]
+        public async Task GetDowJonesCompaniesTests()
+        {
+            var api = ServiceProvider.GetRequiredService<IFinancialModelingPrepApiClient>();
+
+            var result = await api.MarketIndexes.GetDowJonesCompaniesAsync();
+
+            Assert.NotNull(result);
+            Assert.False(result.HasError);
+            Assert.NotEmpty(result.Data);
+        }
+
+        [Fact]
+        public async Task GetNasdaqCompaniesTests()
+        {
+            var api = ServiceProvider.GetRequiredService<IFinancialModelingPrepApiClient>();
+
+            var result = await api.MarketIndexes.GetNasdaqCompaniesAsync();
+
+            Assert.NotNull(result);
+            Assert.False(result.HasError);
+            Assert.NotEmpty(result.Data);
+        }
+
+        [Fact]
+        public async Task GetSP500CompaniesTests()
+        {
+            var api = ServiceProvider.GetRequiredService<IFinancialModelingPrepApiClient>();
+
+            var result = await api.MarketIndexes.GetSP500CompaniesAsync();
+
+            Assert.NotNull(result);
+            Assert.False(result.HasError);
+            Assert.NotEmpty(result.Data);
+        }
+    }
+}