Add financial score + update crypto namespace (#108)

Matthiee · web-flow · commit 6c2be4d4294b · 2023-12-28T19:22:49.000+01:00
* Update crypto namespace

* add fmp tag

* Add financial score
diff --git a/FinancialModelingPrepApi/Abstractions/AdvancedData/IAdvancedDataProvider.cs b/FinancialModelingPrepApi/Abstractions/AdvancedData/IAdvancedDataProvider.cs
@@ -25,5 +25,7 @@ public interface IAdvancedDataProvider
         Task<ApiResponse<SharesFloatResponse>> GetSharesFloatAsync(string symbol);
 
         Task<ApiResponse<List<ESGScoreResponse>>> GetESGScoreAsync(string symbol);
+
+        Task<ApiResponse<FinancialScoreResponse>> GetFinancialScoreAsync(string symbol);
     }
 }
diff --git a/FinancialModelingPrepApi/Abstractions/Crypto/ICryptoMarketProvider.cs b/FinancialModelingPrepApi/Abstractions/Crypto/ICryptoMarketProvider.cs
@@ -4,7 +4,7 @@
 using System.Collections.Generic;
 using System.Threading.Tasks;
 
-namespace MatthiWare.FinancialModelingPrep.Abstractions.StockMarket
+namespace MatthiWare.FinancialModelingPrep.Abstractions.Crypto
 {
     public interface ICryptoMarketProvider
     {
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.Crypto;
 using MatthiWare.FinancialModelingPrep.Abstractions.Economics;
 using MatthiWare.FinancialModelingPrep.Abstractions.Fund;
 using MatthiWare.FinancialModelingPrep.Abstractions.InstitutionalFund;
diff --git a/FinancialModelingPrepApi/Core/AdvancedData/AdvancedDataProvider.cs b/FinancialModelingPrepApi/Core/AdvancedData/AdvancedDataProvider.cs
@@ -173,5 +173,27 @@ public Task<ApiResponse<List<ESGScoreResponse>>> GetESGScoreAsync(string symbol)
 
             return client.GetJsonAsync<List<ESGScoreResponse>>(url, pathParams, queryString);
         }
+
+        public async Task<ApiResponse<FinancialScoreResponse>> GetFinancialScoreAsync(string symbol)
+        {
+            const string url = "[version]/score";
+
+            var pathParams = new NameValueCollection()
+            {
+                { "version", ApiVersion.v4.ToString() }
+            };
+
+            var queryString = new QueryStringBuilder();
+            queryString.Add("symbol", symbol);
+
+            var result = await client.GetJsonAsync<List<FinancialScoreResponse>>(url, pathParams, queryString);
+
+            if (result.HasError)
+            {
+                return ApiResponse.FromError<FinancialScoreResponse>(result.Error);
+            }
+
+            return ApiResponse.FromSucces(result.Data.First());
+        }
     }
 }
diff --git a/FinancialModelingPrepApi/Core/Crypto/CryptoMarketProvider.cs b/FinancialModelingPrepApi/Core/Crypto/CryptoMarketProvider.cs
@@ -1,13 +1,12 @@
-﻿using MatthiWare.FinancialModelingPrep.Abstractions.StockMarket;
+﻿using MatthiWare.FinancialModelingPrep.Abstractions.Crypto;
 using MatthiWare.FinancialModelingPrep.Core.Http;
 using MatthiWare.FinancialModelingPrep.Model;
 using MatthiWare.FinancialModelingPrep.Model.Crypto;
-using MatthiWare.FinancialModelingPrep.Model.StockMarket;
 using System.Collections.Generic;
 using System.Collections.Specialized;
 using System.Threading.Tasks;
 
-namespace MatthiWare.FinancialModelingPrep.Core.StockMarket
+namespace MatthiWare.FinancialModelingPrep.Core.Crypto
 {
     public sealed class CryptoMarketProvider : ICryptoMarketProvider
     {
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.Crypto;
 using MatthiWare.FinancialModelingPrep.Abstractions.Economics;
 using MatthiWare.FinancialModelingPrep.Abstractions.Fund;
 using MatthiWare.FinancialModelingPrep.Abstractions.InstitutionalFund;
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.Crypto;
 using MatthiWare.FinancialModelingPrep.Abstractions.Economics;
 using MatthiWare.FinancialModelingPrep.Abstractions.Fund;
 using MatthiWare.FinancialModelingPrep.Abstractions.Http;
@@ -13,6 +14,7 @@
 using MatthiWare.FinancialModelingPrep.Core.AdvancedData;
 using MatthiWare.FinancialModelingPrep.Core.Calendars;
 using MatthiWare.FinancialModelingPrep.Core.CompanyValuation;
+using MatthiWare.FinancialModelingPrep.Core.Crypto;
 using MatthiWare.FinancialModelingPrep.Core.Economics;
 using MatthiWare.FinancialModelingPrep.Core.Fund;
 using MatthiWare.FinancialModelingPrep.Core.Http;
diff --git a/FinancialModelingPrepApi/FinancialModelingPrepApi.csproj b/FinancialModelingPrepApi/FinancialModelingPrepApi.csproj
@@ -14,10 +14,9 @@
 		<PackageLicenseFile>LICENSE</PackageLicenseFile>
 		<RepositoryUrl>https://github.com/MatthiWare/FinancialModelingPrep.NET</RepositoryUrl>
 		<RepositoryType>git</RepositoryType>
-		<PackageTags>FinancialModelingPrep stock quote finance-api</PackageTags>
+		<PackageTags>FinancialModelingPrep stock quote finance-api fmp</PackageTags>
 		<PackageProjectUrl>https://github.com/MatthiWare/FinancialModelingPrep.NET</PackageProjectUrl>
-		<PackageReleaseNotes>- Include .NET 6 and .NET 7 in nuget package
-- Add Economic Indicators
+		<PackageReleaseNotes>- Update crypto namespace
 		</PackageReleaseNotes>
 		<AssemblyName>FinancialModelingPrep</AssemblyName>
 	</PropertyGroup>
diff --git a/FinancialModelingPrepApi/Model/AdvancedData/FinancialScoreResponse.cs b/FinancialModelingPrepApi/Model/AdvancedData/FinancialScoreResponse.cs
@@ -0,0 +1,37 @@
+﻿using System.Text.Json.Serialization;
+
+namespace MatthiWare.FinancialModelingPrep.Model.AdvancedData
+{
+    public class FinancialScoreResponse
+    {
+        [JsonPropertyName("symbol")]
+        public string Symbol { get; set; }
+
+        [JsonPropertyName("altmanZScore")]
+        public double AltmanZScore { get; set; }
+
+        [JsonPropertyName("piotroskiScore")]
+        public int PiotroskiScore { get; set; }
+
+        [JsonPropertyName("workingCapital")]
+        public long WorkingCapital { get; set; }
+
+        [JsonPropertyName("totalAssets")]
+        public long TotalAssets { get; set; }
+
+        [JsonPropertyName("retainedEarnings")]
+        public long RetainedEarnings { get; set; }
+
+        [JsonPropertyName("ebit")]
+        public long Ebit { get; set; }
+
+        [JsonPropertyName("marketCap")]
+        public long MarketCap { get; set; }
+
+        [JsonPropertyName("totalLiabilities")]
+        public long TotalLiabilities { get; set; }
+
+        [JsonPropertyName("revenue")]
+        public long Revenue { get; set; }
+    }
+}
diff --git a/Tests/AdvancedData/AdvancedDataTests.cs b/Tests/AdvancedData/AdvancedDataTests.cs
@@ -98,7 +98,20 @@ public async Task GetESGScoreAsync()
 
             result.AssertNoErrors();
             Assert.NotEmpty(result.Data);
-            
+        }
+
+        [Theory]
+        [InlineData("AAPL")]
+        [InlineData("AGS.BR")]
+        [InlineData("PPL.TO")]
+        [InlineData("AAP")]
+        public async Task GetCompanyProfileTests(string symbol)
+        {
+            var result = await api.GetFinancialScoreAsync(symbol);
+
+            result.AssertNoErrors();
+
+            Assert.Equal(symbol, result.Data.Symbol);
         }
 
         private Task<ApiResponse<StandardIndustrialClassificationResponse>> GetStandardIndustrialClassSwitch(string by, string value)
diff --git a/Tests/Crypto/CryptoMarketTests.cs b/Tests/Crypto/CryptoMarketTests.cs
@@ -1,10 +1,11 @@
-﻿using MatthiWare.FinancialModelingPrep.Abstractions.StockMarket;
+﻿
+using MatthiWare.FinancialModelingPrep.Abstractions.Crypto;
 using Microsoft.Extensions.DependencyInjection;
 using System.Threading.Tasks;
 using Xunit;
 using Xunit.Abstractions;
 
-namespace Tests.StockMarket
+namespace Tests.Crypto
 {
     public class CryptoMarketTests : TestingBase
     {

Original file line number	Diff line number	Diff line change
`@@ -25,5 +25,7 @@ public interface IAdvancedDataProvider`
`25`	`25`	`Task<ApiResponse<SharesFloatResponse>> GetSharesFloatAsync(string symbol);`
`26`	`26`
`27`	`27`	`Task<ApiResponse<List<ESGScoreResponse>>> GetESGScoreAsync(string symbol);`
	`28`	`+`
	`29`	`+ Task<ApiResponse<FinancialScoreResponse>> GetFinancialScoreAsync(string symbol);`
`28`	`30`	`}`
`29`	`31`	`}`
Original file line number	Diff line number	Diff line change
`@@ -4,7 +4,7 @@`
`4`	`4`	`using System.Collections.Generic;`
`5`	`5`	`using System.Threading.Tasks;`
`6`	`6`
`7`		`-namespace MatthiWare.FinancialModelingPrep.Abstractions.StockMarket`
	`7`	`+namespace MatthiWare.FinancialModelingPrep.Abstractions.Crypto`
`8`	`8`	`{`
`9`	`9`	`public interface ICryptoMarketProvider`
`10`	`10`	`{`