Add Shares Float Endpoint

Author: Matthiee

FinancialModelingPrepApi/Abstractions/AdvancedData/IAdvancedDataProvider.cs

@@ -21,5 +21,7 @@ public interface IAdvancedDataProvider
         Task<ApiResponse<CompanyPeersResponse>> GetStockPeersAsync(string symbol);
         Task<ApiResponse<List<SectorPEResponse>>> GetSectorsPriceEarningsRatioAsync(string date, string exchange);
         Task<ApiResponse<List<IndustryPEResponse>>> GetIndustriesPriceEarningsRatioAsync(string date, string exchange);
+
+        Task<ApiResponse<SharesFloatResponse>> GetSharesFloatAsync(string symbol);
     }
 }

FinancialModelingPrepApi/Core/AdvancedData/AdvancedDataProvider.cs

@@ -136,5 +136,27 @@ private Task<ApiResponse<List<T>>> GetGenericPERationAsync<T>(string url, string
 
             return client.GetJsonAsync<List<T>>(url, pathParams, queryString);
         }
+
+        public async Task<ApiResponse<SharesFloatResponse>> GetSharesFloatAsync(string symbol)
+        {
+            const string url = "[version]/shares_float";
+
+            var pathParams = new NameValueCollection()
+            {
+                { "version", ApiVersion.v4.ToString() }
+            };
+
+            var queryString = new QueryStringBuilder();
+            queryString.Add("symbol", symbol);
+
+            var result = await client.GetJsonAsync<List<SharesFloatResponse>>(url, pathParams, queryString);
+
+            if (result.HasError)
+            {
+                return ApiResponse.FromError<SharesFloatResponse>(result.Error);
+            }
+
+            return ApiResponse.FromSucces(result.Data.First());
+        }
     }
 }

FinancialModelingPrepApi/Model/AdvancedData/SharesFloatResponse.cs

@@ -0,0 +1,25 @@
+using System.Text.Json.Serialization;
+
+namespace MatthiWare.FinancialModelingPrep.Model.AdvancedData
+{
+    public class SharesFloatResponse
+    {
+        [JsonPropertyName("symbol")]
+        public string Symbol { get; set; }
+
+        [JsonPropertyName("date")]
+        public string Date { get; set; }
+
+        [JsonPropertyName("freeFloat")]
+        public double FreeFloat { get; set; }
+
+        [JsonPropertyName("floatShares")]
+        public double FloatShares { get; set; }
+
+        [JsonPropertyName("outstandingShares")]
+        public double OutstandingShares { get; set; }
+
+        [JsonPropertyName("source")]
+        public string Source { get; set; }
+    }
+}

Tests/AdvancedData/AdvancedDataTests.cs

@@ -80,6 +80,17 @@ public async Task GetIndustriesPriceEarningsRatioAsync()
             Assert.NotEmpty(result.Data);
         }
 
+        [Fact]
+        public async Task GetSharesFloatAsync()
+        {
+            var result = await api.GetSharesFloatAsync("AAPL");
+
+            result.AssertNoErrors();
+            Assert.True(result.Data.FloatShares > 0);
+            Assert.True(result.Data.FreeFloat > 0);
+            Assert.True(result.Data.OutstandingShares > 0);
+        }
+
         private Task<ApiResponse<StandardIndustrialClassificationResponse>> GetStandardIndustrialClassSwitch(string by, string value)
         {
             return by switch