diff --git a/Mexc.Net/Interfaces/Clients/SpotApi/IMexcRestClientSpotApiAccount.cs b/Mexc.Net/Interfaces/Clients/SpotApi/IMexcRestClientSpotApiAccount.cs index 4893b28..ee4f49b 100644 --- a/Mexc.Net/Interfaces/Clients/SpotApi/IMexcRestClientSpotApiAccount.cs +++ b/Mexc.Net/Interfaces/Clients/SpotApi/IMexcRestClientSpotApiAccount.cs @@ -34,7 +34,7 @@ public interface IMexcRestClientSpotApiAccount /// Withdraw funds /// /// - /// Asset + /// Asset, for example `BTC` /// Address to withdraw to /// Quantity to withdraw /// Order id @@ -59,7 +59,7 @@ public interface IMexcRestClientSpotApiAccount /// Get deposit history /// /// - /// Filter by asset + /// Filter by asset, for example `BTC` /// Filter by status /// Filter by start time /// Filter by end time @@ -72,7 +72,7 @@ public interface IMexcRestClientSpotApiAccount /// Get withdrawal history /// /// - /// Filter by asset + /// Filter by asset, for example `BTC` /// Filter by status /// Filter by start time /// Filter by end time @@ -85,7 +85,7 @@ public interface IMexcRestClientSpotApiAccount /// Generate a deposit address /// /// - /// Asset + /// Asset, for example `BTC` /// Network /// Cancellation token /// @@ -95,7 +95,7 @@ public interface IMexcRestClientSpotApiAccount /// Get deposit addresses /// /// - /// Asset + /// Asset, for example `BTC` /// Filter by network /// Cancellation token /// @@ -105,7 +105,7 @@ public interface IMexcRestClientSpotApiAccount /// Get withdrawal addresses /// /// - /// Filter by asset + /// Filter by asset, for example `BTC` /// Page /// Page size /// Cancellation token @@ -116,7 +116,7 @@ public interface IMexcRestClientSpotApiAccount /// Transfer between accounts /// /// - /// The asset to transfer + /// The asset to transfer, for example `BTC` /// From account /// To account /// Quantity @@ -159,7 +159,7 @@ public interface IMexcRestClientSpotApiAccount /// Convert small amount (dust) of certain assets to equal value Mx /// /// - /// Assets to convert + /// Assets to convert, for example `BTC` /// Cancellation token /// Task> DustTransferAsync(IEnumerable assets, CancellationToken ct = default); @@ -197,13 +197,13 @@ public interface IMexcRestClientSpotApiAccount /// Get trade fee for a symbol /// /// - /// Symbol + /// Symbol, for example `BTCUSDT` /// Cancellation token /// Task> GetTradeFeeAsync(string symbol, CancellationToken ct = default); /// - /// Start a user data stream for accessing private socket streams + /// Starts a user stream by requesting a listen key. This listen key can be used in a subsequent request to user subscribe methods in the socket client. The stream will close after 60 minutes unless KeepAliveUserStreamAsync is called. /// /// /// Cancellation token diff --git a/Mexc.Net/Interfaces/Clients/SpotApi/IMexcRestClientSpotApiExchangeData.cs b/Mexc.Net/Interfaces/Clients/SpotApi/IMexcRestClientSpotApiExchangeData.cs index 0e3e769..1e3fc49 100644 --- a/Mexc.Net/Interfaces/Clients/SpotApi/IMexcRestClientSpotApiExchangeData.cs +++ b/Mexc.Net/Interfaces/Clients/SpotApi/IMexcRestClientSpotApiExchangeData.cs @@ -33,7 +33,7 @@ public interface IMexcRestClientSpotApiExchangeData /// Get a list of symbols supported by the API /// /// - /// + /// Cancellation token /// Task>> GetApiSymbolsAsync(CancellationToken ct = default); @@ -41,7 +41,7 @@ public interface IMexcRestClientSpotApiExchangeData /// Get the exchange info, including symbol info /// /// - /// Filter by symbols + /// Filter by symbols, for example `BTCUSDT` /// Cancellation token /// Task> GetExchangeInfoAsync(IEnumerable? symbols = null, CancellationToken ct = default); @@ -50,7 +50,7 @@ public interface IMexcRestClientSpotApiExchangeData /// Get the current order book /// /// - /// The symbol + /// The symbol, for example `BTCUSDT` /// Number of rows, max 500 /// Cancellation token /// @@ -60,7 +60,7 @@ public interface IMexcRestClientSpotApiExchangeData /// Get a list of the most recent trades /// /// - /// The symbol + /// The symbol, for example `BTCUSDT` /// Number of rows, max 1000 /// Cancellation token /// @@ -70,7 +70,7 @@ public interface IMexcRestClientSpotApiExchangeData /// Get a list of aggregated trades /// /// - /// The symbol + /// The symbol, for example `BTCUSDT` /// Filter by start time /// Filter by end time /// Number of rows, max 1000 @@ -82,7 +82,7 @@ public interface IMexcRestClientSpotApiExchangeData /// Get kline/candlestick data /// /// - /// The symbol + /// The symbol, for example `BTCUSDT` /// Kline interval /// Filter by start time /// Filter by end time @@ -95,7 +95,7 @@ public interface IMexcRestClientSpotApiExchangeData /// Get average price for a symbol /// /// - /// The symbol + /// The symbol, for example `BTCUSDT` /// Cancellation token /// Task> GetAveragePriceAsync(string symbol, CancellationToken ct = default); @@ -104,7 +104,7 @@ public interface IMexcRestClientSpotApiExchangeData /// Get 24h price statistics /// /// - /// The symbol + /// The symbol, for example `BTCUSDT` /// Cancellation token /// Task> GetTickerAsync(string symbol, CancellationToken ct = default); @@ -121,7 +121,7 @@ public interface IMexcRestClientSpotApiExchangeData /// Get the last symbol prices /// /// - /// Filter by symbol + /// Filter by symbol, for example `BTCUSDT` /// Cancellation token /// Task>> GetPricesAsync(IEnumerable? symbols = null, CancellationToken ct = default); @@ -130,7 +130,7 @@ public interface IMexcRestClientSpotApiExchangeData /// Get the best book prices /// /// - /// Filter by symbol + /// Filter by symbol, for example `BTCUSDT` /// Cancellation token /// Task>> GetBookPricesAsync(IEnumerable? symbols = null, CancellationToken ct = default); diff --git a/Mexc.Net/Interfaces/Clients/SpotApi/IMexcRestClientSpotApiTrading.cs b/Mexc.Net/Interfaces/Clients/SpotApi/IMexcRestClientSpotApiTrading.cs index d87c7dd..c063ee2 100644 --- a/Mexc.Net/Interfaces/Clients/SpotApi/IMexcRestClientSpotApiTrading.cs +++ b/Mexc.Net/Interfaces/Clients/SpotApi/IMexcRestClientSpotApiTrading.cs @@ -17,7 +17,7 @@ public interface IMexcRestClientSpotApiTrading /// Place a new test order. Only validates the rules, doesn't actually place any order /// /// - /// The symbol + /// The symbol, for example `BTCUSDT` /// Order side /// Order type /// Quantity @@ -32,7 +32,7 @@ public interface IMexcRestClientSpotApiTrading /// Place a new order /// /// - /// The symbol + /// The symbol, for example `BTCUSDT` /// Order side /// Order type /// Quantity @@ -47,7 +47,7 @@ public interface IMexcRestClientSpotApiTrading /// Cancel an order /// /// - /// The symbol + /// The symbol, for example `BTCUSDT` /// Cancel by order id /// Cancel by client order id /// New client order id after canceled @@ -59,7 +59,7 @@ public interface IMexcRestClientSpotApiTrading /// Cancel all orders on a symbol /// /// - /// The symbol to close all orders on + /// The symbol to close all orders on, for example `BTCUSDT` /// Cancelation Token /// Task>> CancelAllOrdersAsync(string symbol, CancellationToken ct = default); @@ -68,7 +68,7 @@ public interface IMexcRestClientSpotApiTrading /// Cancel all orders on a symbol /// /// - /// The symbols to close all orders on (max 5) + /// The symbols to close all orders on (max 5), for example `BTCUSDT` /// Cancelation Token /// Task>> CancelAllOrdersAsync(IEnumerable symbols, CancellationToken ct = default); @@ -77,7 +77,7 @@ public interface IMexcRestClientSpotApiTrading /// Get an order /// /// - /// The symbol + /// The symbol, for example `BTCUSDT` /// Get by order id /// Get by client order id /// Cancelation Token @@ -88,7 +88,7 @@ public interface IMexcRestClientSpotApiTrading /// Get all open orders for a symbol /// /// - /// Symbol + /// Symbol, for example `BTCUSDT` /// Cancelation Token /// Task>> GetOpenOrdersAsync(string symbol, CancellationToken ct = default); @@ -97,7 +97,7 @@ public interface IMexcRestClientSpotApiTrading /// Get all orders /// /// - /// Symbol + /// Symbol, for example `BTCUSDT` /// Filter by start time /// Filter by end time /// Max results @@ -110,7 +110,7 @@ public interface IMexcRestClientSpotApiTrading /// /// /// Filter by order id - /// Symbol + /// Symbol, for example `BTCUSDT` /// Filter by start time /// Filter by end time /// Max results diff --git a/Mexc.Net/Interfaces/Clients/SpotApi/IMexcSocketClientSpotApi.cs b/Mexc.Net/Interfaces/Clients/SpotApi/IMexcSocketClientSpotApi.cs index bbe03b5..b548556 100644 --- a/Mexc.Net/Interfaces/Clients/SpotApi/IMexcSocketClientSpotApi.cs +++ b/Mexc.Net/Interfaces/Clients/SpotApi/IMexcSocketClientSpotApi.cs @@ -20,7 +20,7 @@ public interface IMexcSocketClientSpotApi: ISocketApiClient /// Subscribe to trade updates /// /// - /// The symbol + /// The symbol, for example `BTCUSDT` /// Data handler /// Cancellation token /// @@ -30,9 +30,9 @@ public interface IMexcSocketClientSpotApi: ISocketApiClient /// Subscribe to trade updates /// /// - /// - /// - /// + /// The symbols to subscribe, for example `BTCUSDT` + /// Data handler + /// Cancellation token /// Task> SubscribeToTradeUpdatesAsync(IEnumerable symbols, Action>> handler, CancellationToken ct = default); @@ -40,7 +40,7 @@ public interface IMexcSocketClientSpotApi: ISocketApiClient /// Subscribe to kline/candlestick updates /// /// - /// The symbol + /// The symbol, for example `BTCUSDT` /// The interval of the candles /// Data handler /// Cancellation token @@ -51,7 +51,7 @@ public interface IMexcSocketClientSpotApi: ISocketApiClient /// Subscribe to kline/candlestick updates /// /// - /// The symbols + /// The symbols, for example `BTCUSDT` /// The interval of the candles /// Data handler /// Cancellation token @@ -62,7 +62,7 @@ public interface IMexcSocketClientSpotApi: ISocketApiClient /// Subscribe to orderbook change updates /// /// - /// The symbol + /// The symbol, for example `BTCUSDT` /// Data handler /// Cancellation token /// @@ -72,7 +72,7 @@ public interface IMexcSocketClientSpotApi: ISocketApiClient /// Subscribe to orderbook change updates /// /// - /// The symbols + /// The symbols, for example `BTCUSDT` /// Data handler /// Cancellation token /// @@ -82,7 +82,7 @@ public interface IMexcSocketClientSpotApi: ISocketApiClient /// Subscribe to full orderbook updates /// /// - /// The symbol + /// The symbol, for example `BTCUSDT` /// The depth of the book, 5, 10 or 20 /// Data handler /// Cancellation token @@ -93,7 +93,7 @@ public interface IMexcSocketClientSpotApi: ISocketApiClient /// Subscribe to full orderbook updates /// /// - /// The symbols + /// The symbols, for example `BTCUSDT` /// The depth of the book, 5, 10 or 20 /// Data handler /// Cancellation token @@ -104,7 +104,7 @@ public interface IMexcSocketClientSpotApi: ISocketApiClient /// Subscribe to book ticker (best bid/ask) updates /// /// - /// The symbol + /// The symbol, for example `BTCUSDT` /// Data handler /// Cancellation token /// @@ -114,7 +114,7 @@ public interface IMexcSocketClientSpotApi: ISocketApiClient /// Subscribe to book ticker (best bid/ask) updates /// /// - /// The symbols + /// The symbols, for example `BTCUSDT` /// Data handler /// Cancellation token /// @@ -124,7 +124,7 @@ public interface IMexcSocketClientSpotApi: ISocketApiClient /// Subscribe to mini ticker updates /// /// - /// The symbol + /// The symbol, for example `BTCUSDT` /// The timezone to base the statistics on, in the vorm of `UTC+1`. Defaults to `UTC+0` /// Data handler /// Cancellation token @@ -135,7 +135,7 @@ public interface IMexcSocketClientSpotApi: ISocketApiClient /// Subscribe to mini ticker updates /// /// - /// The symbols + /// The symbols, for example `BTCUSDT` /// The timezone to base the statistics on, in the vorm of `UTC+1`. Defaults to `UTC+0` /// Data handler /// Cancellation token @@ -153,30 +153,30 @@ public interface IMexcSocketClientSpotApi: ISocketApiClient Task> SubscribeToMiniTickerUpdatesAsync(Action>> handler, string? timezone = null, CancellationToken ct = default); /// - /// Subscribe to account balance updates. Listenkey can be retrieved by calling `SpotApi.Account.StartUserStreamAsync()` on the `MexcRestClient` + /// Subscribe to account balance updates. Prior to using this, the restClient.SpotApi.Account.StartUserStreamAsync method should be called to start the stream and obtaining a listen key. /// /// - /// Listen key + /// Listen key retrieved by the restClient.SpotApi.Account.StartUserStreamAsync method /// Data handler /// Cancellation token /// Task> SubscribeToAccountUpdatesAsync(string listenKey, Action> handler, CancellationToken ct = default); /// - /// Subscribe to account order updates. Listenkey can be retrieved by calling `SpotApi.Account.StartUserStreamAsync()` on the `MexcRestClient` + /// Subscribe to account order updates. Prior to using this, the restClient.SpotApi.Account.StartUserStreamAsync method should be called to start the stream and obtaining a listen key. /// /// - /// Listen key + /// Listen key retrieved by the restClient.SpotApi.Account.StartUserStreamAsync method /// Data handler /// Cancellation token /// Task> SubscribeToOrderUpdatesAsync(string listenKey, Action> handler, CancellationToken ct = default); /// - /// Subscribe to account trade updates. Listenkey can be retrieved by calling `SpotApi.Account.StartUserStreamAsync()` on the `MexcRestClient` + /// Subscribe to account trade updates. Prior to using this, the restClient.SpotApi.Account.StartUserStreamAsync method should be called to start the stream and obtaining a listen key. /// /// - /// Listen key + /// Listen key retrieved by the restClient.SpotApi.Account.StartUserStreamAsync method /// Data handler /// Cancellation token /// diff --git a/Mexc.Net/Mexc.Net.xml b/Mexc.Net/Mexc.Net.xml index 97eca3b..bc9b9f4 100644 --- a/Mexc.Net/Mexc.Net.xml +++ b/Mexc.Net/Mexc.Net.xml @@ -680,7 +680,7 @@ Withdraw funds - Asset + Asset, for example `BTC` Address to withdraw to Quantity to withdraw Order id @@ -705,7 +705,7 @@ Get deposit history - Filter by asset + Filter by asset, for example `BTC` Filter by status Filter by start time Filter by end time @@ -718,7 +718,7 @@ Get withdrawal history - Filter by asset + Filter by asset, for example `BTC` Filter by status Filter by start time Filter by end time @@ -731,7 +731,7 @@ Generate a deposit address - Asset + Asset, for example `BTC` Network Cancellation token @@ -741,7 +741,7 @@ Get deposit addresses - Asset + Asset, for example `BTC` Filter by network Cancellation token @@ -751,7 +751,7 @@ Get withdrawal addresses - Filter by asset + Filter by asset, for example `BTC` Page Page size Cancellation token @@ -762,7 +762,7 @@ Transfer between accounts - The asset to transfer + The asset to transfer, for example `BTC` From account To account Quantity @@ -805,7 +805,7 @@ Convert small amount (dust) of certain assets to equal value Mx - Assets to convert + Assets to convert, for example `BTC` Cancellation token @@ -843,13 +843,13 @@ Get trade fee for a symbol - Symbol + Symbol, for example `BTCUSDT` Cancellation token - Start a user data stream for accessing private socket streams + Starts a user stream by requesting a listen key. This listen key can be used in a subsequent request to user subscribe methods in the socket client. The stream will close after 60 minutes unless KeepAliveUserStreamAsync is called. Cancellation token @@ -899,7 +899,7 @@ Get a list of symbols supported by the API - + Cancellation token @@ -907,7 +907,7 @@ Get the exchange info, including symbol info - Filter by symbols + Filter by symbols, for example `BTCUSDT` Cancellation token @@ -916,7 +916,7 @@ Get the current order book - The symbol + The symbol, for example `BTCUSDT` Number of rows, max 500 Cancellation token @@ -926,7 +926,7 @@ Get a list of the most recent trades - The symbol + The symbol, for example `BTCUSDT` Number of rows, max 1000 Cancellation token @@ -936,7 +936,7 @@ Get a list of aggregated trades - The symbol + The symbol, for example `BTCUSDT` Filter by start time Filter by end time Number of rows, max 1000 @@ -948,7 +948,7 @@ Get kline/candlestick data - The symbol + The symbol, for example `BTCUSDT` Kline interval Filter by start time Filter by end time @@ -961,7 +961,7 @@ Get average price for a symbol - The symbol + The symbol, for example `BTCUSDT` Cancellation token @@ -970,7 +970,7 @@ Get 24h price statistics - The symbol + The symbol, for example `BTCUSDT` Cancellation token @@ -987,7 +987,7 @@ Get the last symbol prices - Filter by symbol + Filter by symbol, for example `BTCUSDT` Cancellation token @@ -996,7 +996,7 @@ Get the best book prices - Filter by symbol + Filter by symbol, for example `BTCUSDT` Cancellation token @@ -1010,7 +1010,7 @@ Place a new test order. Only validates the rules, doesn't actually place any order - The symbol + The symbol, for example `BTCUSDT` Order side Order type Quantity @@ -1025,7 +1025,7 @@ Place a new order - The symbol + The symbol, for example `BTCUSDT` Order side Order type Quantity @@ -1040,7 +1040,7 @@ Cancel an order - The symbol + The symbol, for example `BTCUSDT` Cancel by order id Cancel by client order id New client order id after canceled @@ -1052,7 +1052,7 @@ Cancel all orders on a symbol - The symbol to close all orders on + The symbol to close all orders on, for example `BTCUSDT` Cancelation Token @@ -1061,7 +1061,7 @@ Cancel all orders on a symbol - The symbols to close all orders on (max 5) + The symbols to close all orders on (max 5), for example `BTCUSDT` Cancelation Token @@ -1070,7 +1070,7 @@ Get an order - The symbol + The symbol, for example `BTCUSDT` Get by order id Get by client order id Cancelation Token @@ -1081,7 +1081,7 @@ Get all open orders for a symbol - Symbol + Symbol, for example `BTCUSDT` Cancelation Token @@ -1090,7 +1090,7 @@ Get all orders - Symbol + Symbol, for example `BTCUSDT` Filter by start time Filter by end time Max results @@ -1103,7 +1103,7 @@ Filter by order id - Symbol + Symbol, for example `BTCUSDT` Filter by start time Filter by end time Max results @@ -1120,7 +1120,7 @@ Subscribe to trade updates - The symbol + The symbol, for example `BTCUSDT` Data handler Cancellation token @@ -1130,9 +1130,9 @@ Subscribe to trade updates - - - + The symbols to subscribe, for example `BTCUSDT` + Data handler + Cancellation token @@ -1140,7 +1140,7 @@ Subscribe to kline/candlestick updates - The symbol + The symbol, for example `BTCUSDT` The interval of the candles Data handler Cancellation token @@ -1151,7 +1151,7 @@ Subscribe to kline/candlestick updates - The symbols + The symbols, for example `BTCUSDT` The interval of the candles Data handler Cancellation token @@ -1162,7 +1162,7 @@ Subscribe to orderbook change updates - The symbol + The symbol, for example `BTCUSDT` Data handler Cancellation token @@ -1172,7 +1172,7 @@ Subscribe to orderbook change updates - The symbols + The symbols, for example `BTCUSDT` Data handler Cancellation token @@ -1182,7 +1182,7 @@ Subscribe to full orderbook updates - The symbol + The symbol, for example `BTCUSDT` The depth of the book, 5, 10 or 20 Data handler Cancellation token @@ -1193,7 +1193,7 @@ Subscribe to full orderbook updates - The symbols + The symbols, for example `BTCUSDT` The depth of the book, 5, 10 or 20 Data handler Cancellation token @@ -1204,7 +1204,7 @@ Subscribe to book ticker (best bid/ask) updates - The symbol + The symbol, for example `BTCUSDT` Data handler Cancellation token @@ -1214,7 +1214,7 @@ Subscribe to book ticker (best bid/ask) updates - The symbols + The symbols, for example `BTCUSDT` Data handler Cancellation token @@ -1224,7 +1224,7 @@ Subscribe to mini ticker updates - The symbol + The symbol, for example `BTCUSDT` The timezone to base the statistics on, in the vorm of `UTC+1`. Defaults to `UTC+0` Data handler Cancellation token @@ -1235,7 +1235,7 @@ Subscribe to mini ticker updates - The symbols + The symbols, for example `BTCUSDT` The timezone to base the statistics on, in the vorm of `UTC+1`. Defaults to `UTC+0` Data handler Cancellation token @@ -1253,30 +1253,30 @@ - Subscribe to account balance updates. Listenkey can be retrieved by calling `SpotApi.Account.StartUserStreamAsync()` on the `MexcRestClient` + Subscribe to account balance updates. Prior to using this, the restClient.SpotApi.Account.StartUserStreamAsync method should be called to start the stream and obtaining a listen key. - Listen key + Listen key retrieved by the restClient.SpotApi.Account.StartUserStreamAsync method Data handler Cancellation token - Subscribe to account order updates. Listenkey can be retrieved by calling `SpotApi.Account.StartUserStreamAsync()` on the `MexcRestClient` + Subscribe to account order updates. Prior to using this, the restClient.SpotApi.Account.StartUserStreamAsync method should be called to start the stream and obtaining a listen key. - Listen key + Listen key retrieved by the restClient.SpotApi.Account.StartUserStreamAsync method Data handler Cancellation token - Subscribe to account trade updates. Listenkey can be retrieved by calling `SpotApi.Account.StartUserStreamAsync()` on the `MexcRestClient` + Subscribe to account trade updates. Prior to using this, the restClient.SpotApi.Account.StartUserStreamAsync method should be called to start the stream and obtaining a listen key. - Listen key + Listen key retrieved by the restClient.SpotApi.Account.StartUserStreamAsync method Data handler Cancellation token