Skip to content

Commit

Permalink
Xml comments
Browse files Browse the repository at this point in the history
  • Loading branch information
@JKorf
JKorf committed Aug 7, 2024
1 parent f2e0d1e commit a8907b4
Show file tree
Hide file tree
Showing 5 changed files with 98 additions and 98 deletions.
20 changes: 10 additions & 10 deletions Mexc.Net/Interfaces/Clients/SpotApi/IMexcRestClientSpotApiAccount.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ public interface IMexcRestClientSpotApiAccount
/// Withdraw funds
/// <para><a href="https://mexcdevelop.github.io/apidocs/spot_v3_en/#withdraw-new" /></para>
/// </summary>
/// <param name="asset">Asset</param>
/// <param name="asset">Asset, for example `BTC`</param>
/// <param name="address">Address to withdraw to</param>
/// <param name="quantity">Quantity to withdraw</param>
/// <param name="clientOrderId">Order id</param>
Expand All @@ -59,7 +59,7 @@ public interface IMexcRestClientSpotApiAccount
/// Get deposit history
/// <para><a href="https://mexcdevelop.github.io/apidocs/spot_v3_en/#deposit-history-supporting-network" /></para>
/// </summary>
/// <param name="asset">Filter by asset</param>
/// <param name="asset">Filter by asset, for example `BTC`</param>
/// <param name="status">Filter by status</param>
/// <param name="startTime">Filter by start time</param>
/// <param name="endTime">Filter by end time</param>
Expand All @@ -72,7 +72,7 @@ public interface IMexcRestClientSpotApiAccount
/// Get withdrawal history
/// <para><a href="https://mexcdevelop.github.io/apidocs/spot_v3_en/#withdraw-history-supporting-network" /></para>
/// </summary>
/// <param name="asset">Filter by asset</param>
/// <param name="asset">Filter by asset, for example `BTC`</param>
/// <param name="status">Filter by status</param>
/// <param name="startTime">Filter by start time</param>
/// <param name="endTime">Filter by end time</param>
Expand All @@ -85,7 +85,7 @@ public interface IMexcRestClientSpotApiAccount
/// Generate a deposit address
/// <para><a href="https://mexcdevelop.github.io/apidocs/spot_v3_en/#generate-deposit-address-supporting-network" /></para>
/// </summary>
/// <param name="asset">Asset</param>
/// <param name="asset">Asset, for example `BTC`</param>
/// <param name="network">Network</param>
/// <param name="ct">Cancellation token</param>
/// <returns></returns>
Expand All @@ -95,7 +95,7 @@ public interface IMexcRestClientSpotApiAccount
/// Get deposit addresses
/// <para><a href="https://mexcdevelop.github.io/apidocs/spot_v3_en/#deposit-address-supporting-network" /></para>
/// </summary>
/// <param name="asset">Asset</param>
/// <param name="asset">Asset, for example `BTC`</param>
/// <param name="network">Filter by network</param>
/// <param name="ct">Cancellation token</param>
/// <returns></returns>
Expand All @@ -105,7 +105,7 @@ public interface IMexcRestClientSpotApiAccount
/// Get withdrawal addresses
/// <para><a href="https://mexcdevelop.github.io/apidocs/spot_v3_en/#withdraw-address-supporting-network" /></para>
/// </summary>
/// <param name="asset">Filter by asset</param>
/// <param name="asset">Filter by asset, for example `BTC`</param>
/// <param name="page">Page</param>
/// <param name="pageSize">Page size</param>
/// <param name="ct">Cancellation token</param>
Expand All @@ -116,7 +116,7 @@ public interface IMexcRestClientSpotApiAccount
/// Transfer between accounts
/// <para><a href="https://mexcdevelop.github.io/apidocs/spot_v3_en/#user-universal-transfer" /></para>
/// </summary>
/// <param name="asset">The asset to transfer</param>
/// <param name="asset">The asset to transfer, for example `BTC`</param>
/// <param name="fromAccountType">From account</param>
/// <param name="toAccountType">To account</param>
/// <param name="quantity">Quantity</param>
Expand Down Expand Up @@ -159,7 +159,7 @@ public interface IMexcRestClientSpotApiAccount
/// Convert small amount (dust) of certain assets to equal value Mx
/// <para><a href="https://mexcdevelop.github.io/apidocs/spot_v3_en/#dust-transfer" /></para>
/// </summary>
/// <param name="assets">Assets to convert</param>
/// <param name="assets">Assets to convert, for example `BTC`</param>
/// <param name="ct">Cancellation token</param>
/// <returns></returns>
Task<WebCallResult<MexcDustResult>> DustTransferAsync(IEnumerable<string> assets, CancellationToken ct = default);
Expand Down Expand Up @@ -197,13 +197,13 @@ public interface IMexcRestClientSpotApiAccount
/// Get trade fee for a symbol
/// <para><a href="https://mexcdevelop.github.io/apidocs/spot_v3_en/#query-symbol-commission" /></para>
/// </summary>
/// <param name="symbol">Symbol</param>
/// <param name="symbol">Symbol, for example `BTCUSDT`</param>
/// <param name="ct">Cancellation token</param>
/// <returns></returns>
Task<WebCallResult<MexcTradeFee>> GetTradeFeeAsync(string symbol, CancellationToken ct = default);

/// <summary>
/// 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 <see cref="KeepAliveUserStreamAsync">KeepAliveUserStreamAsync</see> is called.
/// <para><a href="https://mexcdevelop.github.io/apidocs/spot_v3_en/#listen-key" /></para>
/// </summary>
/// <param name="ct">Cancellation token</param>
Expand Down
20 changes: 10 additions & 10 deletions Mexc.Net/Interfaces/Clients/SpotApi/IMexcRestClientSpotApiExchangeData.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -33,15 +33,15 @@ public interface IMexcRestClientSpotApiExchangeData
/// Get a list of symbols supported by the API
/// <para><a href="https://mexcdevelop.github.io/apidocs/spot_v3_en/#api-default-symbol" /></para>
/// </summary>
/// <param name="ct"></param>
/// <param name="ct">Cancellation token</param>
/// <returns></returns>
Task<WebCallResult<IEnumerable<string>>> GetApiSymbolsAsync(CancellationToken ct = default);

/// <summary>
/// Get the exchange info, including symbol info
/// <para><a href="https://mexcdevelop.github.io/apidocs/spot_v3_en/#exchange-information" /></para>
/// </summary>
/// <param name="symbols">Filter by symbols</param>
/// <param name="symbols">Filter by symbols, for example `BTCUSDT`</param>
/// <param name="ct">Cancellation token</param>
/// <returns></returns>
Task<WebCallResult<MexcExchangeInfo>> GetExchangeInfoAsync(IEnumerable<string>? symbols = null, CancellationToken ct = default);
Expand All @@ -50,7 +50,7 @@ public interface IMexcRestClientSpotApiExchangeData
/// Get the current order book
/// <para><a href="https://mexcdevelop.github.io/apidocs/spot_v3_en/#order-book" /></para>
/// </summary>
/// <param name="symbol">The symbol</param>
/// <param name="symbol">The symbol, for example `BTCUSDT`</param>
/// <param name="limit">Number of rows, max 500</param>
/// <param name="ct">Cancellation token</param>
/// <returns></returns>
Expand All @@ -60,7 +60,7 @@ public interface IMexcRestClientSpotApiExchangeData
/// Get a list of the most recent trades
/// <para><a href="https://mexcdevelop.github.io/apidocs/spot_v3_en/#recent-trades-list" /></para>
/// </summary>
/// <param name="symbol">The symbol</param>
/// <param name="symbol">The symbol, for example `BTCUSDT`</param>
/// <param name="limit">Number of rows, max 1000</param>
/// <param name="ct">Cancellation token</param>
/// <returns></returns>
Expand All @@ -70,7 +70,7 @@ public interface IMexcRestClientSpotApiExchangeData
/// Get a list of aggregated trades
/// <para><a href="https://mexcdevelop.github.io/apidocs/spot_v3_en/#compressed-aggregate-trades-list" /></para>
/// </summary>
/// <param name="symbol">The symbol</param>
/// <param name="symbol">The symbol, for example `BTCUSDT`</param>
/// <param name="startTime">Filter by start time</param>
/// <param name="endTime">Filter by end time</param>
/// <param name="limit">Number of rows, max 1000</param>
Expand All @@ -82,7 +82,7 @@ public interface IMexcRestClientSpotApiExchangeData
/// Get kline/candlestick data
/// <para><a href="https://mexcdevelop.github.io/apidocs/spot_v3_en/#kline-candlestick-data" /></para>
/// </summary>
/// <param name="symbol">The symbol</param>
/// <param name="symbol">The symbol, for example `BTCUSDT`</param>
/// <param name="interval">Kline interval</param>
/// <param name="startTime">Filter by start time</param>
/// <param name="endTime">Filter by end time</param>
Expand All @@ -95,7 +95,7 @@ public interface IMexcRestClientSpotApiExchangeData
/// Get average price for a symbol
/// <para><a href="https://mexcdevelop.github.io/apidocs/spot_v3_en/#current-average-price" /></para>
/// </summary>
/// <param name="symbol">The symbol</param>
/// <param name="symbol">The symbol, for example `BTCUSDT`</param>
/// <param name="ct">Cancellation token</param>
/// <returns></returns>
Task<WebCallResult<MexcAveragePrice>> GetAveragePriceAsync(string symbol, CancellationToken ct = default);
Expand All @@ -104,7 +104,7 @@ public interface IMexcRestClientSpotApiExchangeData
/// Get 24h price statistics
/// <para><a href="https://mexcdevelop.github.io/apidocs/spot_v3_en/#24hr-ticker-price-change-statistics" /></para>
/// </summary>
/// <param name="symbol">The symbol</param>
/// <param name="symbol">The symbol, for example `BTCUSDT`</param>
/// <param name="ct">Cancellation token</param>
/// <returns></returns>
Task<WebCallResult<MexcTicker>> GetTickerAsync(string symbol, CancellationToken ct = default);
Expand All @@ -121,7 +121,7 @@ public interface IMexcRestClientSpotApiExchangeData
/// Get the last symbol prices
/// <para><a href="https://mexcdevelop.github.io/apidocs/spot_v3_en/#symbol-price-ticker" /></para>
/// </summary>
/// <param name="symbols">Filter by symbol</param>
/// <param name="symbols">Filter by symbol, for example `BTCUSDT`</param>
/// <param name="ct">Cancellation token</param>
/// <returns></returns>
Task<WebCallResult<IEnumerable<MexcPrice>>> GetPricesAsync(IEnumerable<string>? symbols = null, CancellationToken ct = default);
Expand All @@ -130,7 +130,7 @@ public interface IMexcRestClientSpotApiExchangeData
/// Get the best book prices
/// <para><a href="https://mexcdevelop.github.io/apidocs/spot_v3_en/#symbol-order-book-ticker" /></para>
/// </summary>
/// <param name="symbols">Filter by symbol</param>
/// <param name="symbols">Filter by symbol, for example `BTCUSDT`</param>
/// <param name="ct">Cancellation token</param>
/// <returns></returns>
Task<WebCallResult<IEnumerable<MexcBookPrice>>> GetBookPricesAsync(IEnumerable<string>? symbols = null, CancellationToken ct = default);
Expand Down
18 changes: 9 additions & 9 deletions Mexc.Net/Interfaces/Clients/SpotApi/IMexcRestClientSpotApiTrading.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ public interface IMexcRestClientSpotApiTrading
/// Place a new test order. Only validates the rules, doesn't actually place any order
/// <para><a href="https://mexcdevelop.github.io/apidocs/spot_v3_en/#test-new-order" /></para>
/// </summary>
/// <param name="symbol">The symbol</param>
/// <param name="symbol">The symbol, for example `BTCUSDT`</param>
/// <param name="side">Order side</param>
/// <param name="type">Order type</param>
/// <param name="quantity">Quantity</param>
Expand All @@ -32,7 +32,7 @@ public interface IMexcRestClientSpotApiTrading
/// Place a new order
/// <para><a href="https://mexcdevelop.github.io/apidocs/spot_v3_en/#new-order" /></para>
/// </summary>
/// <param name="symbol">The symbol</param>
/// <param name="symbol">The symbol, for example `BTCUSDT`</param>
/// <param name="side">Order side</param>
/// <param name="type">Order type</param>
/// <param name="quantity">Quantity</param>
Expand All @@ -47,7 +47,7 @@ public interface IMexcRestClientSpotApiTrading
/// Cancel an order
/// <para><a href="https://mexcdevelop.github.io/apidocs/spot_v3_en/#cancel-order" /></para>
/// </summary>
/// <param name="symbol">The symbol</param>
/// <param name="symbol">The symbol, for example `BTCUSDT`</param>
/// <param name="orderId">Cancel by order id</param>
/// <param name="clientOrderId">Cancel by client order id</param>
/// <param name="newClientOrderId">New client order id after canceled</param>
Expand All @@ -59,7 +59,7 @@ public interface IMexcRestClientSpotApiTrading
/// Cancel all orders on a symbol
/// <para><a href="https://mexcdevelop.github.io/apidocs/spot_v3_en/#cancel-all-open-orders-on-a-symbol" /></para>
/// </summary>
/// <param name="symbol">The symbol to close all orders on</param>
/// <param name="symbol">The symbol to close all orders on, for example `BTCUSDT`</param>
/// <param name="ct">Cancelation Token</param>
/// <returns></returns>
Task<WebCallResult<IEnumerable<MexcOrder>>> CancelAllOrdersAsync(string symbol, CancellationToken ct = default);
Expand All @@ -68,7 +68,7 @@ public interface IMexcRestClientSpotApiTrading
/// Cancel all orders on a symbol
/// <para><a href="https://mexcdevelop.github.io/apidocs/spot_v3_en/#cancel-all-open-orders-on-a-symbol" /></para>
/// </summary>
/// <param name="symbols">The symbols to close all orders on (max 5)</param>
/// <param name="symbols">The symbols to close all orders on (max 5), for example `BTCUSDT`</param>
/// <param name="ct">Cancelation Token</param>
/// <returns></returns>
Task<WebCallResult<IEnumerable<MexcOrder>>> CancelAllOrdersAsync(IEnumerable<string> symbols, CancellationToken ct = default);
Expand All @@ -77,7 +77,7 @@ public interface IMexcRestClientSpotApiTrading
/// Get an order
/// <para><a href="https://mexcdevelop.github.io/apidocs/spot_v3_en/#query-order" /></para>
/// </summary>
/// <param name="symbol">The symbol</param>
/// <param name="symbol">The symbol, for example `BTCUSDT`</param>
/// <param name="orderId">Get by order id</param>
/// <param name="clientOrderId">Get by client order id</param>
/// <param name="ct">Cancelation Token</param>
Expand All @@ -88,7 +88,7 @@ public interface IMexcRestClientSpotApiTrading
/// Get all open orders for a symbol
/// <para><a href="https://mexcdevelop.github.io/apidocs/spot_v3_en/#current-open-orders" /></para>
/// </summary>
/// <param name="symbol">Symbol</param>
/// <param name="symbol">Symbol, for example `BTCUSDT`</param>
/// <param name="ct">Cancelation Token</param>
/// <returns></returns>
Task<WebCallResult<IEnumerable<MexcOrder>>> GetOpenOrdersAsync(string symbol, CancellationToken ct = default);
Expand All @@ -97,7 +97,7 @@ public interface IMexcRestClientSpotApiTrading
/// Get all orders
/// <para><a href="https://mexcdevelop.github.io/apidocs/spot_v3_en/#all-orders" /></para>
/// </summary>
/// <param name="symbol">Symbol</param>
/// <param name="symbol">Symbol, for example `BTCUSDT`</param>
/// <param name="startTime">Filter by start time</param>
/// <param name="endTime">Filter by end time</param>
/// <param name="limit">Max results</param>
Expand All @@ -110,7 +110,7 @@ public interface IMexcRestClientSpotApiTrading
/// <para><a href="https://mexcdevelop.github.io/apidocs/spot_v3_en/#account-trade-list" /></para>
/// </summary>
/// <param name="orderId">Filter by order id</param>
/// <param name="symbol">Symbol</param>
/// <param name="symbol">Symbol, for example `BTCUSDT`</param>
/// <param name="startTime">Filter by start time</param>
/// <param name="endTime">Filter by end time</param>
/// <param name="limit">Max results</param>
Expand Down
Loading

0 comments on commit a8907b4

Please sign in to comment.