Implement GetCompanyProfile API Call

Author: Matthiee

FinancialModelingPrepApi/Abstractions/Models/ApiVersion.cs renamed to FinancialModelingPrepApi/Abstractions/ApiVersion.cs

@@ -1,4 +1,4 @@
-namespace FinancialModelingPrepApi.Abstractions.Models
+namespace FinancialModelingPrepApi.Abstractions
 {
     public enum ApiVersion
     {

FinancialModelingPrepApi/Abstractions/CompanyValuation/ICompanyValuation.cs

@@ -0,0 +1,11 @@
+using FinancialModelingPrepApi.Model;
+using FinancialModelingPrepApi.Model.CompanyValuation;
+using System.Threading.Tasks;
+
+namespace FinancialModelingPrepApi.Abstractions.CompanyValuation
+{
+    public interface ICompanyValuation
+    {
+        public Task<ApiResponse<CompanyProfileResponse>> GetCompanyProfileAsync(string symbol);
+    }
+}

FinancialModelingPrepApi/Core/CompanyValuation/CompanyValuation.cs

@@ -0,0 +1,33 @@
+using FinancialModelingPrepApi.Abstractions;
+using FinancialModelingPrepApi.Abstractions.CompanyValuation;
+using FinancialModelingPrepApi.Core.Http;
+using FinancialModelingPrepApi.Model;
+using FinancialModelingPrepApi.Model.CompanyValuation;
+using System.Collections.Specialized;
+using System.Threading.Tasks;
+
+namespace FinancialModelingPrepApi.Core.CompanyValuation
+{
+    public class CompanyValuation : ICompanyValuation
+    {
+        private readonly FinancialModelingPrepHttpClient client;
+
+        public CompanyValuation(FinancialModelingPrepHttpClient client)
+        {
+            this.client = client ?? throw new System.ArgumentNullException(nameof(client));
+        }
+
+        public Task<ApiResponse<CompanyProfileResponse>> GetCompanyProfileAsync(string symbol)
+        {
+            const string url = "[version]/profile/[symbol]";
+
+            var pathParams = new NameValueCollection()
+            {
+                { "version", ApiVersion.v3.ToString() },
+                { "symbol", symbol }
+            };
+
+            return client.GetAsync<CompanyProfileResponse>(url, pathParams, null);
+        }
+    }
+}

FinancialModelingPrepApi/Core/Http/FinancialModelingPrepHttpClient.cs

@@ -1,6 +1,8 @@
-using System;
+using FinancialModelingPrepApi.Model;
+using System;
 using System.Collections.Specialized;
 using System.Net.Http;
+using System.Text.Json;
 using System.Threading.Tasks;
 
 namespace FinancialModelingPrepApi.Core.Http
@@ -21,7 +23,23 @@ public FinancialModelingPrepHttpClient(HttpClient client, FinancialModelingPrepO
             }
         }
 
-        public async Task<string> CallApiAsync(string urlPattern, NameValueCollection pathParams, QueryStringBuilder queryString)
+        public async Task<ApiResponse<T>> GetAsync<T>(string urlPattern, NameValueCollection pathParams, QueryStringBuilder queryString)
+            where T : class
+        {
+            try
+            {
+                var response = await CallApiAsync(urlPattern, pathParams, queryString);
+                var data = JsonSerializer.Deserialize<T>(response.Data);
+
+                return ApiResponse.FromSucces(data);
+            }
+            catch (Exception ex)
+            {
+                return ApiResponse.FromError<T>(ex.ToString());
+            }
+        }
+
+        private async Task<ApiResponse<string>> CallApiAsync(string urlPattern, NameValueCollection pathParams, QueryStringBuilder queryString)
         {
             PreProcessUrl(ref urlPattern, ref pathParams, ref queryString);
 
@@ -30,7 +48,14 @@ public async Task<string> CallApiAsync(string urlPattern, NameValueCollection pa
             var requestUrl = $"{urlPattern}{queryString}";
 
             using var response = await client.GetAsync(requestUrl);
-            return await response.EnsureSuccessStatusCode().Content.ReadAsStringAsync();
+            var content = await response.Content.ReadAsStringAsync();
+
+            if (!response.IsSuccessStatusCode)
+            {
+                return ApiResponse.FromError<string>($"{response.StatusCode} - {content}");
+            }
+
+            return ApiResponse.FromSucces(content);
         }
 
         private static void PreProcessUrl(ref string url, ref NameValueCollection pathParams, ref QueryStringBuilder qsb)

FinancialModelingPrepApi/Model/ApiResponse.cs

@@ -0,0 +1,24 @@
+namespace FinancialModelingPrepApi.Model
+{
+    public static class ApiResponse
+    {
+        public static ApiResponse<TReturn> FromError<TReturn>(string error) where TReturn : class
+            => new()
+            {
+                Error = error
+            };
+
+        public static ApiResponse<TReturn> FromSucces<TReturn>(TReturn data) where TReturn : class
+            => new()
+            {
+                Data = data
+            };
+    }
+
+    public class ApiResponse<T> where T : class
+    {
+        public string Error { get; set; }
+        public bool HasError => !string.IsNullOrEmpty(Error);
+        public T Data { get; set; }
+    }
+}

FinancialModelingPrepApi/Model/CompanyValuation/CompanyProfileResponse.cs

@@ -0,0 +1,36 @@
+namespace FinancialModelingPrepApi.Model.CompanyValuation
+{
+    public sealed class CompanyProfileResponse
+    {
+        public string symbol { get; set; }
+        public double price { get; set; }
+        public double beta { get; set; }
+        public int volAvg { get; set; }
+        public long mktCap { get; set; }
+        public double lastDiv { get; set; }
+        public string range { get; set; }
+        public double changes { get; set; }
+        public string companyName { get; set; }
+        public string currency { get; set; }
+        public string isin { get; set; }
+        public string cusip { get; set; }
+        public string exchange { get; set; }
+        public string exchangeShortName { get; set; }
+        public string industry { get; set; }
+        public string website { get; set; }
+        public string description { get; set; }
+        public string ceo { get; set; }
+        public string sector { get; set; }
+        public string country { get; set; }
+        public string fullTimeEmployees { get; set; }
+        public string phone { get; set; }
+        public string address { get; set; }
+        public string city { get; set; }
+        public string state { get; set; }
+        public string zip { get; set; }
+        public double dcfDiff { get; set; }
+        public double dcf { get; set; }
+        public string image { get; set; }
+        public string ipoDate { get; set; }
+    }
+}