feat: Support for top volume on last 24h endpoint (#34)

PR Close #34

Author: monsieurleberre

src/CryptoCompare/Clients/ITopsClient.cs

@@ -59,8 +59,20 @@ public interface ITopListClient : IApiClient
         /// <param name="page">(Optional)The pagination for the request.</param>
         /// <param name="sign">(Optional)If set to true, the server will sign the requests, this is useful for usage in smart contracts.</param>
         /// <returns>
-        /// The asynchronous result that yields a CoinListResponse.
+        /// The asynchronous result that yields a TopMarketCapResponse.
         /// </returns>
         Task<TopMarketCapResponse> CoinFullDataByMarketCap([NotNull] string toSymbol, int? limit = null, int? page = null, bool? sign = null);
+
+        /// <summary>
+        /// Get full data for the top coins ordered by their total volume across all markets in the last 24 hours as expressed in a given currency.
+        /// </summary>
+        /// <param name="toSymbol">The symbol of the currency into which the market cap are expressed.</param>
+        /// <param name="limit">(Optional)The number currencies to return, default is 10.</param>
+        /// <param name="page">(Optional)The pagination for the request.</param>
+        /// <param name="sign">(Optional)If set to true, the server will sign the requests, this is useful for usage in smart contracts.</param>
+        /// <returns>
+        /// The asynchronous result that yields a TopVolume24HResponse.
+        /// </returns>
+        Task<TopVolume24HResponse> CoinFullDataBy24HVolume(string toSymbol, int? limit = null, int? page = null, bool? sign = null);
     }
 }

src/CryptoCompare/Clients/TopsClient.cs

@@ -103,13 +103,30 @@ public async Task<TopExchangeFullResponse> ExchangesFullDataByPairAsync(string f
         /// <param name="page">(Optional)The pagination for the request.</param>
         /// <param name="sign">(Optional)If set to true, the server will sign the requests, this is useful for usage in smart contracts.</param>
         /// <returns>
-        /// The asynchronous result that yields a CoinListResponse.
+        /// The asynchronous result that yields a TopMarketCapResponse.
         /// </returns>
-        /// <seealso cref="M:CryptoCompare.ITopListClient.ExchangesFullDataByMarketCap(string,int?,int?,bool?)"/>
+        /// <seealso cref="M:CryptoCompare.ITopListClient.CoinFullDataByMarketCap(string,int?,int?,bool?)"/>
         public async Task<TopMarketCapResponse> CoinFullDataByMarketCap(string toSymbol, int? limit = null, int? page = null, bool? sign = null)
         {
             Check.NotNullOrWhiteSpace(toSymbol, nameof(toSymbol));
             return await this.GetAsync<TopMarketCapResponse>(ApiUrls.TopByMarketCapFull(toSymbol, limit, page, sign)).ConfigureAwait(false);
         }
+
+        /// <summary>
+        /// Get full data for the top coins ordered by their total volume across all markets in the last 24 hours as expressed in a given currency.
+        /// </summary>
+        /// <param name="toSymbol">The symbol of the currency into which the market cap are expressed.</param>
+        /// <param name="limit">(Optional)The number currencies to return, default is 10.</param>
+        /// <param name="page">(Optional)The pagination for the request.</param>
+        /// <param name="sign">(Optional)If set to true, the server will sign the requests, this is useful for usage in smart contracts.</param>
+        /// <returns>
+        /// The asynchronous result that yields a TopVolume24HResponse.
+        /// </returns>
+        /// <seealso cref="M:CryptoCompare.ITopListClient.CoinFullDataBy24HVolume(string,int?,int?,bool?)"/>
+        public async Task<TopVolume24HResponse> CoinFullDataBy24HVolume(string toSymbol, int? limit = null, int? page = null, bool? sign = null)
+        {
+            Check.NotNullOrWhiteSpace(toSymbol, nameof(toSymbol));
+            return await this.GetAsync<TopVolume24HResponse>(ApiUrls.TopByVolume24HFull(toSymbol, limit, page, sign)).ConfigureAwait(false);
+        }
     }
 }

src/CryptoCompare/Core/ApiUrls.cs

@@ -297,6 +297,19 @@ public static Uri TopByPairVolume([NotNull] string tsym, int? limit)
                 });
         }
 
+        public static Uri TopByVolume24HFull([NotNull] string tsym, int? limit, int? page, bool? sign)
+        {
+            Check.NotNullOrWhiteSpace(tsym, nameof(tsym));
+            return new Uri(MinApiEndpoint, "top/totalvolfull").ApplyParameters(
+                new Dictionary<string, string>
+                {
+                    { nameof(tsym), tsym },
+                    { nameof(limit), limit?.ToString() },
+                    { nameof(page), page?.ToString() },
+                    { nameof(sign), sign?.ToString().ToLowerInvariant() }
+                });
+        }
+
         public static Uri TopByMarketCapFull([NotNull] string tsym, int? limit, int? page, bool? sign)
         {
             Check.NotNullOrWhiteSpace(tsym, nameof(tsym));

src/CryptoCompare/Models/Responses/TopVolume24HInfo.cs

@@ -0,0 +1,15 @@
+using Newtonsoft.Json;
+
+namespace CryptoCompare
+{
+    public class TopVolume24HInfo
+    {
+        public CoinInfo CoinInfo { get; set; }
+
+        [JsonProperty("DISPLAY")]
+        public Volume24HDisplay Display { get; set; }
+
+        [JsonProperty("RAW")]
+        public Volume24HRaw Raw { get; set; }
+    }
+}

src/CryptoCompare/Models/Responses/TopVolume24HResponse.cs

@@ -0,0 +1,11 @@
+using System.Collections.Generic;
+
+using Newtonsoft.Json;
+
+namespace CryptoCompare
+{
+    public class TopVolume24HResponse : BaseApiResponse
+    {
+        public IReadOnlyList<TopVolume24HInfo> Data { get; set; }
+    }
+}

src/CryptoCompare/Models/Responses/Volume24HDisplay.cs

@@ -0,0 +1,13 @@
+using System.Collections.Generic;
+using System.Collections.ObjectModel;
+
+namespace CryptoCompare
+{
+    public class Volume24HDisplay : ReadOnlyDictionary<string, CoinFullAggregatedDataDisplay>
+    {
+        public Volume24HDisplay(IDictionary<string, CoinFullAggregatedDataDisplay> dictionary)
+            : base(dictionary)
+        {
+        }
+    }
+}

src/CryptoCompare/Models/Responses/Volume24HRaw.cs

@@ -0,0 +1,13 @@
+using System.Collections.Generic;
+using System.Collections.ObjectModel;
+
+namespace CryptoCompare
+{
+    public class Volume24HRaw : ReadOnlyDictionary<string, CoinFullAggregatedData>
+    {
+        public Volume24HRaw(IDictionary<string, CoinFullAggregatedData> dictionary)
+            : base(dictionary)
+        {
+        }
+    }
+}

test/Cryptocompare.Integration.Tests/Clients/TopListClientTests.cs

@@ -42,5 +42,12 @@ public async Task CanCallTopListCoinFullDataByMarketCap()
             var result = await CryptoCompareClient.Instance.Tops.CoinFullDataByMarketCap("EUR", 20);
             Assert.NotNull(result);
         }
+
+        [Fact]
+        public async Task CanCallTopListCoinFullDataBy24HVolume()
+        {
+            var result = await CryptoCompareClient.Instance.Tops.CoinFullDataBy24HVolume("EUR", 20);
+            Assert.NotNull(result);
+        }
     }
 }