From 9bb951e6900eb9f1d52b630c4b12ae6c2dbb78db Mon Sep 17 00:00:00 2001 From: JKorf Date: Tue, 6 Aug 2024 21:55:53 +0200 Subject: [PATCH] Xml comments --- CoinEx.Net/CoinEx.Net.xml | 188 +++++++++--------- .../ICoinExRestClientFuturesApiAccount.cs | 4 +- ...ICoinExRestClientFuturesApiExchangeData.cs | 26 +-- .../ICoinExRestClientFuturesApiTrading.cs | 52 ++--- .../ICoinExSocketClientFuturesApi.cs | 18 +- .../ICoinExRestClientSpotApiAccount.cs | 30 +-- .../ICoinExRestClientSpotApiExchangeData.cs | 10 +- .../ICoinExRestClientSpotApiTrading.cs | 32 +-- .../SpotApiV2/ICoinExSocketClientSpotApi.cs | 18 +- 9 files changed, 189 insertions(+), 189 deletions(-) diff --git a/CoinEx.Net/CoinEx.Net.xml b/CoinEx.Net/CoinEx.Net.xml index d6de8d3..848eeef 100644 --- a/CoinEx.Net/CoinEx.Net.xml +++ b/CoinEx.Net/CoinEx.Net.xml @@ -1591,7 +1591,7 @@ Get trading fees for a symbol - Symbol + Symbol, for example `ETHUSDT` Cancelation token @@ -1608,7 +1608,7 @@ Set leverage for a symbol - Symbol + Symbol, for example `ETHUSDT` Margin mode Leverage Cancelation token @@ -1632,7 +1632,7 @@ Get list of support symbols - Filter by symbol name; max 10 + Filter by symbol name; max 10, for example `ETHUSDT` Cancelation token @@ -1641,7 +1641,7 @@ Get symbol tickers - Fitler by symbol names; max 10 + Fitler by symbol names; max 10, for example `ETHUSDT` Cancelation Token @@ -1650,7 +1650,7 @@ Get the orderbook for a symbol - Symbol + Symbol, for example `ETHUSDT` Amount of rows, 5, 10, 20 or 50 The merge level, 0.00000000001 up to 1000, 0 for no merging Cancelation Token @@ -1661,7 +1661,7 @@ Get the trade history for a symbol - Symbol + Symbol, for example `ETHUSDT` Max amount of results The starting point of the query, 0 means to acquire from the latest record Cancelation Token @@ -1672,7 +1672,7 @@ Get klines/candlesticks - Symbol + Symbol, for example `ETHUSDT` Kline interval Max amount of results Price type, either LastPrice(default) or IndexPrice @@ -1684,7 +1684,7 @@ Get index prices - Filter by symbols + Filter by symbols, for example `ETHUSDT` Cancelation Token @@ -1693,7 +1693,7 @@ Get funding rates - Filter by symbols + Filter by symbols, for example `ETHUSDT` Cancelation Token @@ -1702,7 +1702,7 @@ Get historical funding rates - Symbol + Symbol, for example `ETHUSDT` Filter by start time Filter by end time Page number @@ -1715,7 +1715,7 @@ Get historical premium index prices - Symbol + Symbol, for example `ETHUSDT` Filter by start time Filter by end time Page number @@ -1728,7 +1728,7 @@ Get position levels - Filter by symbols; max 10 + Filter by symbols; max 10, for example `ETHUSDT` Cancelation Token @@ -1737,7 +1737,7 @@ Get liquidation history - Symbol + Symbol, for example `ETHUSDT` Filter by start time Filter by end time Page number @@ -1750,7 +1750,7 @@ Get basis rate history - Symbol + Symbol, for example `ETHUSDT` Filter by start time Filter by end time Cancelation Token @@ -1766,7 +1766,7 @@ Place a new order - The symbol + The symbol, for example `ETHUSDT` Order side Order type Quantity @@ -1781,7 +1781,7 @@ Place a new stop order - The symbol + The symbol, for example `ETHUSDT` Order side Order type Quantity @@ -1798,7 +1798,7 @@ Get an order by id - Symbol + Symbol, for example `ETHUSDT` Order id Cancelation Token @@ -1808,7 +1808,7 @@ Get a list of open orders - Filter by symbol + Filter by symbol, for example `ETHUSDT` Filter by side Filter by client order id Page number @@ -1821,7 +1821,7 @@ Get a list of closed orders. Note that orders canceled without having any trades will not be returned - Filter by symbol + Filter by symbol, for example `ETHUSDT` Filter by side Filter by client order id Page number @@ -1834,7 +1834,7 @@ Get a list of open stop orders - Filter by symbol + Filter by symbol, for example `ETHUSDT` Filter by side Filter by client order id Page number @@ -1847,7 +1847,7 @@ Get a list of closed stop orders. Note that orders canceled without having any trades will not be returned - Filter by symbol + Filter by symbol, for example `ETHUSDT` Filter by side Filter by client order id Page number @@ -1860,7 +1860,7 @@ Edit an active order - Symbol + Symbol, for example `ETHUSDT` Order id New quantity New price @@ -1872,7 +1872,7 @@ Edit an active stop order - Symbol + Symbol, for example `ETHUSDT` Order id New quantity New price @@ -1885,7 +1885,7 @@ Cancel all orders for a symbol - Symbol + Symbol, for example `ETHUSDT` Only cancel a specific order side Cancelation Token @@ -1895,7 +1895,7 @@ Cancel an active order - Symbol + Symbol, for example `ETHUSDT` Id of order to cancel Cancelation Token @@ -1905,7 +1905,7 @@ Cancel an active stop order - Symbol + Symbol, for example `ETHUSDT` Id of stop order to cancel Cancelation Token @@ -1915,7 +1915,7 @@ Cancel an active order by its client order id - Symbol + Symbol, for example `ETHUSDT` Client order id of order to cancel Cancelation Token @@ -1925,7 +1925,7 @@ Cancel an active stop order by its client order id - Symbol + Symbol, for example `ETHUSDT` Client order id of stop order to cancel Cancelation Token @@ -1935,7 +1935,7 @@ Get trade list - Symbol + Symbol, for example `ETHUSDT` Filter by side Filter by start time Filter by end time @@ -1949,7 +1949,7 @@ Get trades for a specific order - Symbol + Symbol, for example `ETHUSDT` The order id Page number Page size @@ -1961,7 +1961,7 @@ Get user positions - Symbol + Symbol, for example `ETHUSDT` Page number Page size Cancelation Token @@ -1972,7 +1972,7 @@ Get position history - Symbol + Symbol, for example `ETHUSDT` Filter by start time Filter by end time Page number @@ -1985,7 +1985,7 @@ (partially) Close an open position - Symbol + Symbol, for example `ETHUSDT` Order type to use Price of the order Quantity to close @@ -1999,7 +1999,7 @@ Adjust the margin for a position. Positive quantity for increasing, negative quantity for decreasing - Symbol + Symbol, for example `ETHUSDT` Quantity to increase (positive number) or decrease (negative number) Cancelation Token @@ -2009,7 +2009,7 @@ Set stop loss for a position - Symbol + Symbol, for example `ETHUSDT` Stop loss price type Stop loss price Cancelation Token @@ -2020,7 +2020,7 @@ Set take profit for a position - Symbol + Symbol, for example `ETHUSDT` Take profit price type Take profit price Cancelation Token @@ -2031,7 +2031,7 @@ Get margin adjustment history - Symbol + Symbol, for example `ETHUSDT` Position id Filter by start time Filter by end time @@ -2045,7 +2045,7 @@ Get funding rate history - Symbol + Symbol, for example `ETHUSDT` Position id Filter by start time Filter by end time @@ -2059,7 +2059,7 @@ Get auto deleveraging history - Symbol + Symbol, for example `ETHUSDT` Position id Filter by start time Filter by end time @@ -2073,7 +2073,7 @@ Get position settlement history - Symbol + Symbol, for example `ETHUSDT` Position id Filter by start time Filter by end time @@ -2092,7 +2092,7 @@ Subscribe to symbol ticker updates for all symbols. Note that only one ticker subscription can be active at the same time; new ticker subscription will override the old subscriptions. - The symbols to subscribe + The symbols to subscribe, for example `ETHUSDT` Data handler Cancellation token for closing this subscription A stream subscription. This stream subscription can be used to be notified when the socket is disconnected/reconnected @@ -2111,7 +2111,7 @@ Subscribe to order book updates - Symbol + Symbol, for example `ETHUSDT` Order book depth, 5, 10, 20 or 50 The merge level, 0.00000000001 up to 1000, 0 for no merging Whether updates should provide full update or only updates @@ -2124,7 +2124,7 @@ Subscribe to order book updates - Symbols + Symbols, for example `ETHUSDT` Order book depth, 5, 10, 20 or 50 The merge level, 0.00000000001 up to 1000, 0 for no merging Whether updates should provide full update or only updates @@ -2137,7 +2137,7 @@ Subscribe to live trade updates - Symbol + Symbol, for example `ETHUSDT` Data handler Cancellation token for closing this subscription A stream subscription. This stream subscription can be used to be notified when the socket is disconnected/reconnected @@ -2147,7 +2147,7 @@ Subscribe to live trade updates - Symbols + Symbols, for example `ETHUSDT` Data handler Cancellation token for closing this subscription A stream subscription. This stream subscription can be used to be notified when the socket is disconnected/reconnected @@ -2166,7 +2166,7 @@ Subscribe to index price updates - Symbol + Symbol, for example `ETHUSDT` Data handler Cancellation token for closing this subscription A stream subscription. This stream subscription can be used to be notified when the socket is disconnected/reconnected @@ -2176,7 +2176,7 @@ Subscribe to index price updates - Symbols + Symbols, for example `ETHUSDT` Data handler Cancellation token for closing this subscription A stream subscription. This stream subscription can be used to be notified when the socket is disconnected/reconnected @@ -2186,7 +2186,7 @@ Subscribe to book price updates - Symbol + Symbol, for example `ETHUSDT` Data handler Cancellation token for closing this subscription A stream subscription. This stream subscription can be used to be notified when the socket is disconnected/reconnected @@ -2196,7 +2196,7 @@ Subscribe to book price updates - Symbols + Symbols, for example `ETHUSDT` Data handler Cancellation token for closing this subscription A stream subscription. This stream subscription can be used to be notified when the socket is disconnected/reconnected @@ -2796,7 +2796,7 @@ Get trading fees - Symbol name + Symbol name, for example `ETHUSDT` Account type Cancelation token @@ -2855,7 +2855,7 @@ Apply for margin borrowing - Symbol + Symbol, for example `ETHUSDT` Asset Quantity to borrow Whether to renew automatically. Automatic renewal means that after the loan expires, the system will renew the loan based on the latest borrowing interest rate and cycle. @@ -2867,7 +2867,7 @@ Repay a margin loan - Symbol + Symbol, for example `ETHUSDT` Asset Quantity to repay Loan record ID @@ -2879,7 +2879,7 @@ Get borrow history - Filter by symbol + Filter by symbol, for example `ETHUSDT` Filter by status Page number Page size @@ -2891,7 +2891,7 @@ Get borrow limits - Symbol + Symbol, for example `ETHUSDT` Asset Cancelation token @@ -2901,7 +2901,7 @@ Get the deposit address for an asset - The asset to deposit + The asset to deposit, for example `ETH` Network Cancelation token @@ -2911,7 +2911,7 @@ Renew deposit address - The asset + The asset, for example `ETH` Network Cancelation token @@ -2921,7 +2921,7 @@ Get deposit history - Asset + Asset, for example `ETH` Filter by transaction id Filter by status Page number @@ -2934,7 +2934,7 @@ Withdraw funds to an external address or another CoinEx user - Asset to withdraw + Asset to withdraw, for example `ETH` Withdrawal quantity Withdrawal address.The withdrawal address needs to be added to the IP whitelist via Developer Console Withdrawal methods (On-chain or inter-user transfer). Default as on-chain withdrawal @@ -2958,7 +2958,7 @@ Get withdrawal history - Filter by asset + Filter by asset, for example `ETH` Filter by withdrawal id Filter by status Page number @@ -2971,7 +2971,7 @@ Get withdraw and deposit information for an asset - The asset + The asset, for example `ETH` Cancelation token @@ -2980,7 +2980,7 @@ Transfer between accounts - Asset to transfer + Asset to transfer, for example `ETH` From account To account Quantity to transfer @@ -2993,7 +2993,7 @@ Get transfer history - Asset + Asset, for example `ETH` Transfer type. Must be either Margin or Futures Filter by margin symbol Filter by status @@ -3009,7 +3009,7 @@ Add AAM liquidity - Symbol + Symbol, for example `ETH` Base asset quantity to add Quote asset quantity to add Cancelation token @@ -3020,7 +3020,7 @@ Remove AAM liquidity. Currently only support withdrawing all liquidity - Symbol + Symbol, for example `ETHUSDT` Cancelation token @@ -3058,7 +3058,7 @@ Get symbol tickers - Fitler by symbol names + Fitler by symbol names, for example `ETHUSDT` Cancelation Token @@ -3067,7 +3067,7 @@ Get the orderbook for a symbol - Symbol + Symbol, for example `ETHUSDT` Amount of rows, 5, 10, 20 or 50 The merge level, 0.00000000001 up to 1000, 0 for no merging Cancelation Token @@ -3078,7 +3078,7 @@ Get the trade history for a symbol - Symbol + Symbol, for example `ETHUSDT` Max amount of results The starting point of the query, 0 means to acquire from the latest record Cancelation Token @@ -3089,7 +3089,7 @@ Get klines/candlesticks - Symbol + Symbol, for example `ETHUSDT` Kline interval Max amount of results Price type, either LastPrice(default) or IndexPrice @@ -3101,7 +3101,7 @@ Get index prices - Filter by symbols + Filter by symbols, for example `ETHUSDT` Cancelation Token @@ -3115,7 +3115,7 @@ Place a new order - The symbol + The symbol, for example `ETHUSDT` Account type, Spot or Margin Order side Order type @@ -3132,7 +3132,7 @@ Place a new stop order - The symbol + The symbol, for example `ETHUSDT` Account type, Spot or Margin Order side Order type @@ -3150,7 +3150,7 @@ Get an order by id - Symbol + Symbol, for example `ETHUSDT` Order id Cancelation Token @@ -3160,7 +3160,7 @@ Get a list of open orders - Filter by symbol + Filter by symbol, for example `ETHUSDT` Account type Filter by side Filter by client order id @@ -3174,7 +3174,7 @@ Get a list of closed orders. Note that orders canceled without having any trades will not be returned - Filter by symbol + Filter by symbol, for example `ETHUSDT` Account type Filter by side Filter by client order id @@ -3188,7 +3188,7 @@ Get a list of open stop orders - Filter by symbol + Filter by symbol, for example `ETHUSDT` Account type Filter by side Filter by client order id @@ -3202,7 +3202,7 @@ Get a list of closed stop orders. Note that orders canceled without having any trades will not be returned - Filter by symbol + Filter by symbol, for example `ETHUSDT` Account type Filter by side Filter by client order id @@ -3216,7 +3216,7 @@ Edit an active order - Symbol + Symbol, for example `ETHUSDT` Account type Order id New quantity @@ -3229,7 +3229,7 @@ Edit an active stop order - Symbol + Symbol, for example `ETHUSDT` Account type Order id New quantity @@ -3243,7 +3243,7 @@ Cancel all orders for a symbol - Symbol + Symbol, for example `ETHUSDT` Account type Only cancel a specific order side Cancelation Token @@ -3254,7 +3254,7 @@ Cancel an active order - Symbol + Symbol, for example `ETHUSDT` Account type Id of order to cancel Cancelation Token @@ -3265,7 +3265,7 @@ Cancel an active stop order - Symbol + Symbol, for example `ETHUSDT` Account type Id of stop order to cancel Cancelation Token @@ -3276,7 +3276,7 @@ Cancel an active order by its client order id - Symbol + Symbol, for example `ETHUSDT` Account type Client order id of order to cancel Cancelation Token @@ -3287,7 +3287,7 @@ Cancel an active stop order by its client order id - Symbol + Symbol, for example `ETHUSDT` Account type Client order id of stop order to cancel Cancelation Token @@ -3298,7 +3298,7 @@ Get trade list - Symbol + Symbol, for example `ETHUSDT` Account type Filter by side Filter by start time @@ -3313,7 +3313,7 @@ Get trades for a specific order - Symbol + Symbol, for example `ETHUSDT` Account type The order id Page number @@ -3339,7 +3339,7 @@ Subscribe to symbol ticker updates for the specified symbols. Note that only one ticker subscription can be active at the same time; new ticker subscription will override the old subscriptions. - The symbols to subscribe + The symbols to subscribe, for example `ETHUSDT` Data handler Cancellation token for closing this subscription A stream subscription. This stream subscription can be used to be notified when the socket is disconnected/reconnected @@ -3358,7 +3358,7 @@ Subscribe to order book updates - Symbol + Symbol, for example `ETHUSDT` Order book depth, 5, 10, 20 or 50 The merge level, 0.00000000001 up to 1000, 0 for no merging Whether updates should provide full update or only updates @@ -3371,7 +3371,7 @@ Subscribe to order book updates - Symbols + Symbols, for example `ETHUSDT` Order book depth, 5, 10, 20 or 50 The merge level, 0.00000000001 up to 1000, 0 for no merging Whether updates should provide full update or only updates @@ -3384,7 +3384,7 @@ Subscribe to live trade updates - Symbol + Symbol, for example `ETHUSDT` Data handler Cancellation token for closing this subscription A stream subscription. This stream subscription can be used to be notified when the socket is disconnected/reconnected @@ -3394,7 +3394,7 @@ Subscribe to live trade updates - Symbols + Symbols, for example `ETHUSDT` Data handler Cancellation token for closing this subscription A stream subscription. This stream subscription can be used to be notified when the socket is disconnected/reconnected @@ -3413,7 +3413,7 @@ Subscribe to index price updates - Symbol + Symbol, for example `ETHUSDT` Data handler Cancellation token for closing this subscription A stream subscription. This stream subscription can be used to be notified when the socket is disconnected/reconnected @@ -3423,7 +3423,7 @@ Subscribe to index price updates - Symbols + Symbols, for example `ETHUSDT` Data handler Cancellation token for closing this subscription A stream subscription. This stream subscription can be used to be notified when the socket is disconnected/reconnected @@ -3433,7 +3433,7 @@ Subscribe to book price updates - Symbol + Symbol, for example `ETHUSDT` Data handler Cancellation token for closing this subscription A stream subscription. This stream subscription can be used to be notified when the socket is disconnected/reconnected @@ -3443,7 +3443,7 @@ Subscribe to book price updates - Symbols + Symbols, for example `ETHUSDT` Data handler Cancellation token for closing this subscription A stream subscription. This stream subscription can be used to be notified when the socket is disconnected/reconnected diff --git a/CoinEx.Net/Interfaces/Clients/FuturesApi/ICoinExRestClientFuturesApiAccount.cs b/CoinEx.Net/Interfaces/Clients/FuturesApi/ICoinExRestClientFuturesApiAccount.cs index be6cd4c..e98f3e4 100644 --- a/CoinEx.Net/Interfaces/Clients/FuturesApi/ICoinExRestClientFuturesApiAccount.cs +++ b/CoinEx.Net/Interfaces/Clients/FuturesApi/ICoinExRestClientFuturesApiAccount.cs @@ -16,7 +16,7 @@ public interface ICoinExRestClientFuturesApiAccount /// Get trading fees for a symbol /// /// - /// Symbol + /// Symbol, for example `ETHUSDT` /// Cancelation token /// Task> GetTradingFeesAsync(string symbol, CancellationToken ct = default); @@ -33,7 +33,7 @@ public interface ICoinExRestClientFuturesApiAccount /// Set leverage for a symbol /// /// - /// Symbol + /// Symbol, for example `ETHUSDT` /// Margin mode /// Leverage /// Cancelation token diff --git a/CoinEx.Net/Interfaces/Clients/FuturesApi/ICoinExRestClientFuturesApiExchangeData.cs b/CoinEx.Net/Interfaces/Clients/FuturesApi/ICoinExRestClientFuturesApiExchangeData.cs index bba6273..c308f44 100644 --- a/CoinEx.Net/Interfaces/Clients/FuturesApi/ICoinExRestClientFuturesApiExchangeData.cs +++ b/CoinEx.Net/Interfaces/Clients/FuturesApi/ICoinExRestClientFuturesApiExchangeData.cs @@ -25,7 +25,7 @@ public interface ICoinExRestClientFuturesApiExchangeData /// Get list of support symbols /// /// - /// Filter by symbol name; max 10 + /// Filter by symbol name; max 10, for example `ETHUSDT` /// Cancelation token /// Task>> GetSymbolsAsync(IEnumerable? symbols = null, CancellationToken ct = default); @@ -34,7 +34,7 @@ public interface ICoinExRestClientFuturesApiExchangeData /// Get symbol tickers /// /// - /// Fitler by symbol names; max 10 + /// Fitler by symbol names; max 10, for example `ETHUSDT` /// Cancelation Token /// Task>> GetTickersAsync(IEnumerable? symbols = null, CancellationToken ct = default); @@ -43,7 +43,7 @@ public interface ICoinExRestClientFuturesApiExchangeData /// Get the orderbook for a symbol /// /// - /// Symbol + /// Symbol, for example `ETHUSDT` /// Amount of rows, 5, 10, 20 or 50 /// The merge level, 0.00000000001 up to 1000, 0 for no merging /// Cancelation Token @@ -54,7 +54,7 @@ public interface ICoinExRestClientFuturesApiExchangeData /// Get the trade history for a symbol /// /// - /// Symbol + /// Symbol, for example `ETHUSDT` /// Max amount of results /// The starting point of the query, 0 means to acquire from the latest record /// Cancelation Token @@ -65,7 +65,7 @@ public interface ICoinExRestClientFuturesApiExchangeData /// Get klines/candlesticks /// /// - /// Symbol + /// Symbol, for example `ETHUSDT` /// Kline interval /// Max amount of results /// Price type, either LastPrice(default) or IndexPrice @@ -77,7 +77,7 @@ public interface ICoinExRestClientFuturesApiExchangeData /// Get index prices /// /// - /// Filter by symbols + /// Filter by symbols, for example `ETHUSDT` /// Cancelation Token /// Task>> GetIndexPricesAsync(IEnumerable? symbols = null, CancellationToken ct = default); @@ -86,7 +86,7 @@ public interface ICoinExRestClientFuturesApiExchangeData /// Get funding rates /// /// - /// Filter by symbols + /// Filter by symbols, for example `ETHUSDT` /// Cancelation Token /// Task>> GetFundingRatesAsync(IEnumerable? symbols = null, CancellationToken ct = default); @@ -95,7 +95,7 @@ public interface ICoinExRestClientFuturesApiExchangeData /// Get historical funding rates /// /// - /// Symbol + /// Symbol, for example `ETHUSDT` /// Filter by start time /// Filter by end time /// Page number @@ -108,7 +108,7 @@ public interface ICoinExRestClientFuturesApiExchangeData /// Get historical premium index prices /// /// - /// Symbol + /// Symbol, for example `ETHUSDT` /// Filter by start time /// Filter by end time /// Page number @@ -116,12 +116,12 @@ public interface ICoinExRestClientFuturesApiExchangeData /// Cancelation Token /// Task>> GetPremiumIndexPriceHistoryAsync(string symbol, DateTime? startTime = null, DateTime? endTime = null, int? page = null, int? pageSize = null, CancellationToken ct = default); - + /// /// Get position levels /// /// - /// Filter by symbols; max 10 + /// Filter by symbols; max 10, for example `ETHUSDT` /// Cancelation Token /// Task>> GetPositionLevelsAsync(IEnumerable? symbols = null, CancellationToken ct = default); @@ -130,7 +130,7 @@ public interface ICoinExRestClientFuturesApiExchangeData /// Get liquidation history /// /// - /// Symbol + /// Symbol, for example `ETHUSDT` /// Filter by start time /// Filter by end time /// Page number @@ -143,7 +143,7 @@ public interface ICoinExRestClientFuturesApiExchangeData /// Get basis rate history /// /// - /// Symbol + /// Symbol, for example `ETHUSDT` /// Filter by start time /// Filter by end time /// Cancelation Token diff --git a/CoinEx.Net/Interfaces/Clients/FuturesApi/ICoinExRestClientFuturesApiTrading.cs b/CoinEx.Net/Interfaces/Clients/FuturesApi/ICoinExRestClientFuturesApiTrading.cs index fde1b79..1419446 100644 --- a/CoinEx.Net/Interfaces/Clients/FuturesApi/ICoinExRestClientFuturesApiTrading.cs +++ b/CoinEx.Net/Interfaces/Clients/FuturesApi/ICoinExRestClientFuturesApiTrading.cs @@ -16,7 +16,7 @@ public interface ICoinExRestClientFuturesApiTrading /// Place a new order /// /// - /// The symbol + /// The symbol, for example `ETHUSDT` /// Order side /// Order type /// Quantity @@ -39,7 +39,7 @@ Task> PlaceOrderAsync( /// Place a new stop order /// /// - /// The symbol + /// The symbol, for example `ETHUSDT` /// Order side /// Order type /// Quantity @@ -66,7 +66,7 @@ Task> PlaceStopOrderAsync( /// Get an order by id /// /// - /// Symbol + /// Symbol, for example `ETHUSDT` /// Order id /// Cancelation Token /// @@ -77,7 +77,7 @@ Task> PlaceStopOrderAsync( /// Get a list of open orders /// /// - /// Filter by symbol + /// Filter by symbol, for example `ETHUSDT` /// Filter by side /// Filter by client order id /// Page number @@ -90,7 +90,7 @@ Task> PlaceStopOrderAsync( /// Get a list of closed orders. Note that orders canceled without having any trades will not be returned /// /// - /// Filter by symbol + /// Filter by symbol, for example `ETHUSDT` /// Filter by side /// Filter by client order id /// Page number @@ -103,7 +103,7 @@ Task> PlaceStopOrderAsync( /// Get a list of open stop orders /// /// - /// Filter by symbol + /// Filter by symbol, for example `ETHUSDT` /// Filter by side /// Filter by client order id /// Page number @@ -116,7 +116,7 @@ Task> PlaceStopOrderAsync( /// Get a list of closed stop orders. Note that orders canceled without having any trades will not be returned /// /// - /// Filter by symbol + /// Filter by symbol, for example `ETHUSDT` /// Filter by side /// Filter by client order id /// Page number @@ -129,7 +129,7 @@ Task> PlaceStopOrderAsync( /// Edit an active order /// /// - /// Symbol + /// Symbol, for example `ETHUSDT` /// Order id /// New quantity /// New price @@ -146,7 +146,7 @@ Task> EditOrderAsync( /// Edit an active stop order /// /// - /// Symbol + /// Symbol, for example `ETHUSDT` /// Order id /// New quantity /// New price @@ -165,7 +165,7 @@ Task> EditStopOrderAsync( /// Cancel all orders for a symbol /// /// - /// Symbol + /// Symbol, for example `ETHUSDT` /// Only cancel a specific order side /// Cancelation Token /// @@ -175,7 +175,7 @@ Task> EditStopOrderAsync( /// Cancel an active order /// /// - /// Symbol + /// Symbol, for example `ETHUSDT` /// Id of order to cancel /// Cancelation Token /// @@ -185,7 +185,7 @@ Task> EditStopOrderAsync( /// Cancel an active stop order /// /// - /// Symbol + /// Symbol, for example `ETHUSDT` /// Id of stop order to cancel /// Cancelation Token /// @@ -195,7 +195,7 @@ Task> EditStopOrderAsync( /// Cancel an active order by its client order id /// /// - /// Symbol + /// Symbol, for example `ETHUSDT` /// Client order id of order to cancel /// Cancelation Token /// @@ -205,7 +205,7 @@ Task> EditStopOrderAsync( /// Cancel an active stop order by its client order id /// /// - /// Symbol + /// Symbol, for example `ETHUSDT` /// Client order id of stop order to cancel /// Cancelation Token /// @@ -216,7 +216,7 @@ Task> EditStopOrderAsync( /// Get trade list /// /// - /// Symbol + /// Symbol, for example `ETHUSDT` /// Filter by side /// Filter by start time /// Filter by end time @@ -230,7 +230,7 @@ Task> EditStopOrderAsync( /// Get trades for a specific order /// /// - /// Symbol + /// Symbol, for example `ETHUSDT` /// The order id /// Page number /// Page size @@ -242,7 +242,7 @@ Task> EditStopOrderAsync( /// Get user positions /// /// - /// Symbol + /// Symbol, for example `ETHUSDT` /// Page number /// Page size /// Cancelation Token @@ -253,7 +253,7 @@ Task> EditStopOrderAsync( /// Get position history /// /// - /// Symbol + /// Symbol, for example `ETHUSDT` /// Filter by start time /// Filter by end time /// Page number @@ -266,7 +266,7 @@ Task> EditStopOrderAsync( /// (partially) Close an open position /// /// - /// Symbol + /// Symbol, for example `ETHUSDT` /// Order type to use /// Price of the order /// Quantity to close @@ -280,7 +280,7 @@ Task> EditStopOrderAsync( /// Adjust the margin for a position. Positive quantity for increasing, negative quantity for decreasing /// /// - /// Symbol + /// Symbol, for example `ETHUSDT` /// Quantity to increase (positive number) or decrease (negative number) /// Cancelation Token /// @@ -290,7 +290,7 @@ Task> EditStopOrderAsync( /// Set stop loss for a position /// /// - /// Symbol + /// Symbol, for example `ETHUSDT` /// Stop loss price type /// Stop loss price /// Cancelation Token @@ -301,7 +301,7 @@ Task> EditStopOrderAsync( /// Set take profit for a position /// /// - /// Symbol + /// Symbol, for example `ETHUSDT` /// Take profit price type /// Take profit price /// Cancelation Token @@ -312,7 +312,7 @@ Task> EditStopOrderAsync( /// Get margin adjustment history /// /// - /// Symbol + /// Symbol, for example `ETHUSDT` /// Position id /// Filter by start time /// Filter by end time @@ -326,7 +326,7 @@ Task> EditStopOrderAsync( /// Get funding rate history /// /// - /// Symbol + /// Symbol, for example `ETHUSDT` /// Position id /// Filter by start time /// Filter by end time @@ -340,7 +340,7 @@ Task> EditStopOrderAsync( /// Get auto deleveraging history /// /// - /// Symbol + /// Symbol, for example `ETHUSDT` /// Position id /// Filter by start time /// Filter by end time @@ -354,7 +354,7 @@ Task> EditStopOrderAsync( /// Get position settlement history /// /// - /// Symbol + /// Symbol, for example `ETHUSDT` /// Position id /// Filter by start time /// Filter by end time diff --git a/CoinEx.Net/Interfaces/Clients/FuturesApi/ICoinExSocketClientFuturesApi.cs b/CoinEx.Net/Interfaces/Clients/FuturesApi/ICoinExSocketClientFuturesApi.cs index f61a27d..9fff619 100644 --- a/CoinEx.Net/Interfaces/Clients/FuturesApi/ICoinExSocketClientFuturesApi.cs +++ b/CoinEx.Net/Interfaces/Clients/FuturesApi/ICoinExSocketClientFuturesApi.cs @@ -18,7 +18,7 @@ public interface ICoinExSocketClientFuturesApi : ISocketApiClient, IDisposable /// Subscribe to symbol ticker updates for all symbols. Note that only one ticker subscription can be active at the same time; new ticker subscription will override the old subscriptions. /// /// - /// The symbols to subscribe + /// The symbols to subscribe, for example `ETHUSDT` /// Data handler /// Cancellation token for closing this subscription /// A stream subscription. This stream subscription can be used to be notified when the socket is disconnected/reconnected @@ -37,7 +37,7 @@ public interface ICoinExSocketClientFuturesApi : ISocketApiClient, IDisposable /// Subscribe to order book updates /// /// - /// Symbol + /// Symbol, for example `ETHUSDT` /// Order book depth, 5, 10, 20 or 50 /// The merge level, 0.00000000001 up to 1000, 0 for no merging /// Whether updates should provide full update or only updates @@ -50,7 +50,7 @@ public interface ICoinExSocketClientFuturesApi : ISocketApiClient, IDisposable /// Subscribe to order book updates /// /// - /// Symbols + /// Symbols, for example `ETHUSDT` /// Order book depth, 5, 10, 20 or 50 /// The merge level, 0.00000000001 up to 1000, 0 for no merging /// Whether updates should provide full update or only updates @@ -63,7 +63,7 @@ public interface ICoinExSocketClientFuturesApi : ISocketApiClient, IDisposable /// Subscribe to live trade updates /// /// - /// Symbol + /// Symbol, for example `ETHUSDT` /// Data handler /// Cancellation token for closing this subscription /// A stream subscription. This stream subscription can be used to be notified when the socket is disconnected/reconnected @@ -73,7 +73,7 @@ public interface ICoinExSocketClientFuturesApi : ISocketApiClient, IDisposable /// Subscribe to live trade updates /// /// - /// Symbols + /// Symbols, for example `ETHUSDT` /// Data handler /// Cancellation token for closing this subscription /// A stream subscription. This stream subscription can be used to be notified when the socket is disconnected/reconnected @@ -92,7 +92,7 @@ public interface ICoinExSocketClientFuturesApi : ISocketApiClient, IDisposable /// Subscribe to index price updates /// /// - /// Symbol + /// Symbol, for example `ETHUSDT` /// Data handler /// Cancellation token for closing this subscription /// A stream subscription. This stream subscription can be used to be notified when the socket is disconnected/reconnected @@ -102,7 +102,7 @@ public interface ICoinExSocketClientFuturesApi : ISocketApiClient, IDisposable /// Subscribe to index price updates /// /// - /// Symbols + /// Symbols, for example `ETHUSDT` /// Data handler /// Cancellation token for closing this subscription /// A stream subscription. This stream subscription can be used to be notified when the socket is disconnected/reconnected @@ -112,7 +112,7 @@ public interface ICoinExSocketClientFuturesApi : ISocketApiClient, IDisposable /// Subscribe to book price updates /// /// - /// Symbol + /// Symbol, for example `ETHUSDT` /// Data handler /// Cancellation token for closing this subscription /// A stream subscription. This stream subscription can be used to be notified when the socket is disconnected/reconnected @@ -122,7 +122,7 @@ public interface ICoinExSocketClientFuturesApi : ISocketApiClient, IDisposable /// Subscribe to book price updates /// /// - /// Symbols + /// Symbols, for example `ETHUSDT` /// Data handler /// Cancellation token for closing this subscription /// A stream subscription. This stream subscription can be used to be notified when the socket is disconnected/reconnected diff --git a/CoinEx.Net/Interfaces/Clients/SpotApiV2/ICoinExRestClientSpotApiAccount.cs b/CoinEx.Net/Interfaces/Clients/SpotApiV2/ICoinExRestClientSpotApiAccount.cs index 175be40..3a97156 100644 --- a/CoinEx.Net/Interfaces/Clients/SpotApiV2/ICoinExRestClientSpotApiAccount.cs +++ b/CoinEx.Net/Interfaces/Clients/SpotApiV2/ICoinExRestClientSpotApiAccount.cs @@ -17,7 +17,7 @@ public interface ICoinExRestClientSpotApiAccount /// Get trading fees /// /// - /// Symbol name + /// Symbol name, for example `ETHUSDT` /// Account type /// Cancelation token /// @@ -76,7 +76,7 @@ public interface ICoinExRestClientSpotApiAccount /// Apply for margin borrowing /// /// - /// Symbol + /// Symbol, for example `ETHUSDT` /// Asset /// Quantity to borrow /// Whether to renew automatically. Automatic renewal means that after the loan expires, the system will renew the loan based on the latest borrowing interest rate and cycle. @@ -88,7 +88,7 @@ public interface ICoinExRestClientSpotApiAccount /// Repay a margin loan /// /// - /// Symbol + /// Symbol, for example `ETHUSDT` /// Asset /// Quantity to repay /// Loan record ID @@ -100,7 +100,7 @@ public interface ICoinExRestClientSpotApiAccount /// Get borrow history /// /// - /// Filter by symbol + /// Filter by symbol, for example `ETHUSDT` /// Filter by status /// Page number /// Page size @@ -112,7 +112,7 @@ public interface ICoinExRestClientSpotApiAccount /// Get borrow limits /// /// - /// Symbol + /// Symbol, for example `ETHUSDT` /// Asset /// Cancelation token /// @@ -122,7 +122,7 @@ public interface ICoinExRestClientSpotApiAccount /// Get the deposit address for an asset /// /// - /// The asset to deposit + /// The asset to deposit, for example `ETH` /// Network /// Cancelation token /// @@ -132,7 +132,7 @@ public interface ICoinExRestClientSpotApiAccount /// Renew deposit address /// /// - /// The asset + /// The asset, for example `ETH` /// Network /// Cancelation token /// @@ -142,7 +142,7 @@ public interface ICoinExRestClientSpotApiAccount /// Get deposit history /// /// - /// Asset + /// Asset, for example `ETH` /// Filter by transaction id /// Filter by status /// Page number @@ -155,7 +155,7 @@ public interface ICoinExRestClientSpotApiAccount /// Withdraw funds to an external address or another CoinEx user /// /// - /// Asset to withdraw + /// Asset to withdraw, for example `ETH` /// Withdrawal quantity /// Withdrawal address.The withdrawal address needs to be added to the IP whitelist via Developer Console /// Withdrawal methods (On-chain or inter-user transfer). Default as on-chain withdrawal @@ -179,7 +179,7 @@ public interface ICoinExRestClientSpotApiAccount /// Get withdrawal history /// /// - /// Filter by asset + /// Filter by asset, for example `ETH` /// Filter by withdrawal id /// Filter by status /// Page number @@ -192,7 +192,7 @@ public interface ICoinExRestClientSpotApiAccount /// Get withdraw and deposit information for an asset /// /// - /// The asset + /// The asset, for example `ETH` /// Cancelation token /// Task> GetDepositWithdrawalConfigAsync(string asset, CancellationToken ct = default); @@ -201,7 +201,7 @@ public interface ICoinExRestClientSpotApiAccount /// Transfer between accounts /// /// - /// Asset to transfer + /// Asset to transfer, for example `ETH` /// From account /// To account /// Quantity to transfer @@ -214,7 +214,7 @@ public interface ICoinExRestClientSpotApiAccount /// Get transfer history /// /// - /// Asset + /// Asset, for example `ETH` /// Transfer type. Must be either Margin or Futures /// Filter by margin symbol /// Filter by status @@ -230,7 +230,7 @@ public interface ICoinExRestClientSpotApiAccount /// Add AAM liquidity /// /// - /// Symbol + /// Symbol, for example `ETH` /// Base asset quantity to add /// Quote asset quantity to add /// Cancelation token @@ -241,7 +241,7 @@ public interface ICoinExRestClientSpotApiAccount /// Remove AAM liquidity. Currently only support withdrawing all liquidity /// /// - /// Symbol + /// Symbol, for example `ETHUSDT` /// Cancelation token /// Task> RemoveAutoMarketMakerLiquidityAsync(string symbol, CancellationToken ct = default); diff --git a/CoinEx.Net/Interfaces/Clients/SpotApiV2/ICoinExRestClientSpotApiExchangeData.cs b/CoinEx.Net/Interfaces/Clients/SpotApiV2/ICoinExRestClientSpotApiExchangeData.cs index 8df33ba..4dc9ec8 100644 --- a/CoinEx.Net/Interfaces/Clients/SpotApiV2/ICoinExRestClientSpotApiExchangeData.cs +++ b/CoinEx.Net/Interfaces/Clients/SpotApiV2/ICoinExRestClientSpotApiExchangeData.cs @@ -50,7 +50,7 @@ public interface ICoinExRestClientSpotApiExchangeData /// Get symbol tickers /// /// - /// Fitler by symbol names + /// Fitler by symbol names, for example `ETHUSDT` /// Cancelation Token /// Task>> GetTickersAsync(IEnumerable? symbols = null, CancellationToken ct = default); @@ -59,7 +59,7 @@ public interface ICoinExRestClientSpotApiExchangeData /// Get the orderbook for a symbol /// /// - /// Symbol + /// Symbol, for example `ETHUSDT` /// Amount of rows, 5, 10, 20 or 50 /// The merge level, 0.00000000001 up to 1000, 0 for no merging /// Cancelation Token @@ -70,7 +70,7 @@ public interface ICoinExRestClientSpotApiExchangeData /// Get the trade history for a symbol /// /// - /// Symbol + /// Symbol, for example `ETHUSDT` /// Max amount of results /// The starting point of the query, 0 means to acquire from the latest record /// Cancelation Token @@ -81,7 +81,7 @@ public interface ICoinExRestClientSpotApiExchangeData /// Get klines/candlesticks /// /// - /// Symbol + /// Symbol, for example `ETHUSDT` /// Kline interval /// Max amount of results /// Price type, either LastPrice(default) or IndexPrice @@ -93,7 +93,7 @@ public interface ICoinExRestClientSpotApiExchangeData /// Get index prices /// /// - /// Filter by symbols + /// Filter by symbols, for example `ETHUSDT` /// Cancelation Token /// Task>> GetIndexPricesAsync(IEnumerable? symbols = null, CancellationToken ct = default); diff --git a/CoinEx.Net/Interfaces/Clients/SpotApiV2/ICoinExRestClientSpotApiTrading.cs b/CoinEx.Net/Interfaces/Clients/SpotApiV2/ICoinExRestClientSpotApiTrading.cs index 2997424..0a83dfa 100644 --- a/CoinEx.Net/Interfaces/Clients/SpotApiV2/ICoinExRestClientSpotApiTrading.cs +++ b/CoinEx.Net/Interfaces/Clients/SpotApiV2/ICoinExRestClientSpotApiTrading.cs @@ -16,7 +16,7 @@ public interface ICoinExRestClientSpotApiTrading /// Place a new order /// /// - /// The symbol + /// The symbol, for example `ETHUSDT` /// Account type, Spot or Margin /// Order side /// Order type @@ -43,7 +43,7 @@ Task> PlaceOrderAsync( /// Place a new stop order /// /// - /// The symbol + /// The symbol, for example `ETHUSDT` /// Account type, Spot or Margin /// Order side /// Order type @@ -72,7 +72,7 @@ Task> PlaceStopOrderAsync( /// Get an order by id /// /// - /// Symbol + /// Symbol, for example `ETHUSDT` /// Order id /// Cancelation Token /// @@ -82,7 +82,7 @@ Task> PlaceStopOrderAsync( /// Get a list of open orders /// /// - /// Filter by symbol + /// Filter by symbol, for example `ETHUSDT` /// Account type /// Filter by side /// Filter by client order id @@ -96,7 +96,7 @@ Task> PlaceStopOrderAsync( /// Get a list of closed orders. Note that orders canceled without having any trades will not be returned /// /// - /// Filter by symbol + /// Filter by symbol, for example `ETHUSDT` /// Account type /// Filter by side /// Filter by client order id @@ -110,7 +110,7 @@ Task> PlaceStopOrderAsync( /// Get a list of open stop orders /// /// - /// Filter by symbol + /// Filter by symbol, for example `ETHUSDT` /// Account type /// Filter by side /// Filter by client order id @@ -124,7 +124,7 @@ Task> PlaceStopOrderAsync( /// Get a list of closed stop orders. Note that orders canceled without having any trades will not be returned /// /// - /// Filter by symbol + /// Filter by symbol, for example `ETHUSDT` /// Account type /// Filter by side /// Filter by client order id @@ -138,7 +138,7 @@ Task> PlaceStopOrderAsync( /// Edit an active order /// /// - /// Symbol + /// Symbol, for example `ETHUSDT` /// Account type /// Order id /// New quantity @@ -157,7 +157,7 @@ Task> EditOrderAsync( /// Edit an active stop order /// /// - /// Symbol + /// Symbol, for example `ETHUSDT` /// Account type /// Order id /// New quantity @@ -178,7 +178,7 @@ Task> EditStopOrderAsync( /// Cancel all orders for a symbol /// /// - /// Symbol + /// Symbol, for example `ETHUSDT` /// Account type /// Only cancel a specific order side /// Cancelation Token @@ -189,7 +189,7 @@ Task> EditStopOrderAsync( /// Cancel an active order /// /// - /// Symbol + /// Symbol, for example `ETHUSDT` /// Account type /// Id of order to cancel /// Cancelation Token @@ -200,7 +200,7 @@ Task> EditStopOrderAsync( /// Cancel an active stop order /// /// - /// Symbol + /// Symbol, for example `ETHUSDT` /// Account type /// Id of stop order to cancel /// Cancelation Token @@ -211,7 +211,7 @@ Task> EditStopOrderAsync( /// Cancel an active order by its client order id /// /// - /// Symbol + /// Symbol, for example `ETHUSDT` /// Account type /// Client order id of order to cancel /// Cancelation Token @@ -222,7 +222,7 @@ Task> EditStopOrderAsync( /// Cancel an active stop order by its client order id /// /// - /// Symbol + /// Symbol, for example `ETHUSDT` /// Account type /// Client order id of stop order to cancel /// Cancelation Token @@ -233,7 +233,7 @@ Task> EditStopOrderAsync( /// Get trade list /// /// - /// Symbol + /// Symbol, for example `ETHUSDT` /// Account type /// Filter by side /// Filter by start time @@ -248,7 +248,7 @@ Task> EditStopOrderAsync( /// Get trades for a specific order /// /// - /// Symbol + /// Symbol, for example `ETHUSDT` /// Account type /// The order id /// Page number diff --git a/CoinEx.Net/Interfaces/Clients/SpotApiV2/ICoinExSocketClientSpotApi.cs b/CoinEx.Net/Interfaces/Clients/SpotApiV2/ICoinExSocketClientSpotApi.cs index e28d65c..a467470 100644 --- a/CoinEx.Net/Interfaces/Clients/SpotApiV2/ICoinExSocketClientSpotApi.cs +++ b/CoinEx.Net/Interfaces/Clients/SpotApiV2/ICoinExSocketClientSpotApi.cs @@ -26,7 +26,7 @@ public interface ICoinExSocketClientSpotApi : ISocketApiClient, IDisposable /// Subscribe to symbol ticker updates for the specified symbols. Note that only one ticker subscription can be active at the same time; new ticker subscription will override the old subscriptions. /// /// - /// The symbols to subscribe + /// The symbols to subscribe, for example `ETHUSDT` /// Data handler /// Cancellation token for closing this subscription /// A stream subscription. This stream subscription can be used to be notified when the socket is disconnected/reconnected @@ -45,7 +45,7 @@ public interface ICoinExSocketClientSpotApi : ISocketApiClient, IDisposable /// Subscribe to order book updates /// /// - /// Symbol + /// Symbol, for example `ETHUSDT` /// Order book depth, 5, 10, 20 or 50 /// The merge level, 0.00000000001 up to 1000, 0 for no merging /// Whether updates should provide full update or only updates @@ -58,7 +58,7 @@ public interface ICoinExSocketClientSpotApi : ISocketApiClient, IDisposable /// Subscribe to order book updates /// /// - /// Symbols + /// Symbols, for example `ETHUSDT` /// Order book depth, 5, 10, 20 or 50 /// The merge level, 0.00000000001 up to 1000, 0 for no merging /// Whether updates should provide full update or only updates @@ -71,7 +71,7 @@ public interface ICoinExSocketClientSpotApi : ISocketApiClient, IDisposable /// Subscribe to live trade updates /// /// - /// Symbol + /// Symbol, for example `ETHUSDT` /// Data handler /// Cancellation token for closing this subscription /// A stream subscription. This stream subscription can be used to be notified when the socket is disconnected/reconnected @@ -81,7 +81,7 @@ public interface ICoinExSocketClientSpotApi : ISocketApiClient, IDisposable /// Subscribe to live trade updates /// /// - /// Symbols + /// Symbols, for example `ETHUSDT` /// Data handler /// Cancellation token for closing this subscription /// A stream subscription. This stream subscription can be used to be notified when the socket is disconnected/reconnected @@ -100,7 +100,7 @@ public interface ICoinExSocketClientSpotApi : ISocketApiClient, IDisposable /// Subscribe to index price updates /// /// - /// Symbol + /// Symbol, for example `ETHUSDT` /// Data handler /// Cancellation token for closing this subscription /// A stream subscription. This stream subscription can be used to be notified when the socket is disconnected/reconnected @@ -110,7 +110,7 @@ public interface ICoinExSocketClientSpotApi : ISocketApiClient, IDisposable /// Subscribe to index price updates /// /// - /// Symbols + /// Symbols, for example `ETHUSDT` /// Data handler /// Cancellation token for closing this subscription /// A stream subscription. This stream subscription can be used to be notified when the socket is disconnected/reconnected @@ -120,7 +120,7 @@ public interface ICoinExSocketClientSpotApi : ISocketApiClient, IDisposable /// Subscribe to book price updates /// /// - /// Symbol + /// Symbol, for example `ETHUSDT` /// Data handler /// Cancellation token for closing this subscription /// A stream subscription. This stream subscription can be used to be notified when the socket is disconnected/reconnected @@ -130,7 +130,7 @@ public interface ICoinExSocketClientSpotApi : ISocketApiClient, IDisposable /// Subscribe to book price updates /// /// - /// Symbols + /// Symbols, for example `ETHUSDT` /// Data handler /// Cancellation token for closing this subscription /// A stream subscription. This stream subscription can be used to be notified when the socket is disconnected/reconnected