wip

2026-10-26 13:00:43 +00:00 · 2026-08-26 14:26:24 +02:00
parent d0ce2563de
commit d93d6b7a2e
213 changed files with 1173 additions and 560 deletions
@@ -0,0 +1,52 @@
+using CryptoExchange.Net.Objects;
+using System;
+using System.Collections.Generic;
+using System.Text;
+using System.Threading;
+using System.Threading.Tasks;
+
+namespace CryptoExchange.Net.SharedApis
+{
+    /// <summary>
+    /// Request definition for retrieving spot symbols from an exchange.
+    /// </summary>
+    public interface IGetSpotSymbolsEndpoint : ISharedApiEndpoint
+    {
+        /// <summary>
+        /// Get the spot symbol catalog. Only available if <see cref="GetSpotSymbolsAsync(GetSymbolsRequest, CancellationToken)"/> has been called previously.
+        /// </summary>
+        SharedSymbolCatalog? SpotSymbolCatalog { get; }
+
+        /// <summary>
+        /// Get all spot symbols for a specific base asset
+        /// </summary>
+        /// <param name="baseAsset">Asset, for example `ETH`</param>
+        Task<ExchangeCallResult<SharedSymbol[]>> GetSpotSymbolsForBaseAssetAsync(string baseAsset);
+
+        /// <summary>
+        /// Gets whether the client supports a spot symbol
+        /// </summary>
+        /// <param name="symbol">The symbol</param>
+        Task<ExchangeCallResult<bool>> SupportsSpotSymbolAsync(SharedSymbol symbol);
+
+        /// <summary>
+        /// Gets whether the client supports a spot symbol
+        /// </summary>
+        /// <param name="symbolName">The symbol name</param>
+        Task<ExchangeCallResult<bool>> SupportsSpotSymbolAsync(string symbolName);
+
+        /// <summary>
+        /// Spot symbols request options.<br />
+        /// Use <see cref="CapabilityOptions.RequiredRequestParameters"/>, <see cref="CapabilityOptions.RequiredExchangeParameters"/> and <see cref="CapabilityOptions.OptionalExchangeParameters"/> to check for required and optional parameters for the request. <br />
+        /// Exchange specific parameters can be added to the request via the `ExchangeParameters` property of the request object.
+        /// </summary>
+        GetSpotSymbolsOptions GetSpotSymbolsOptions { get; }
+
+        /// <summary>
+        /// Get info on all available spot symbols on the exchange, see <see cref="GetSpotSymbolsOptions"/> for request options and exchange specific required/optional parameters. <br />
+        /// </summary>
+        /// <param name="request">Request info</param>
+        /// <param name="ct">Cancellation token</param>
+        Task<HttpResult<SharedSpotSymbol[]>> GetSpotSymbolsAsync(GetSymbolsRequest request, CancellationToken ct = default);
+    }
+}