AdvancedDataProvider.cs

using MatthiWare.FinancialModelingPrep.Abstractions.AdvancedData;
using MatthiWare.FinancialModelingPrep.Core.Http;
using MatthiWare.FinancialModelingPrep.Model;
using MatthiWare.FinancialModelingPrep.Model.AdvancedData;
using System.Collections.Generic;
using System.Collections.Specialized;
using System.Linq;
using System.Threading.Tasks;

namespace MatthiWare.FinancialModelingPrep.Core.AdvancedData
{
    public class AdvancedDataProvider : IAdvancedDataProvider
    {
        private readonly FinancialModelingPrepHttpClient client;

        public AdvancedDataProvider(FinancialModelingPrepHttpClient client)
        {
            this.client = client ?? throw new System.ArgumentNullException(nameof(client));
        }

        public Task<ApiResponse<string>> GetAnnualReportsForm10KJsonAsync(string symbol, int year)
            => GetFinancialReportsJsonAsync(symbol, year, Period.Annual, null);

        public Task<ApiResponse<string>> GetQuarterlyReportsForm10QJsonAsync(string symbol, int year, Quarter quarter)
            => GetFinancialReportsJsonAsync(symbol, year, Period.Quarter, quarter);

        private Task<ApiResponse<string>> GetFinancialReportsJsonAsync(string symbol, int year, Period period, Quarter? quarter)
        {
            const string url = "[version]/financial-reports-json";

            var pathParams = new NameValueCollection()
            {
                { "version", ApiVersion.v4.ToString() }
            };

            var queryString = new QueryStringBuilder();
            queryString.Add("symbol", symbol);
            queryString.Add("year", year);

            if (period == Period.Quarter && quarter != null)
            {
                queryString.Add("period", quarter.Value.ToString());
            }
            else
            {
                queryString.Add("period", "FY");
            }

            return client.GetStringAsync(url, pathParams, queryString);
        }

        public Task<ApiResponse<StandardIndustrialClassificationResponse>> GetStandardIndustrialClassificationByCikAsync(string cik)
            => GetStandardIndustrialClassificationInternalAsync("cik", cik);

        public Task<ApiResponse<StandardIndustrialClassificationResponse>> GetStandardIndustrialClassificationBySicCodeAsync(string sic)
            => GetStandardIndustrialClassificationInternalAsync("sicCode", sic);

        public Task<ApiResponse<StandardIndustrialClassificationResponse>> GetStandardIndustrialClassificationBySymbolAsync(string symbol)
            => GetStandardIndustrialClassificationInternalAsync("symbol", symbol);

        private async Task<ApiResponse<StandardIndustrialClassificationResponse>> GetStandardIndustrialClassificationInternalAsync(string queryParamName, string queryParamValue)
        {
            const string url = "[version]/standard_industrial_classification";

            var pathParams = new NameValueCollection()
            {
                { "version", ApiVersion.v4.ToString() }
            };

            var queryString = new QueryStringBuilder();
            queryString.Add(queryParamName, queryParamValue);

            var result = await client.GetJsonAsync<List<StandardIndustrialClassificationResponse>>(url, pathParams, queryString);

            if (result.HasError)
            {
                return ApiResponse.FromError<StandardIndustrialClassificationResponse>(result.Error);
            }

            return ApiResponse.FromSuccess(result.Data.First());
        }

        public async Task<ApiResponse<List<CommitmentOfTradersResponse>>> GetCommitmentOfTradersReportAsync(string symbol)
        {
            const string url = "[version]/commitment_of_traders_report";

            var pathParams = new NameValueCollection()
                {
                    { "version", ApiVersion.v4.ToString() }
                };

            var queryString = new QueryStringBuilder();
            queryString.Add("symbol", symbol);

            var result = await client.GetJsonAsync<List<CommitmentOfTradersResponse>>(url, pathParams, queryString);

            if (result.HasError)
            {
                return ApiResponse.FromError<List<CommitmentOfTradersResponse>>(result.Error);
            }

            return ApiResponse.FromSuccess(result.Data);
        }

        public async Task<ApiResponse<List<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<List<FinancialScoreResponse>>(result.Error);
            }

            return ApiResponse.FromSuccess(result.Data);
        }

        public async Task<ApiResponse<CompanyPeersResponse>> GetStockPeersAsync(string symbol)
        {
            const string url = "[version]/stock_peers";

            var pathParams = new NameValueCollection()
            {
                { "version", ApiVersion.v4.ToString() }
            };

            var queryString = new QueryStringBuilder();
            queryString.Add("symbol", symbol);

            var result = await client.GetJsonAsync<List<CompanyPeersResponse>>(url, pathParams, queryString);

            if (result.HasError)
            {
                return ApiResponse.FromError<CompanyPeersResponse>(result.Error);
            }

            return ApiResponse.FromSuccess(result.Data.First());
        }

        public Task<ApiResponse<List<SectorPEResponse>>> GetSectorsPriceEarningsRatioAsync(string date, string exchange)
            => GetGenericPERationAsync<SectorPEResponse>("[version]/sector_price_earning_ratio", date, exchange);

            public Task<ApiResponse<List<IndustryPEResponse>>> GetIndustriesPriceEarningsRatioAsync(string date, string exchange)
            => GetGenericPERationAsync<IndustryPEResponse>("[version]/industry_price_earning_ratio", date, exchange);

        private Task<ApiResponse<List<T>>> GetGenericPERationAsync<T>(string url, string date, string exchange)
        {
            if (string.IsNullOrEmpty(url))
            {
                throw new System.ArgumentException($"'{nameof(url)}' cannot be null or empty.", nameof(url));
            }

            if (string.IsNullOrEmpty(date))
            {
                throw new System.ArgumentException($"'{nameof(date)}' cannot be null or empty.", nameof(date));
            }

            if (string.IsNullOrEmpty(exchange))
            {
                throw new System.ArgumentException($"'{nameof(exchange)}' cannot be null or empty.", nameof(exchange));
            }

            var pathParams = new NameValueCollection()
            {
                { "version", ApiVersion.v4.ToString() }
            };

            var queryString = new QueryStringBuilder();
            queryString.Add(nameof(date), date);
            queryString.Add(nameof(exchange), exchange);

            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.FromSuccess(result.Data.First());
        }

        public Task<ApiResponse<List<ESGScoreResponse>>> GetESGScoreAsync(string symbol)
        {
            const string url = "[version]/esg-environmental-social-governance-data";

            var pathParams = new NameValueCollection()
            {
                { "version", ApiVersion.v4.ToString() }
            };

            var queryString = new QueryStringBuilder();
            queryString.Add("symbol", symbol);

            return client.GetJsonAsync<List<ESGScoreResponse>>(url, pathParams, queryString);
        }
    }
}