From 70035147943b5121e4b10c8cc0350f91435b9426 Mon Sep 17 00:00:00 2001 From: JKorf Date: Wed, 7 Aug 2024 11:35:40 +0200 Subject: [PATCH] Renamed SpotApi.SubscribeToBestOfferUpdatesAsync to SubscribeToBookTickerUpdatesAsync , Xml comments --- .../SocketSubscriptionTests.cs | 2 +- .../SpotApi/KucoinSocketClientSpotApi.cs | 4 +- .../IKucoinRestClientFuturesApiAccount.cs | 34 +- ...IKucoinRestClientFuturesApiExchangeData.cs | 24 +- .../IKucoinRestClientFuturesApiTrading.cs | 16 +- .../IKucoinSocketClientFuturesApi.cs | 28 +- .../IKucoinRestClientSpotApiAccount.cs | 38 +-- .../IKucoinRestClientSpotApiExchangeData.cs | 16 +- .../IKucoinRestClientSpotApiHfTrading.cs | 50 +-- .../SpotApi/IKucoinRestClientSpotApiMargin.cs | 14 +- .../IKucoinRestClientSpotApiTrading.cs | 24 +- .../SpotApi/IKucoinSocketClientSpotApi.cs | 48 +-- Kucoin.Net/Kucoin.Net.xml | 296 +++++++++--------- 13 files changed, 297 insertions(+), 297 deletions(-) diff --git a/Kucoin.Net.UnitTests/SocketSubscriptionTests.cs b/Kucoin.Net.UnitTests/SocketSubscriptionTests.cs index f0a63149..b0443cc4 100644 --- a/Kucoin.Net.UnitTests/SocketSubscriptionTests.cs +++ b/Kucoin.Net.UnitTests/SocketSubscriptionTests.cs @@ -28,7 +28,7 @@ public async Task ValidateSpotSubscriptions() await tester.ValidateAsync((client, handler) => client.SpotApi.SubscribeToTickerUpdatesAsync("BTC-USDT", handler), "Ticker"); await tester.ValidateAsync((client, handler) => client.SpotApi.SubscribeToAllTickerUpdatesAsync(handler), "Tickers"); await tester.ValidateAsync((client, handler) => client.SpotApi.SubscribeToSnapshotUpdatesAsync("BTC", handler), "Snapshot", "data.data"); - await tester.ValidateAsync((client, handler) => client.SpotApi.SubscribeToBestOfferUpdatesAsync("ETH-USDT", handler), "BestOffers", "data"); + await tester.ValidateAsync((client, handler) => client.SpotApi.SubscribeToBookTickerUpdatesAsync("ETH-USDT", handler), "BestOffers", "data"); await tester.ValidateAsync((client, handler) => client.SpotApi.SubscribeToAggregatedOrderBookUpdatesAsync("BTC-USDT", handler), "AggBook", "data"); await tester.ValidateAsync((client, handler) => client.SpotApi.SubscribeToTradeUpdatesAsync("BTC-USDT", handler), "Trades", "data"); await tester.ValidateAsync((client, handler) => client.SpotApi.SubscribeToKlineUpdatesAsync("BTC-USDT", Enums.KlineInterval.EightHours, handler), "Klines", "data"); diff --git a/Kucoin.Net/Clients/SpotApi/KucoinSocketClientSpotApi.cs b/Kucoin.Net/Clients/SpotApi/KucoinSocketClientSpotApi.cs index b3ff72ca..4877f11c 100644 --- a/Kucoin.Net/Clients/SpotApi/KucoinSocketClientSpotApi.cs +++ b/Kucoin.Net/Clients/SpotApi/KucoinSocketClientSpotApi.cs @@ -116,10 +116,10 @@ public async Task> SubscribeToSnapshotUpdatesAsyn } /// - public Task> SubscribeToBestOfferUpdatesAsync(string symbol, Action> onData, CancellationToken ct = default) => SubscribeToBestOfferUpdatesAsync(new[] { symbol }, onData, ct); + public Task> SubscribeToBookTickerUpdatesAsync(string symbol, Action> onData, CancellationToken ct = default) => SubscribeToBookTickerUpdatesAsync(new[] { symbol }, onData, ct); /// - public async Task> SubscribeToBestOfferUpdatesAsync(IEnumerable symbols, Action> onData, CancellationToken ct = default) + public async Task> SubscribeToBookTickerUpdatesAsync(IEnumerable symbols, Action> onData, CancellationToken ct = default) { symbols.ValidateNotNull(nameof(symbols)); diff --git a/Kucoin.Net/Interfaces/Clients/FuturesApi/IKucoinRestClientFuturesApiAccount.cs b/Kucoin.Net/Interfaces/Clients/FuturesApi/IKucoinRestClientFuturesApiAccount.cs index 75a7b27a..1802bb8f 100644 --- a/Kucoin.Net/Interfaces/Clients/FuturesApi/IKucoinRestClientFuturesApiAccount.cs +++ b/Kucoin.Net/Interfaces/Clients/FuturesApi/IKucoinRestClientFuturesApiAccount.cs @@ -19,7 +19,7 @@ public interface IKucoinRestClientFuturesApiAccount /// Gets account overview /// /// - /// Get the accounts for a specific asset + /// Get the accounts for a specific asset, for example `USDT` /// Cancellation token /// List of accounts Task> GetAccountOverviewAsync(string? asset = null, CancellationToken ct = default); @@ -28,7 +28,7 @@ public interface IKucoinRestClientFuturesApiAccount /// Get transaction history /// /// - /// Filter by asset + /// Filter by asset, for example `USDT` /// Filter by type /// Filter by start time /// Filter by end time @@ -43,7 +43,7 @@ public interface IKucoinRestClientFuturesApiAccount /// Transfer funds from futures to main account /// /// - /// Asset to transfer + /// Asset to transfer, for example `USDT` /// Quantity to transfer /// Receiving account type /// Cancellation token @@ -54,7 +54,7 @@ public interface IKucoinRestClientFuturesApiAccount /// Transfer funds from main or trade account to futures /// /// - /// Asset to transfer + /// Asset to transfer, for example `USDT` /// Quantity to transfer /// Account to move funds from /// Cancellation token @@ -65,7 +65,7 @@ public interface IKucoinRestClientFuturesApiAccount /// Get transfer to main account history /// /// - /// Filter by asset + /// Filter by asset, for example `USDT` /// Filter by start time /// Filter by end time /// Filter by status @@ -79,7 +79,7 @@ public interface IKucoinRestClientFuturesApiAccount /// Get the total value of active orders /// /// - /// Symbol + /// Symbol, for example `XBTUSDM` /// Cancellation token /// Task> GetOpenOrderValueAsync(string symbol, CancellationToken ct = default); @@ -88,7 +88,7 @@ public interface IKucoinRestClientFuturesApiAccount /// Get details on a position /// /// - /// Contract symbol + /// Contract symbol, for example `XBTUSDM` /// Cancellation token /// Position info Task> GetPositionAsync(string symbol, CancellationToken ct = default); @@ -97,7 +97,7 @@ public interface IKucoinRestClientFuturesApiAccount /// Get list of positions /// /// - /// Filter by asset + /// Filter by asset, for example `USDT` /// Cancellation token /// Position info Task>> GetPositionsAsync(string? asset = null, CancellationToken ct = default); @@ -106,7 +106,7 @@ public interface IKucoinRestClientFuturesApiAccount /// Get position closure history /// /// - /// Filter by symbol + /// Filter by symbol, for example `XBTUSDM` /// Filter by start time /// Filter by end time /// Max number of results @@ -119,7 +119,7 @@ public interface IKucoinRestClientFuturesApiAccount /// Enable/disable auto deposit margin /// /// - /// Symbol to change for + /// Symbol to change for, for example `XBTUSDM` /// Enable or disable /// Cancellation token /// Position info @@ -129,7 +129,7 @@ public interface IKucoinRestClientFuturesApiAccount /// Manually add margin to a position /// /// - /// Symbol + /// Symbol, for example `XBTUSDM` /// Quantity to add /// A unique ID generated by the user, to ensure the operation is processed by the system only once /// Cancellation token @@ -140,7 +140,7 @@ public interface IKucoinRestClientFuturesApiAccount /// Manually remove margin from a position /// /// - /// Symbol + /// Symbol, for example `XBTUSDM` /// Quantity to remove /// Cancellation token /// @@ -150,7 +150,7 @@ public interface IKucoinRestClientFuturesApiAccount /// Get funding history /// /// - /// Symbol + /// Symbol, for example `XBTUSDM` /// Filter by start time /// Filter by end time /// Result offset @@ -164,7 +164,7 @@ public interface IKucoinRestClientFuturesApiAccount /// Get risk limit level /// /// - /// Symbol + /// Symbol, for example `XBTUSDM` /// Cancellation token /// Task>> GetRiskLimitLevelAsync(string symbol, CancellationToken ct = default); @@ -173,7 +173,7 @@ public interface IKucoinRestClientFuturesApiAccount /// Set risk limit level /// /// - /// Symbol + /// Symbol, for example `XBTUSDM` /// Risk limit level /// Cancellation token /// @@ -183,7 +183,7 @@ public interface IKucoinRestClientFuturesApiAccount /// Get the maximum amount of margin that the current position supports withdrawal. /// /// - /// The symbol + /// The symbol, for example `XBTUSDM` /// Cancellation token /// Task> GetMaxWithdrawMarginAsync(string symbol, CancellationToken ct = default); @@ -192,7 +192,7 @@ public interface IKucoinRestClientFuturesApiAccount /// Get trading fee for a symbol /// /// - /// The symbol + /// The symbol, for example `XBTUSDM` /// Cancellation token /// Task> GetTradingFeeAsync(string symbol, CancellationToken ct = default); diff --git a/Kucoin.Net/Interfaces/Clients/FuturesApi/IKucoinRestClientFuturesApiExchangeData.cs b/Kucoin.Net/Interfaces/Clients/FuturesApi/IKucoinRestClientFuturesApiExchangeData.cs index f49f29c5..8f6a08b1 100644 --- a/Kucoin.Net/Interfaces/Clients/FuturesApi/IKucoinRestClientFuturesApiExchangeData.cs +++ b/Kucoin.Net/Interfaces/Clients/FuturesApi/IKucoinRestClientFuturesApiExchangeData.cs @@ -26,7 +26,7 @@ public interface IKucoinRestClientFuturesApiExchangeData /// Get a contract /// /// - /// Symbol of the contract + /// Symbol of the contract, for example `XBTUSDM` /// Cancellation token /// Task> GetContractAsync(string symbol, CancellationToken ct = default); @@ -35,7 +35,7 @@ public interface IKucoinRestClientFuturesApiExchangeData /// Get the ticker for a contract /// /// - /// Symbol of the contract + /// Symbol of the contract, for example `XBTUSDM` /// Cancellation token /// Task> GetTickerAsync(string symbol, CancellationToken ct = default); @@ -44,7 +44,7 @@ public interface IKucoinRestClientFuturesApiExchangeData /// Get the full order book, aggregated by price /// /// - /// Symbol of the contract + /// Symbol of the contract, for example `XBTUSDM` /// Cancellation token /// Task> GetAggregatedFullOrderBookAsync(string symbol, CancellationToken ct = default); @@ -53,7 +53,7 @@ public interface IKucoinRestClientFuturesApiExchangeData /// Get the partial order book, aggregated by price /// /// - /// Symbol of the contract + /// Symbol of the contract, for example `XBTUSDM` /// Amount of rows in the book, either 20 or 100 /// Cancellation token /// @@ -63,7 +63,7 @@ public interface IKucoinRestClientFuturesApiExchangeData /// Get interest rate list /// /// - /// Symbol + /// Symbol, for example `XBTUSDM` /// Filter by start time /// Filter by end time /// Result offset @@ -77,7 +77,7 @@ public interface IKucoinRestClientFuturesApiExchangeData /// Get index list /// /// - /// Symbol + /// Symbol, for example `XBTUSDM` /// Filter by start time /// Filter by end time /// Result offset @@ -91,7 +91,7 @@ public interface IKucoinRestClientFuturesApiExchangeData /// Get the current mark price /// /// - /// Symbol of the contract + /// Symbol of the contract, for example `XBTUSDM` /// Cancellation token /// Task> GetCurrentMarkPriceAsync(string symbol, CancellationToken ct = default); @@ -100,7 +100,7 @@ public interface IKucoinRestClientFuturesApiExchangeData /// Get premium index /// /// - /// Symbol + /// Symbol, for example `XBTUSDM` /// Filter by start time /// Filter by end time /// Result offset @@ -114,7 +114,7 @@ public interface IKucoinRestClientFuturesApiExchangeData /// Get the current funding rate /// /// - /// Symbol of the contract + /// Symbol of the contract, for example `XBTUSDM` /// Cancellation token /// Task> GetCurrentFundingRateAsync(string symbol, CancellationToken ct = default); @@ -123,7 +123,7 @@ public interface IKucoinRestClientFuturesApiExchangeData /// Get the most recent trades /// /// - /// Symbol of the contract + /// Symbol of the contract, for example `XBTUSDM` /// Cancellation token /// Task>> GetTradeHistoryAsync(string symbol, CancellationToken ct = default); @@ -148,7 +148,7 @@ public interface IKucoinRestClientFuturesApiExchangeData /// Get kline data /// /// - /// Symbol + /// Symbol, for example `XBTUSDM` /// Interval of the klines /// Start time to retrieve klines from /// End time to retrieve klines for @@ -168,7 +168,7 @@ public interface IKucoinRestClientFuturesApiExchangeData /// Get funding rate history for a symbol /// /// - /// Symbol name + /// Symbol name, for example `XBTUSDM` /// Start time /// End time /// Cancellation token diff --git a/Kucoin.Net/Interfaces/Clients/FuturesApi/IKucoinRestClientFuturesApiTrading.cs b/Kucoin.Net/Interfaces/Clients/FuturesApi/IKucoinRestClientFuturesApiTrading.cs index 89c05795..55748c87 100644 --- a/Kucoin.Net/Interfaces/Clients/FuturesApi/IKucoinRestClientFuturesApiTrading.cs +++ b/Kucoin.Net/Interfaces/Clients/FuturesApi/IKucoinRestClientFuturesApiTrading.cs @@ -19,7 +19,7 @@ public interface IKucoinRestClientFuturesApiTrading /// Place a new order /// /// - /// The contract for the order + /// The contract for the order, for example `XBTUSDM` /// Side of the order /// Type of order /// Leverage of the order @@ -68,7 +68,7 @@ Task> PlaceOrderAsync( /// Place a test order. The order will not be executed or added to the order book, but can be used to verify the request parameters /// /// - /// The contract for the order + /// The contract for the order, for example `XBTUSDM` /// Side of the order /// Type of order /// Leverage of the order @@ -137,7 +137,7 @@ Task> PlaceTestOrderAsync( /// Cancel an order by client order id /// /// - /// Symbol + /// Symbol, for example `XBTUSDM` /// Client order id of the order to cancel /// Cancellation token /// @@ -147,7 +147,7 @@ Task> PlaceTestOrderAsync( /// Cancel all open orders /// /// - /// Cancel only orders for this symbol + /// Cancel only orders for this symbol, for example `XBTUSDM` /// Cancellation token /// Canceled ids Task> CancelAllOrdersAsync(string? symbol = null, CancellationToken ct = default); @@ -165,7 +165,7 @@ Task> PlaceTestOrderAsync( /// Get list of orders /// /// - /// Filter by symbol + /// Filter by symbol, for example `XBTUSDM` /// Filter by status /// Filter by side /// Filter by type @@ -181,7 +181,7 @@ Task> PlaceTestOrderAsync( /// Get list of untriggered stop orders /// /// - /// Filter by symbol + /// Filter by symbol, for example `XBTUSDM` /// Filter by side /// Filter by type /// Filter by start time @@ -196,7 +196,7 @@ Task> PlaceTestOrderAsync( /// Get list of 1000 most recent orders in the last 24 hours /// /// - /// Filter by symbol + /// Filter by symbol, for example `XBTUSDM` /// Cancellation token /// List of orders Task>> GetClosedOrdersAsync(string? symbol = null, CancellationToken ct = default); @@ -223,7 +223,7 @@ Task> PlaceTestOrderAsync( /// Get list of user trades /// /// - /// Filter by symbol + /// Filter by symbol, for example `XBTUSDM` /// Filter by order id /// Filter by side /// Filter by type diff --git a/Kucoin.Net/Interfaces/Clients/FuturesApi/IKucoinSocketClientFuturesApi.cs b/Kucoin.Net/Interfaces/Clients/FuturesApi/IKucoinSocketClientFuturesApi.cs index 5b76ad0d..32d81122 100644 --- a/Kucoin.Net/Interfaces/Clients/FuturesApi/IKucoinSocketClientFuturesApi.cs +++ b/Kucoin.Net/Interfaces/Clients/FuturesApi/IKucoinSocketClientFuturesApi.cs @@ -21,7 +21,7 @@ public interface IKucoinSocketClientFuturesApi : ISocketApiClient, IDisposable /// Subscribe to trade updates /// /// - /// The symbol to subscribe on + /// The symbol to subscribe on, for example `XBTUSDM` /// The 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 and to unsubscribe @@ -31,7 +31,7 @@ public interface IKucoinSocketClientFuturesApi : ISocketApiClient, IDisposable /// Subscribe to trade updates /// /// - /// The symbols to subscribe on + /// The symbols to subscribe on, for example `XBTUSDM` /// The 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 and to unsubscribe @@ -41,7 +41,7 @@ public interface IKucoinSocketClientFuturesApi : ISocketApiClient, IDisposable /// Subscribe to ticker updates /// /// - /// The symbol to subscribe on + /// The symbol to subscribe on, for example `XBTUSDM` /// The 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 and to unsubscribe @@ -51,7 +51,7 @@ public interface IKucoinSocketClientFuturesApi : ISocketApiClient, IDisposable /// Subscribe to ticker updates /// /// - /// The symbol to subscribe on + /// The symbol to subscribe on, for example `XBTUSDM` /// The 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 and to unsubscribe @@ -61,7 +61,7 @@ public interface IKucoinSocketClientFuturesApi : ISocketApiClient, IDisposable /// Subscribe to full order book updates /// /// - /// The symbol to subscribe + /// The symbol to subscribe, for example `XBTUSDM` /// 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 and to unsubscribe @@ -71,7 +71,7 @@ public interface IKucoinSocketClientFuturesApi : ISocketApiClient, IDisposable /// Subscribe to full order book updates /// /// - /// The symbols to subscribe + /// The symbols to subscribe, for example `XBTUSDM` /// 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 and to unsubscribe @@ -82,7 +82,7 @@ public interface IKucoinSocketClientFuturesApi : ISocketApiClient, IDisposable /// /// /// - /// The symbol to subscribe + /// The symbol to subscribe, for example `XBTUSDM` /// The amount of levels to receive, either 5 or 50 /// Data handler /// Cancellation token for closing this subscription @@ -94,7 +94,7 @@ public interface IKucoinSocketClientFuturesApi : ISocketApiClient, IDisposable /// /// /// - /// The symbols to subscribe + /// The symbols to subscribe, for example `XBTUSDM` /// The amount of levels to receive, either 5 or 50 /// Data handler /// Cancellation token for closing this subscription @@ -105,7 +105,7 @@ public interface IKucoinSocketClientFuturesApi : ISocketApiClient, IDisposable /// Subscribe to market data updates /// /// - /// The symbol to subscribe + /// The symbol to subscribe, for example `XBTUSDM` /// Mark/Index price update handler /// Funding price update handler /// Cancellation token for closing this subscription @@ -119,7 +119,7 @@ Task> SubscribeToMarketUpdatesAsync(string symbol /// Subscribe to market data updates /// /// - /// The symbols to subscribe + /// The symbols to subscribe, for example `XBTUSDM` /// Mark/Index price update handler /// Funding price update handler /// Cancellation token for closing this subscription @@ -142,7 +142,7 @@ Task> SubscribeToMarketUpdatesAsync(IEnumerable /// - /// Symbol + /// Symbol, for example `XBTUSDM` /// 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 and to unsubscribe @@ -152,7 +152,7 @@ Task> SubscribeToMarketUpdatesAsync(IEnumerable /// - /// Symbol + /// Symbol, for example `XBTUSDM` /// 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 and to unsubscribe @@ -177,7 +177,7 @@ Task> SubscribeToBalanceUpdatesAsync( /// Subscribe to position updates for a specific symbol /// /// - /// Symbol + /// Symbol, for example `XBTUSDM` /// Handler for position changes /// Handler for update when position change due to mark price changes /// Handler for funding settlement updates @@ -213,7 +213,7 @@ Task> SubscribeToPositionUpdatesAsync( /// Subscribe to order updates /// /// - /// [Optional] Symbol + /// [Optional] Symbol, for example `XBTUSDM` /// 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 and to unsubscribe diff --git a/Kucoin.Net/Interfaces/Clients/SpotApi/IKucoinRestClientSpotApiAccount.cs b/Kucoin.Net/Interfaces/Clients/SpotApi/IKucoinRestClientSpotApiAccount.cs index 9bad1beb..5d510a65 100644 --- a/Kucoin.Net/Interfaces/Clients/SpotApi/IKucoinRestClientSpotApiAccount.cs +++ b/Kucoin.Net/Interfaces/Clients/SpotApi/IKucoinRestClientSpotApiAccount.cs @@ -34,7 +34,7 @@ public interface IKucoinRestClientSpotApiAccount /// Gets a list of accounts /// /// - /// Get the accounts for a specific asset + /// Get the accounts for a specific asset, for example `ETH` /// Filter on type of account /// Cancellation token /// List of accounts @@ -62,7 +62,7 @@ public interface IKucoinRestClientSpotApiAccount /// Get the trading fees for symbols /// /// - /// The symbol to retrieve fees for + /// The symbol to retrieve fees for, for example `ETH-USDT` /// Cancellation token /// Task>> GetSymbolTradingFeesAsync(string symbol, CancellationToken ct = default); @@ -71,7 +71,7 @@ public interface IKucoinRestClientSpotApiAccount /// Get the trading fees for symbols /// /// - /// The symbols to retrieve fees for + /// The symbols to retrieve fees for, for example `ETH-USDT` /// Cancellation token /// Task>> GetSymbolTradingFeesAsync(IEnumerable symbols, CancellationToken ct = default); @@ -80,7 +80,7 @@ public interface IKucoinRestClientSpotApiAccount /// Gets a list of account activity /// /// - /// The asset to retrieve activity or null + /// The asset to retrieve activity or null, for example `ETH` /// Filter by start time /// Side /// Business type @@ -95,9 +95,9 @@ public interface IKucoinRestClientSpotApiAccount /// Gets a transferable balance of a specified account. /// /// - /// Get the accounts for a specific asset + /// Get the accounts for a specific asset, for example `ETH` /// Filter on type of account - /// Filter by isolated margin symbol + /// Filter by isolated margin symbol, for example `ETH-USDT` /// Cancellation token /// Info on transferable account balance Task> GetTransferableAsync(string asset, AccountType accountType, string? isolatedMarginSymbol = null, CancellationToken ct = default); @@ -110,7 +110,7 @@ public interface IKucoinRestClientSpotApiAccount /// From account type /// To account type /// Transfer type - /// Asset to transfer + /// Asset to transfer, for example `ETH` /// Transfer out UserId， This is required when transferring sub-account to master-account. It is optional for internal transfers. /// Symbol, required when the account type is ISOLATED or ISOLATED_V2, for example: BTC-USDT /// Transfer in UserId， This is required when transferring master-account to sub-account. It is optional for internal transfers. @@ -135,7 +135,7 @@ Task> UniversalTransferAsync( /// Transfers assets between the accounts of a user. /// /// - /// Get the accounts for a specific asset + /// Get the accounts for a specific asset, for example `ETH` /// The type of the account /// The type of the account /// The quantity to transfer @@ -150,7 +150,7 @@ Task> UniversalTransferAsync( /// Gets a list of deposits /// /// - /// Filter list by asset + /// Filter list by asset, for example `ETH` /// Filter list by start time /// Filter list by end time /// Filter list by deposit status @@ -164,7 +164,7 @@ Task> UniversalTransferAsync( /// Gets a list of historical deposits /// /// - /// Filter list by asset + /// Filter list by asset, for example `ETH` /// Filter list by start time /// Filter list by end time /// Filter list by deposit status @@ -178,7 +178,7 @@ Task> UniversalTransferAsync( /// Gets the deposit address for an asset /// /// - /// The asset to get the address for + /// The asset to get the address for, for example `ETH` /// The network to get the address for /// Cancellation token /// The deposit address for the asset @@ -188,7 +188,7 @@ Task> UniversalTransferAsync( /// Gets the deposit addresses for an asset /// /// - /// The asset to get the address for + /// The asset to get the address for, for example `ETH` /// Cancellation token /// The deposit address for the asset Task>> GetDepositAddressesAsync(string asset, CancellationToken ct = default); @@ -197,7 +197,7 @@ Task> UniversalTransferAsync( /// Creates a new deposit address for an asset /// /// - /// The asset create the address for + /// The asset create the address for, for example `ETH` /// The network to create the address for /// Cancellation token /// The address that was created @@ -207,7 +207,7 @@ Task> UniversalTransferAsync( /// Gets a list of withdrawals /// /// - /// Filter list by asset + /// Filter list by asset, for example `ETH` /// Filter list by start time /// Filter list by end time /// Filter list by deposit status @@ -221,7 +221,7 @@ Task> UniversalTransferAsync( /// Gets a list of historical withdrawals /// /// - /// Filter list by asset + /// Filter list by asset, for example `ETH` /// Filter list by start time /// Filter list by end time /// Filter list by deposit status @@ -235,7 +235,7 @@ Task> UniversalTransferAsync( /// Get the withdrawal quota for a asset /// /// - /// The asset to get the quota for + /// The asset to get the quota for, for example `ETH` /// The network name of asset, e.g. The available value for USDT are OMNI, ERC20, TRC20, default is ERC20. This only apply for multi-chain currency, and there is no need for single chain currency. /// Cancellation token /// Quota info @@ -245,7 +245,7 @@ Task> UniversalTransferAsync( /// Withdraw an asset to an address /// /// - /// The asset to withdraw + /// The asset to withdraw, for example `ETH` /// The address to withdraw to /// The quantity to withdraw /// The note that is left on the withdrawal address. When you withdraw from KuCoin to other platforms, you need to fill in memo(tag). If you don't fill in memo(tag), your withdrawal may not be available. @@ -278,7 +278,7 @@ Task> UniversalTransferAsync( /// Get cross margin account info /// /// - /// Filter by quote asset + /// Filter by quote asset, for example `BTC` /// /// Task> GetCrossMarginAccountsAsync(string? quoteAsset = null, CancellationToken ct = default); @@ -295,7 +295,7 @@ Task> UniversalTransferAsync( /// Get isolated margin account info /// /// - /// The symbol + /// The symbol, for example `ETH-USDT` /// Cancellation token /// Task> GetIsolatedMarginAccountAsync(string symbol, CancellationToken ct = default); diff --git a/Kucoin.Net/Interfaces/Clients/SpotApi/IKucoinRestClientSpotApiExchangeData.cs b/Kucoin.Net/Interfaces/Clients/SpotApi/IKucoinRestClientSpotApiExchangeData.cs index 88e85c6e..7281b0c8 100644 --- a/Kucoin.Net/Interfaces/Clients/SpotApi/IKucoinRestClientSpotApiExchangeData.cs +++ b/Kucoin.Net/Interfaces/Clients/SpotApi/IKucoinRestClientSpotApiExchangeData.cs @@ -35,7 +35,7 @@ public interface IKucoinRestClientSpotApiExchangeData /// Gets ticker info of a symbol /// /// - /// The symbol to get info for + /// The symbol to get info for, for example `ETH-USDT` /// Cancellation token /// Ticker info Task> GetTickerAsync(string symbol, CancellationToken ct = default); @@ -52,7 +52,7 @@ public interface IKucoinRestClientSpotApiExchangeData /// Gets the 24 hour stats of a symbol /// /// - /// The symbol to get stats for + /// The symbol to get stats for, for example `ETH-USDT` /// Cancellation token /// 24 hour stats Task> Get24HourStatsAsync(string symbol, CancellationToken ct = default); @@ -69,7 +69,7 @@ public interface IKucoinRestClientSpotApiExchangeData /// Get a partial aggregated order book for a symbol. Orders for the same price are combined and amount results are limited. /// /// - /// The symbol to get order book for + /// The symbol to get order book for, for example `ETH-USDT` /// The limit of results (20 / 100) /// Cancellation token /// Partial aggregated order book @@ -79,7 +79,7 @@ public interface IKucoinRestClientSpotApiExchangeData /// Get a full aggregated order book for a symbol. Orders for the same price are combined. /// /// - /// The symbol to get order book for + /// The symbol to get order book for, for example `ETH-USDT` /// Cancellation token /// Full aggregated order book Task> GetAggregatedFullOrderBookAsync(string symbol, CancellationToken ct = default); @@ -88,7 +88,7 @@ public interface IKucoinRestClientSpotApiExchangeData /// Gets the recent trade history for a symbol /// /// - /// The symbol to get trade history for + /// The symbol to get trade history for, for example `ETH-USDT` /// Cancellation token /// List of trades for the symbol Task>> GetTradeHistoryAsync(string symbol, CancellationToken ct = default); @@ -97,7 +97,7 @@ public interface IKucoinRestClientSpotApiExchangeData /// Get kline data for a symbol /// /// - /// The symbol to get klines for + /// The symbol to get klines for, for example `ETH-USDT` /// The interval of a kline /// The start time of the data /// The end time of the data @@ -117,7 +117,7 @@ public interface IKucoinRestClientSpotApiExchangeData /// Get info on a specific asset /// /// - /// The asset to get + /// The asset to get, for example `ETH` /// Cancellation token /// Asset info Task> GetAssetAsync(string asset, CancellationToken ct = default); @@ -127,7 +127,7 @@ public interface IKucoinRestClientSpotApiExchangeData /// /// /// The three letter code of the fiat to convert to. Defaults to USD - /// The assets to get price for. Defaults to all + /// The assets to get price for. Defaults to all, for example `ETH` /// Cancellation token /// List of prices Task>> GetFiatPricesAsync(string? fiatBase = null, IEnumerable? assets = null, CancellationToken ct = default); diff --git a/Kucoin.Net/Interfaces/Clients/SpotApi/IKucoinRestClientSpotApiHfTrading.cs b/Kucoin.Net/Interfaces/Clients/SpotApi/IKucoinRestClientSpotApiHfTrading.cs index 6aa7304f..b37ff09a 100644 --- a/Kucoin.Net/Interfaces/Clients/SpotApi/IKucoinRestClientSpotApiHfTrading.cs +++ b/Kucoin.Net/Interfaces/Clients/SpotApi/IKucoinRestClientSpotApiHfTrading.cs @@ -18,7 +18,7 @@ public interface IKucoinRestClientSpotApiHfTrading /// Places an order and returns once the order is confirmed. This is the faster version of /// /// - /// The symbol the order is for + /// The symbol the order is for, for example `ETH-USDT` /// The side of the order /// The type of the order /// The price of the order. Only valid for limit orders. @@ -57,7 +57,7 @@ Task> PlaceOrderAsync( /// Places an order and wait for and return the full order result. This is the slower version of /// /// - /// The symbol the order is for + /// The symbol the order is for, for example `ETH-USDT` /// The side of the order /// The type of the order /// The price of the order. Only valid for limit orders. @@ -96,7 +96,7 @@ Task> PlaceOrderWaitAsync( /// Place a new test order. Only validates the parameters, but doesn't actually process the order /// /// - /// The symbol the order is for + /// The symbol the order is for, for example `ETH-USDT` /// The side of the order /// The type of the order /// The price of the order. Only valid for limit orders. @@ -135,7 +135,7 @@ Task> PlaceTestOrderAsync( /// Modify an order /// /// - /// Trading pair, such as ETH-BTC + /// Symbol, for example `ETH-USDT` /// The id of the order to modify /// The client id of the order to modify /// New order quantity @@ -172,7 +172,7 @@ Task> EditOrderAsync( /// Cancel an order and only wait for confirmation. This is the faster version of /// /// - /// Trading pair, such as ETH-BTC + /// Symbol, for example `ETH-USDT` /// The id of the order to cancel /// Cancellation token /// List of cancelled orders @@ -182,7 +182,7 @@ Task> EditOrderAsync( /// Cancel an order and wait for and return the full order results. This is the slower version of /// /// - /// Trading pair, such as ETH-BTC + /// Symbol, for example `ETH-USDT` /// The id of the order to cancel /// Cancellation token /// List of cancelled orders @@ -192,7 +192,7 @@ Task> EditOrderAsync( /// Cancel an order by clientOrderId and only wait for confirmation. This is the faster version of /// /// - /// Symbol + /// Symbol, for example `ETH-USDT` /// Client order id /// Cancellation token /// @@ -202,7 +202,7 @@ Task> EditOrderAsync( /// Cancel an order by clientOrderId and wait for and return the full order results. This is the slower version of /// /// - /// Symbol + /// Symbol, for example `ETH-USDT` /// Client order id /// Cancellation token /// @@ -212,7 +212,7 @@ Task> EditOrderAsync( /// Get info on a specific order /// /// - /// Trading pair, such as ETH-BTC + /// Symbol, for example `ETH-USDT` /// The id of the order /// Cancellation token /// Order info @@ -222,7 +222,7 @@ Task> EditOrderAsync( /// Get info on a specific order by clientOrderId /// /// - /// Trading pair, such as ETH-BTC + /// Symbol, for example `ETH-USDT` /// The clientOrderId of the order /// Cancellation token /// @@ -232,7 +232,7 @@ Task> EditOrderAsync( /// Cancel all orders on a symbol /// /// - /// The symbol + /// The symbol, for example `ETH-USDT` /// Cancellation token /// Task CancelAllOrdersBySymbolAsync(string symbol, CancellationToken ct = default); @@ -249,7 +249,7 @@ Task> EditOrderAsync( /// Get list open orders /// /// - /// Symbol + /// Symbol, for example `ETH-USDT` /// Cancellation token /// Task>> GetOpenOrdersAsync(string symbol, CancellationToken ct = default); @@ -266,7 +266,7 @@ Task> EditOrderAsync( /// Get list of closed orders /// /// - /// Symbol + /// Symbol, for example `ETH-USDT` /// Filter by side /// Filter by type /// Filter by start time @@ -281,7 +281,7 @@ Task> EditOrderAsync( /// Get list of user trades /// /// - /// Symbol + /// Symbol, for example `ETH-USDT` /// Filter by side /// Filter by type /// Filter by start time @@ -299,7 +299,7 @@ Task> EditOrderAsync( /// /// /// Cancel after this period - /// Symbols to cancel orders on + /// Symbols to cancel orders on, for example `ETH-USDT` /// Cancellation token /// Task> CancelAfterAsync(TimeSpan cancelAfter, IEnumerable? symbols = null, CancellationToken ct = default); @@ -318,7 +318,7 @@ Task> EditOrderAsync( /// /// Client order id /// The side((buy or sell) of the order - /// The symbol the order is for + /// The symbol the order is for, for example `ETH-USDT` /// The type of the order /// Remark on the order /// Self trade prevention setting @@ -363,7 +363,7 @@ Task> PlaceMarginOrderAsync( /// /// Client order id /// The side((buy or sell) of the order - /// The symbol the order is for + /// The symbol the order is for, for example `ETH-USDT` /// The type of the order /// Remark on the order /// Self trade prevention setting @@ -406,7 +406,7 @@ Task> PlaceTestMarginOrderAsync( /// Cancel a margin order /// /// - /// Symbol + /// Symbol, for example `ETH-USDT` /// Order id /// Cancellation token /// @@ -416,7 +416,7 @@ Task> PlaceTestMarginOrderAsync( /// Cancel a margin order by clientOrderId /// /// - /// Symbol + /// Symbol, for example `ETH-USDT` /// Client order id /// Cancellation token /// @@ -426,7 +426,7 @@ Task> PlaceTestMarginOrderAsync( /// Cancel all margin orders on a symbol /// /// - /// Symbol + /// Symbol, for example `ETH-USDT` /// Cancellation token /// Task CancelAllMarginOrdersBySymbolAsync(string symbol, CancellationToken ct = default); @@ -435,7 +435,7 @@ Task> PlaceTestMarginOrderAsync( /// Get open margin orders /// /// - /// Symbol + /// Symbol, for example `ETH-USDT` /// Trade type /// Cancellation token /// @@ -445,7 +445,7 @@ Task> PlaceTestMarginOrderAsync( /// Get closed margin orders /// /// - /// Symbol + /// Symbol, for example `ETH-USDT` /// Filter by side /// Filter by type /// Filter by trade type @@ -461,7 +461,7 @@ Task> PlaceTestMarginOrderAsync( /// Get a margin order by order id /// /// - /// Symbol + /// Symbol, for example `ETH-USDT` /// Order id /// Cancellation token /// @@ -471,7 +471,7 @@ Task> PlaceTestMarginOrderAsync( /// Get a margin order by clientOrderId /// /// - /// Symbol + /// Symbol, for example `ETH-USDT` /// Client order id /// Cancellation token /// @@ -481,7 +481,7 @@ Task> PlaceTestMarginOrderAsync( /// Get list of margin trades /// /// - /// Symbol + /// Symbol, for example `ETH-USDT` /// Filter by side /// Filter by type /// Filter by start time diff --git a/Kucoin.Net/Interfaces/Clients/SpotApi/IKucoinRestClientSpotApiMargin.cs b/Kucoin.Net/Interfaces/Clients/SpotApi/IKucoinRestClientSpotApiMargin.cs index e7f5e123..5ba4cbae 100644 --- a/Kucoin.Net/Interfaces/Clients/SpotApi/IKucoinRestClientSpotApiMargin.cs +++ b/Kucoin.Net/Interfaces/Clients/SpotApi/IKucoinRestClientSpotApiMargin.cs @@ -27,7 +27,7 @@ public interface IKucoinRestClientSpotApiMargin /// Get the mark price of a symbol /// /// - /// The symbol to retrieve + /// The symbol to retrieve, for example `USDT-BTC` /// Cancellation token /// Task> GetMarginMarkPriceAsync(string symbol, CancellationToken ct = default); @@ -60,7 +60,7 @@ public interface IKucoinRestClientSpotApiMargin /// Get isolated margin risk limit and asset configuration info /// /// - /// Symbol + /// Symbol, for example `ETH-USDT` /// Cancellation token /// Task>> GetIsolatedMarginRiskLimitAndConfig(string symbol, CancellationToken ct = default); @@ -111,7 +111,7 @@ Task> RepayAsync( /// /// Asset /// Filter by is isolated margin - /// Filter by isolated margin symbol + /// Filter by isolated margin symbol, for example `ETH-USDT` /// Filter by borrow order number /// Filter by start time /// Filter by end time @@ -127,7 +127,7 @@ Task> RepayAsync( /// /// Asset /// Filter by is isolated margin - /// Filter by isolated margin symbol + /// Filter by isolated margin symbol, for example `ETH-USDT` /// Filter by repay order number /// Filter by start time /// Filter by end time @@ -143,7 +143,7 @@ Task> RepayAsync( /// /// Asset /// Filter by is isolated margin - /// Filter by isolated margin symbol + /// Filter by isolated margin symbol, for example `ETH-USDT` /// Filter by start time /// Filter by end time /// The page to retrieve @@ -234,7 +234,7 @@ Task> RepayAsync( /// /// /// New leverage multiplier. Must be greater than 1 and up to two decimal places, and cannot be less than the user's current debt leverage or greater than the system's maximum leverage - /// Symbol. Leave empty for cross margin, or specify for isolated margin + /// Symbol. Leave empty for cross margin, or specify for isolated margin, for example `ETH-USDT` /// Is isolated margin /// Cancellation token /// @@ -244,7 +244,7 @@ Task> RepayAsync( /// Get cross margin symbols /// /// - /// Filter by symbol + /// Filter by symbol, for example `ETH-USDT` /// Cancellation token /// Task>> GetCrossMarginSymbolsAsync(string? symbol = null, CancellationToken ct = default); diff --git a/Kucoin.Net/Interfaces/Clients/SpotApi/IKucoinRestClientSpotApiTrading.cs b/Kucoin.Net/Interfaces/Clients/SpotApi/IKucoinRestClientSpotApiTrading.cs index 5979d304..d5e67c5d 100644 --- a/Kucoin.Net/Interfaces/Clients/SpotApi/IKucoinRestClientSpotApiTrading.cs +++ b/Kucoin.Net/Interfaces/Clients/SpotApi/IKucoinRestClientSpotApiTrading.cs @@ -18,7 +18,7 @@ public interface IKucoinRestClientSpotApiTrading /// Places an order /// /// - /// The symbol the order is for + /// The symbol the order is for, for example `ETH-USDT` /// The side of the order /// The type of the order /// The price of the order. Only valid for limit orders. @@ -57,7 +57,7 @@ Task> PlaceOrderAsync( /// Places a test order. Order gets validated but won't be processed /// /// - /// The symbol the order is for + /// The symbol the order is for, for example `ETH-USDT` /// The side of the order /// The type of the order /// The price of the order. Only valid for limit orders. @@ -98,7 +98,7 @@ Task> PlaceTestOrderAsync( /// /// Client order id /// The side((buy or sell) of the order - /// The symbol the order is for + /// The symbol the order is for, for example `ETH-USDT` /// The type of the order /// Remark on the order /// Self trade prevention setting @@ -143,7 +143,7 @@ Task> PlaceMarginOrderAsync( /// /// Client order id /// The side((buy or sell) of the order - /// The symbol the order is for + /// The symbol the order is for, for example `ETH-USDT` /// The type of the order /// Remark on the order /// Self trade prevention setting @@ -186,7 +186,7 @@ Task> PlaceTestMarginOrderAsync( /// Placec a new OCO order /// /// - /// Symbol + /// Symbol, for example `ETH-USDT` /// Order side /// Quantity /// Price @@ -213,7 +213,7 @@ Task> PlaceOcoOrderAsync( /// Places bulk orders /// /// - /// The symbol the order is for + /// The symbol the order is for, for example `ETH-USDT` /// Up to 5 orders to be placed at the same time /// Cancellation token /// List of new orders @@ -268,7 +268,7 @@ Task> PlaceOcoOrderAsync( /// Cancel all open orders /// /// - /// Only cancel orders for this symbol + /// Only cancel orders for this symbol, for example `ETH-USDT` /// Only cancel orders for this type /// Cancellation token /// List of canceled orders @@ -303,7 +303,7 @@ Task> PlaceOcoOrderAsync( /// Get OCO orders list /// /// - /// Filter by symbol + /// Filter by symbol, for example `ETH-USDT` /// Filter by order ids /// Filter list by start time /// Filter list by end time @@ -362,7 +362,7 @@ Task> PlaceOcoOrderAsync( /// Gets a list of fills /// /// - /// Filter list by symbol + /// Filter list by symbol, for example `ETH-USDT` /// Filter list by order type /// Filter list by order side /// Filter list by start time @@ -387,7 +387,7 @@ Task> PlaceOcoOrderAsync( /// Place a new stop order /// /// - /// The symbol the order is for + /// The symbol the order is for, for example `ETH-USDT` /// The side of the order /// The type of the order /// The price of the order. Only valid for limit orders. @@ -450,7 +450,7 @@ Task> PlaceStopOrderAsync( /// Cancel all stop orders fitting the provided parameters /// /// - /// Symbol to cancel orders on + /// Symbol to cancel orders on, for example `ETH-USDT` /// Order ids of the orders to cancel /// Trade type /// Cancellation token @@ -462,7 +462,7 @@ Task> PlaceStopOrderAsync( /// /// /// True to return active orders, false for completed orders - /// Symbol of the orders + /// Symbol of the orders, for example `ETH-USDT` /// Side of the orders /// Type of the orders /// Trade type diff --git a/Kucoin.Net/Interfaces/Clients/SpotApi/IKucoinSocketClientSpotApi.cs b/Kucoin.Net/Interfaces/Clients/SpotApi/IKucoinSocketClientSpotApi.cs index aa5c8113..9961d35d 100644 --- a/Kucoin.Net/Interfaces/Clients/SpotApi/IKucoinSocketClientSpotApi.cs +++ b/Kucoin.Net/Interfaces/Clients/SpotApi/IKucoinSocketClientSpotApi.cs @@ -21,7 +21,7 @@ public interface IKucoinSocketClientSpotApi : ISocketApiClient, IDisposable /// Subscribe to updates for a symbol ticker /// /// - /// The symbol to subscribe to + /// The symbol to subscribe to, for example `ETH-USDT` /// The 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 and to unsubscribe @@ -31,7 +31,7 @@ public interface IKucoinSocketClientSpotApi : ISocketApiClient, IDisposable /// Subscribe to updates for a symbol ticker /// /// - /// The symbols to subscribe to + /// The symbols to subscribe to, for example `ETH-USDT` /// The 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 and to unsubscribe @@ -72,7 +72,7 @@ Task> SubscribeToSnapshotUpdatesAsync( /// Subscribe to aggregated order book updates /// /// - /// The symbol to subscribe on + /// The symbol to subscribe on, for example `ETH-USDT` /// The 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 and to unsubscribe @@ -82,7 +82,7 @@ Task> SubscribeToSnapshotUpdatesAsync( /// Subscribe to aggregated order book updates /// /// - /// The symbols to subscribe on + /// The symbols to subscribe on, for example `ETH-USDT` /// The 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 and to unsubscribe @@ -92,7 +92,7 @@ Task> SubscribeToSnapshotUpdatesAsync( /// Subscribe to trade updates /// /// - /// The symbol to subscribe on + /// The symbol to subscribe on, for example `ETH-USDT` /// The 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 and to unsubscribe @@ -102,7 +102,7 @@ Task> SubscribeToSnapshotUpdatesAsync( /// Subscribe to trade updates /// /// - /// The symbols to subscribe on + /// The symbols to subscribe on, for example `ETH-USDT` /// The 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 and to unsubscribe @@ -112,7 +112,7 @@ Task> SubscribeToSnapshotUpdatesAsync( /// Subscribe to kline updates /// /// - /// Symbol to subscribe + /// Symbol to subscribe, for example `ETH-USDT` /// Interval of the klines /// Data handler /// Cancellation token for closing this subscription @@ -120,31 +120,31 @@ Task> SubscribeToSnapshotUpdatesAsync( Task> SubscribeToKlineUpdatesAsync(string symbol, KlineInterval interval, Action> onData, CancellationToken ct = default); /// - /// + /// Subscribe to book ticker (best ask/bid) updates /// /// - /// - /// - /// + /// Symbol to subscribe, for example `ETH-USDT` + /// Data handler + /// Cancellation token for closing this subscription /// - Task> SubscribeToBestOfferUpdatesAsync(string symbol, Action> onData, CancellationToken ct = default); + Task> SubscribeToBookTickerUpdatesAsync(string symbol, Action> onData, CancellationToken ct = default); /// - /// + /// Subscribe to book ticker (best ask/bid) updates /// /// - /// - /// - /// + /// Symbols to subscribe, for example `ETH-USDT` + /// Data handler + /// Cancellation token for closing this subscription /// - Task> SubscribeToBestOfferUpdatesAsync(IEnumerable symbols, Action> onData, CancellationToken ct = default); + Task> SubscribeToBookTickerUpdatesAsync(IEnumerable symbols, Action> onData, CancellationToken ct = default); /// /// Subscribe to full order book updates /// /// /// - /// The symbol to subscribe + /// The symbol to subscribe, for example `ETH-USDT` /// The amount of levels to receive, either 5 or 50 /// Data handler /// Cancellation token for closing this subscription @@ -157,7 +157,7 @@ Task> SubscribeToOrderBookUpdatesAsync(string sym /// /// /// - /// The symbols to subscribe + /// The symbols to subscribe, for example `ETH-USDT` /// The amount of levels to receive, either 5 or 50 /// Data handler /// Cancellation token for closing this subscription @@ -221,7 +221,7 @@ Task> SubscribeToOrderUpdatesAsync( /// Subscribe to index price updates /// /// - /// The symbol to subscribe + /// The symbol to subscribe, for example `USDT-BTC` /// 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 and to unsubscribe @@ -231,7 +231,7 @@ Task> SubscribeToOrderUpdatesAsync( /// Subscribe to index price updates /// /// - /// The symbols to subscribe + /// The symbols to subscribe, for example `USDT-BTC` /// 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 and to unsubscribe @@ -241,7 +241,7 @@ Task> SubscribeToOrderUpdatesAsync( /// Subscribe to mark price updates /// /// - /// The symbol to subscribe + /// The symbol to subscribe, for example `USDT-BTC` /// Data handler /// Cancellation token for closing this subscription /// @@ -251,7 +251,7 @@ Task> SubscribeToOrderUpdatesAsync( /// Subscribe to mark price updates /// /// - /// The symbols to subscribe + /// The symbols to subscribe, for example `USDT-BTC` /// Data handler /// Cancellation token for closing this subscription /// @@ -271,7 +271,7 @@ Task> SubscribeToOrderUpdatesAsync( /// Subscribe to margin order updates for an asset /// /// - /// Asset + /// Asset, for example `ETH-USDT` /// Data handler for order placement updates /// Data handler for order updates /// Data handler for order done updates diff --git a/Kucoin.Net/Kucoin.Net.xml b/Kucoin.Net/Kucoin.Net.xml index a5229db5..51d1bf39 100644 --- a/Kucoin.Net/Kucoin.Net.xml +++ b/Kucoin.Net/Kucoin.Net.xml @@ -826,10 +826,10 @@ - + - + @@ -2293,7 +2293,7 @@ Gets account overview - Get the accounts for a specific asset + Get the accounts for a specific asset, for example `USDT` Cancellation token List of accounts @@ -2302,7 +2302,7 @@ Get transaction history - Filter by asset + Filter by asset, for example `USDT` Filter by type Filter by start time Filter by end time @@ -2317,7 +2317,7 @@ Transfer funds from futures to main account - Asset to transfer + Asset to transfer, for example `USDT` Quantity to transfer Receiving account type Cancellation token @@ -2328,7 +2328,7 @@ Transfer funds from main or trade account to futures - Asset to transfer + Asset to transfer, for example `USDT` Quantity to transfer Account to move funds from Cancellation token @@ -2339,7 +2339,7 @@ Get transfer to main account history - Filter by asset + Filter by asset, for example `USDT` Filter by start time Filter by end time Filter by status @@ -2353,7 +2353,7 @@ Get the total value of active orders - Symbol + Symbol, for example `XBTUSDM` Cancellation token @@ -2362,7 +2362,7 @@ Get details on a position - Contract symbol + Contract symbol, for example `XBTUSDM` Cancellation token Position info @@ -2371,7 +2371,7 @@ Get list of positions - Filter by asset + Filter by asset, for example `USDT` Cancellation token Position info @@ -2380,7 +2380,7 @@ Get position closure history - Filter by symbol + Filter by symbol, for example `XBTUSDM` Filter by start time Filter by end time Max number of results @@ -2393,7 +2393,7 @@ Enable/disable auto deposit margin - Symbol to change for + Symbol to change for, for example `XBTUSDM` Enable or disable Cancellation token Position info @@ -2403,7 +2403,7 @@ Manually add margin to a position - Symbol + Symbol, for example `XBTUSDM` Quantity to add A unique ID generated by the user, to ensure the operation is processed by the system only once Cancellation token @@ -2414,7 +2414,7 @@ Manually remove margin from a position - Symbol + Symbol, for example `XBTUSDM` Quantity to remove Cancellation token @@ -2424,7 +2424,7 @@ Get funding history - Symbol + Symbol, for example `XBTUSDM` Filter by start time Filter by end time Result offset @@ -2438,7 +2438,7 @@ Get risk limit level - Symbol + Symbol, for example `XBTUSDM` Cancellation token @@ -2447,7 +2447,7 @@ Set risk limit level - Symbol + Symbol, for example `XBTUSDM` Risk limit level Cancellation token @@ -2457,7 +2457,7 @@ Get the maximum amount of margin that the current position supports withdrawal. - The symbol + The symbol, for example `XBTUSDM` Cancellation token @@ -2466,7 +2466,7 @@ Get trading fee for a symbol - The symbol + The symbol, for example `XBTUSDM` Cancellation token @@ -2488,7 +2488,7 @@ Get a contract - Symbol of the contract + Symbol of the contract, for example `XBTUSDM` Cancellation token @@ -2497,7 +2497,7 @@ Get the ticker for a contract - Symbol of the contract + Symbol of the contract, for example `XBTUSDM` Cancellation token @@ -2506,7 +2506,7 @@ Get the full order book, aggregated by price - Symbol of the contract + Symbol of the contract, for example `XBTUSDM` Cancellation token @@ -2515,7 +2515,7 @@ Get the partial order book, aggregated by price - Symbol of the contract + Symbol of the contract, for example `XBTUSDM` Amount of rows in the book, either 20 or 100 Cancellation token @@ -2525,7 +2525,7 @@ Get interest rate list - Symbol + Symbol, for example `XBTUSDM` Filter by start time Filter by end time Result offset @@ -2539,7 +2539,7 @@ Get index list - Symbol + Symbol, for example `XBTUSDM` Filter by start time Filter by end time Result offset @@ -2553,7 +2553,7 @@ Get the current mark price - Symbol of the contract + Symbol of the contract, for example `XBTUSDM` Cancellation token @@ -2562,7 +2562,7 @@ Get premium index - Symbol + Symbol, for example `XBTUSDM` Filter by start time Filter by end time Result offset @@ -2576,7 +2576,7 @@ Get the current funding rate - Symbol of the contract + Symbol of the contract, for example `XBTUSDM` Cancellation token @@ -2585,7 +2585,7 @@ Get the most recent trades - Symbol of the contract + Symbol of the contract, for example `XBTUSDM` Cancellation token @@ -2610,7 +2610,7 @@ Get kline data - Symbol + Symbol, for example `XBTUSDM` Interval of the klines Start time to retrieve klines from End time to retrieve klines for @@ -2630,7 +2630,7 @@ Get funding rate history for a symbol - Symbol name + Symbol name, for example `XBTUSDM` Start time End time Cancellation token @@ -2646,7 +2646,7 @@ Place a new order - The contract for the order + The contract for the order, for example `XBTUSDM` Side of the order Type of order Leverage of the order @@ -2674,7 +2674,7 @@ Place a test order. The order will not be executed or added to the order book, but can be used to verify the request parameters - The contract for the order + The contract for the order, for example `XBTUSDM` Side of the order Type of order Leverage of the order @@ -2720,7 +2720,7 @@ Cancel an order by client order id - Symbol + Symbol, for example `XBTUSDM` Client order id of the order to cancel Cancellation token @@ -2730,7 +2730,7 @@ Cancel all open orders - Cancel only orders for this symbol + Cancel only orders for this symbol, for example `XBTUSDM` Cancellation token Canceled ids @@ -2748,7 +2748,7 @@ Get list of orders - Filter by symbol + Filter by symbol, for example `XBTUSDM` Filter by status Filter by side Filter by type @@ -2764,7 +2764,7 @@ Get list of untriggered stop orders - Filter by symbol + Filter by symbol, for example `XBTUSDM` Filter by side Filter by type Filter by start time @@ -2779,7 +2779,7 @@ Get list of 1000 most recent orders in the last 24 hours - Filter by symbol + Filter by symbol, for example `XBTUSDM` Cancellation token List of orders @@ -2806,7 +2806,7 @@ Get list of user trades - Filter by symbol + Filter by symbol, for example `XBTUSDM` Filter by order id Filter by side Filter by type @@ -2835,7 +2835,7 @@ Subscribe to trade updates - The symbol to subscribe on + The symbol to subscribe on, for example `XBTUSDM` The 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 and to unsubscribe @@ -2845,7 +2845,7 @@ Subscribe to trade updates - The symbols to subscribe on + The symbols to subscribe on, for example `XBTUSDM` The 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 and to unsubscribe @@ -2855,7 +2855,7 @@ Subscribe to ticker updates - The symbol to subscribe on + The symbol to subscribe on, for example `XBTUSDM` The 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 and to unsubscribe @@ -2865,7 +2865,7 @@ Subscribe to ticker updates - The symbol to subscribe on + The symbol to subscribe on, for example `XBTUSDM` The 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 and to unsubscribe @@ -2875,7 +2875,7 @@ Subscribe to full order book updates - The symbol to subscribe + The symbol to subscribe, for example `XBTUSDM` 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 and to unsubscribe @@ -2885,7 +2885,7 @@ Subscribe to full order book updates - The symbols to subscribe + The symbols to subscribe, for example `XBTUSDM` 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 and to unsubscribe @@ -2896,7 +2896,7 @@ - The symbol to subscribe + The symbol to subscribe, for example `XBTUSDM` The amount of levels to receive, either 5 or 50 Data handler Cancellation token for closing this subscription @@ -2908,7 +2908,7 @@ - The symbols to subscribe + The symbols to subscribe, for example `XBTUSDM` The amount of levels to receive, either 5 or 50 Data handler Cancellation token for closing this subscription @@ -2919,7 +2919,7 @@ Subscribe to market data updates - The symbol to subscribe + The symbol to subscribe, for example `XBTUSDM` Mark/Index price update handler Funding price update handler Cancellation token for closing this subscription @@ -2930,7 +2930,7 @@ Subscribe to market data updates - The symbols to subscribe + The symbols to subscribe, for example `XBTUSDM` Mark/Index price update handler Funding price update handler Cancellation token for closing this subscription @@ -2950,7 +2950,7 @@ Subscribe to snapshot updates - Symbol + Symbol, for example `XBTUSDM` 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 and to unsubscribe @@ -2960,7 +2960,7 @@ Subscribe to snapshot updates - Symbol + Symbol, for example `XBTUSDM` 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 and to unsubscribe @@ -2981,7 +2981,7 @@ Subscribe to position updates for a specific symbol - Symbol + Symbol, for example `XBTUSDM` Handler for position changes Handler for update when position change due to mark price changes Handler for funding settlement updates @@ -3006,7 +3006,7 @@ Subscribe to order updates - [Optional] Symbol + [Optional] Symbol, for example `XBTUSDM` 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 and to unsubscribe @@ -3124,7 +3124,7 @@ Gets a list of accounts - Get the accounts for a specific asset + Get the accounts for a specific asset, for example `ETH` Filter on type of account Cancellation token List of accounts @@ -3152,7 +3152,7 @@ Get the trading fees for symbols - The symbol to retrieve fees for + The symbol to retrieve fees for, for example `ETH-USDT` Cancellation token @@ -3161,7 +3161,7 @@ Get the trading fees for symbols - The symbols to retrieve fees for + The symbols to retrieve fees for, for example `ETH-USDT` Cancellation token @@ -3170,7 +3170,7 @@ Gets a list of account activity - The asset to retrieve activity or null + The asset to retrieve activity or null, for example `ETH` Filter by start time Side Business type @@ -3185,9 +3185,9 @@ Gets a transferable balance of a specified account. - Get the accounts for a specific asset + Get the accounts for a specific asset, for example `ETH` Filter on type of account - Filter by isolated margin symbol + Filter by isolated margin symbol, for example `ETH-USDT` Cancellation token Info on transferable account balance @@ -3200,7 +3200,7 @@ From account type To account type Transfer type - Asset to transfer + Asset to transfer, for example `ETH` Transfer out UserId， This is required when transferring sub-account to master-account. It is optional for internal transfers. Symbol, required when the account type is ISOLATED or ISOLATED_V2, for example: BTC-USDT Transfer in UserId， This is required when transferring master-account to sub-account. It is optional for internal transfers. @@ -3214,7 +3214,7 @@ Transfers assets between the accounts of a user. - Get the accounts for a specific asset + Get the accounts for a specific asset, for example `ETH` The type of the account The type of the account The quantity to transfer @@ -3229,7 +3229,7 @@ Gets a list of deposits - Filter list by asset + Filter list by asset, for example `ETH` Filter list by start time Filter list by end time Filter list by deposit status @@ -3243,7 +3243,7 @@ Gets a list of historical deposits - Filter list by asset + Filter list by asset, for example `ETH` Filter list by start time Filter list by end time Filter list by deposit status @@ -3257,7 +3257,7 @@ Gets the deposit address for an asset - The asset to get the address for + The asset to get the address for, for example `ETH` The network to get the address for Cancellation token The deposit address for the asset @@ -3267,7 +3267,7 @@ Gets the deposit addresses for an asset - The asset to get the address for + The asset to get the address for, for example `ETH` Cancellation token The deposit address for the asset @@ -3276,7 +3276,7 @@ Creates a new deposit address for an asset - The asset create the address for + The asset create the address for, for example `ETH` The network to create the address for Cancellation token The address that was created @@ -3286,7 +3286,7 @@ Gets a list of withdrawals - Filter list by asset + Filter list by asset, for example `ETH` Filter list by start time Filter list by end time Filter list by deposit status @@ -3300,7 +3300,7 @@ Gets a list of historical withdrawals - Filter list by asset + Filter list by asset, for example `ETH` Filter list by start time Filter list by end time Filter list by deposit status @@ -3314,7 +3314,7 @@ Get the withdrawal quota for a asset - The asset to get the quota for + The asset to get the quota for, for example `ETH` The network name of asset, e.g. The available value for USDT are OMNI, ERC20, TRC20, default is ERC20. This only apply for multi-chain currency, and there is no need for single chain currency. Cancellation token Quota info @@ -3324,7 +3324,7 @@ Withdraw an asset to an address - The asset to withdraw + The asset to withdraw, for example `ETH` The address to withdraw to The quantity to withdraw The note that is left on the withdrawal address. When you withdraw from KuCoin to other platforms, you need to fill in memo(tag). If you don't fill in memo(tag), your withdrawal may not be available. @@ -3357,7 +3357,7 @@ Get cross margin account info - Filter by quote asset + Filter by quote asset, for example `BTC` @@ -3374,7 +3374,7 @@ Get isolated margin account info - The symbol + The symbol, for example `ETH-USDT` Cancellation token @@ -3405,7 +3405,7 @@ Gets ticker info of a symbol - The symbol to get info for + The symbol to get info for, for example `ETH-USDT` Cancellation token Ticker info @@ -3422,7 +3422,7 @@ Gets the 24 hour stats of a symbol - The symbol to get stats for + The symbol to get stats for, for example `ETH-USDT` Cancellation token 24 hour stats @@ -3439,7 +3439,7 @@ Get a partial aggregated order book for a symbol. Orders for the same price are combined and amount results are limited. - The symbol to get order book for + The symbol to get order book for, for example `ETH-USDT` The limit of results (20 / 100) Cancellation token Partial aggregated order book @@ -3449,7 +3449,7 @@ Get a full aggregated order book for a symbol. Orders for the same price are combined. - The symbol to get order book for + The symbol to get order book for, for example `ETH-USDT` Cancellation token Full aggregated order book @@ -3458,7 +3458,7 @@ Gets the recent trade history for a symbol - The symbol to get trade history for + The symbol to get trade history for, for example `ETH-USDT` Cancellation token List of trades for the symbol @@ -3467,7 +3467,7 @@ Get kline data for a symbol - The symbol to get klines for + The symbol to get klines for, for example `ETH-USDT` The interval of a kline The start time of the data The end time of the data @@ -3487,7 +3487,7 @@ Get info on a specific asset - The asset to get + The asset to get, for example `ETH` Cancellation token Asset info @@ -3497,7 +3497,7 @@ The three letter code of the fiat to convert to. Defaults to USD - The assets to get price for. Defaults to all + The assets to get price for. Defaults to all, for example `ETH` Cancellation token List of prices @@ -3519,7 +3519,7 @@ Places an order and returns once the order is confirmed. This is the faster version of - The symbol the order is for + The symbol the order is for, for example `ETH-USDT` The side of the order The type of the order The price of the order. Only valid for limit orders. @@ -3542,7 +3542,7 @@ Places an order and wait for and return the full order result. This is the slower version of - The symbol the order is for + The symbol the order is for, for example `ETH-USDT` The side of the order The type of the order The price of the order. Only valid for limit orders. @@ -3565,7 +3565,7 @@ Place a new test order. Only validates the parameters, but doesn't actually process the order - The symbol the order is for + The symbol the order is for, for example `ETH-USDT` The side of the order The type of the order The price of the order. Only valid for limit orders. @@ -3588,7 +3588,7 @@ Modify an order - Trading pair, such as ETH-BTC + Symbol, for example `ETH-USDT` The id of the order to modify The client id of the order to modify New order quantity @@ -3619,7 +3619,7 @@ Cancel an order and only wait for confirmation. This is the faster version of - Trading pair, such as ETH-BTC + Symbol, for example `ETH-USDT` The id of the order to cancel Cancellation token List of cancelled orders @@ -3629,7 +3629,7 @@ Cancel an order and wait for and return the full order results. This is the slower version of - Trading pair, such as ETH-BTC + Symbol, for example `ETH-USDT` The id of the order to cancel Cancellation token List of cancelled orders @@ -3639,7 +3639,7 @@ Cancel an order by clientOrderId and only wait for confirmation. This is the faster version of - Symbol + Symbol, for example `ETH-USDT` Client order id Cancellation token @@ -3649,7 +3649,7 @@ Cancel an order by clientOrderId and wait for and return the full order results. This is the slower version of - Symbol + Symbol, for example `ETH-USDT` Client order id Cancellation token @@ -3659,7 +3659,7 @@ Get info on a specific order - Trading pair, such as ETH-BTC + Symbol, for example `ETH-USDT` The id of the order Cancellation token Order info @@ -3669,7 +3669,7 @@ Get info on a specific order by clientOrderId - Trading pair, such as ETH-BTC + Symbol, for example `ETH-USDT` The clientOrderId of the order Cancellation token @@ -3679,7 +3679,7 @@ Cancel all orders on a symbol - The symbol + The symbol, for example `ETH-USDT` Cancellation token @@ -3696,7 +3696,7 @@ Get list open orders - Symbol + Symbol, for example `ETH-USDT` Cancellation token @@ -3713,7 +3713,7 @@ Get list of closed orders - Symbol + Symbol, for example `ETH-USDT` Filter by side Filter by type Filter by start time @@ -3728,7 +3728,7 @@ Get list of user trades - Symbol + Symbol, for example `ETH-USDT` Filter by side Filter by type Filter by start time @@ -3746,7 +3746,7 @@ Cancel after this period - Symbols to cancel orders on + Symbols to cancel orders on, for example `ETH-USDT` Cancellation token @@ -3765,7 +3765,7 @@ Client order id The side((buy or sell) of the order - The symbol the order is for + The symbol the order is for, for example `ETH-USDT` The type of the order Remark on the order Self trade prevention setting @@ -3791,7 +3791,7 @@ Client order id The side((buy or sell) of the order - The symbol the order is for + The symbol the order is for, for example `ETH-USDT` The type of the order Remark on the order Self trade prevention setting @@ -3815,7 +3815,7 @@ Cancel a margin order - Symbol + Symbol, for example `ETH-USDT` Order id Cancellation token @@ -3825,7 +3825,7 @@ Cancel a margin order by clientOrderId - Symbol + Symbol, for example `ETH-USDT` Client order id Cancellation token @@ -3835,7 +3835,7 @@ Cancel all margin orders on a symbol - Symbol + Symbol, for example `ETH-USDT` Cancellation token @@ -3844,7 +3844,7 @@ Get open margin orders - Symbol + Symbol, for example `ETH-USDT` Trade type Cancellation token @@ -3854,7 +3854,7 @@ Get closed margin orders - Symbol + Symbol, for example `ETH-USDT` Filter by side Filter by type Filter by trade type @@ -3870,7 +3870,7 @@ Get a margin order by order id - Symbol + Symbol, for example `ETH-USDT` Order id Cancellation token @@ -3880,7 +3880,7 @@ Get a margin order by clientOrderId - Symbol + Symbol, for example `ETH-USDT` Client order id Cancellation token @@ -3890,7 +3890,7 @@ Get list of margin trades - Symbol + Symbol, for example `ETH-USDT` Filter by side Filter by type Filter by start time @@ -3929,7 +3929,7 @@ Get the mark price of a symbol - The symbol to retrieve + The symbol to retrieve, for example `USDT-BTC` Cancellation token @@ -3962,7 +3962,7 @@ Get isolated margin risk limit and asset configuration info - Symbol + Symbol, for example `ETH-USDT` Cancellation token @@ -4000,7 +4000,7 @@ Asset Filter by is isolated margin - Filter by isolated margin symbol + Filter by isolated margin symbol, for example `ETH-USDT` Filter by borrow order number Filter by start time Filter by end time @@ -4016,7 +4016,7 @@ Asset Filter by is isolated margin - Filter by isolated margin symbol + Filter by isolated margin symbol, for example `ETH-USDT` Filter by repay order number Filter by start time Filter by end time @@ -4032,7 +4032,7 @@ Asset Filter by is isolated margin - Filter by isolated margin symbol + Filter by isolated margin symbol, for example `ETH-USDT` Filter by start time Filter by end time The page to retrieve @@ -4123,7 +4123,7 @@ New leverage multiplier. Must be greater than 1 and up to two decimal places, and cannot be less than the user's current debt leverage or greater than the system's maximum leverage - Symbol. Leave empty for cross margin, or specify for isolated margin + Symbol. Leave empty for cross margin, or specify for isolated margin, for example `ETH-USDT` Is isolated margin Cancellation token @@ -4133,7 +4133,7 @@ Get cross margin symbols - Filter by symbol + Filter by symbol, for example `ETH-USDT` Cancellation token @@ -4147,7 +4147,7 @@ Places an order - The symbol the order is for + The symbol the order is for, for example `ETH-USDT` The side of the order The type of the order The price of the order. Only valid for limit orders. @@ -4170,7 +4170,7 @@ Places a test order. Order gets validated but won't be processed - The symbol the order is for + The symbol the order is for, for example `ETH-USDT` The side of the order The type of the order The price of the order. Only valid for limit orders. @@ -4195,7 +4195,7 @@ Client order id The side((buy or sell) of the order - The symbol the order is for + The symbol the order is for, for example `ETH-USDT` The type of the order Remark on the order Self trade prevention setting @@ -4221,7 +4221,7 @@ Client order id The side((buy or sell) of the order - The symbol the order is for + The symbol the order is for, for example `ETH-USDT` The type of the order Remark on the order Self trade prevention setting @@ -4245,7 +4245,7 @@ Placec a new OCO order - Symbol + Symbol, for example `ETH-USDT` Order side Quantity Price @@ -4262,7 +4262,7 @@ Places bulk orders - The symbol the order is for + The symbol the order is for, for example `ETH-USDT` Up to 5 orders to be placed at the same time Cancellation token List of new orders @@ -4317,7 +4317,7 @@ Cancel all open orders - Only cancel orders for this symbol + Only cancel orders for this symbol, for example `ETH-USDT` Only cancel orders for this type Cancellation token List of canceled orders @@ -4352,7 +4352,7 @@ Get OCO orders list - Filter by symbol + Filter by symbol, for example `ETH-USDT` Filter by order ids Filter list by start time Filter list by end time @@ -4411,7 +4411,7 @@ Gets a list of fills - Filter list by symbol + Filter list by symbol, for example `ETH-USDT` Filter list by order type Filter list by order side Filter list by start time @@ -4436,7 +4436,7 @@ Place a new stop order - The symbol the order is for + The symbol the order is for, for example `ETH-USDT` The side of the order The type of the order The price of the order. Only valid for limit orders. @@ -4480,7 +4480,7 @@ Cancel all stop orders fitting the provided parameters - Symbol to cancel orders on + Symbol to cancel orders on, for example `ETH-USDT` Order ids of the orders to cancel Trade type Cancellation token @@ -4492,7 +4492,7 @@ True to return active orders, false for completed orders - Symbol of the orders + Symbol of the orders, for example `ETH-USDT` Side of the orders Type of the orders Trade type @@ -4532,7 +4532,7 @@ Subscribe to updates for a symbol ticker - The symbol to subscribe to + The symbol to subscribe to, for example `ETH-USDT` The 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 and to unsubscribe @@ -4542,7 +4542,7 @@ Subscribe to updates for a symbol ticker - The symbols to subscribe to + The symbols to subscribe to, for example `ETH-USDT` The 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 and to unsubscribe @@ -4581,7 +4581,7 @@ Subscribe to aggregated order book updates - The symbol to subscribe on + The symbol to subscribe on, for example `ETH-USDT` The 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 and to unsubscribe @@ -4591,7 +4591,7 @@ Subscribe to aggregated order book updates - The symbols to subscribe on + The symbols to subscribe on, for example `ETH-USDT` The 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 and to unsubscribe @@ -4601,7 +4601,7 @@ Subscribe to trade updates - The symbol to subscribe on + The symbol to subscribe on, for example `ETH-USDT` The 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 and to unsubscribe @@ -4611,7 +4611,7 @@ Subscribe to trade updates - The symbols to subscribe on + The symbols to subscribe on, for example `ETH-USDT` The 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 and to unsubscribe @@ -4621,30 +4621,30 @@ Subscribe to kline updates - Symbol to subscribe + Symbol to subscribe, for example `ETH-USDT` Interval of the klines 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 and to unsubscribe - + - + Subscribe to book ticker (best ask/bid) updates - - - + Symbol to subscribe, for example `ETH-USDT` + Data handler + Cancellation token for closing this subscription - + - + Subscribe to book ticker (best ask/bid) updates - - - + Symbols to subscribe, for example `ETH-USDT` + Data handler + Cancellation token for closing this subscription @@ -4653,7 +4653,7 @@ - The symbol to subscribe + The symbol to subscribe, for example `ETH-USDT` The amount of levels to receive, either 5 or 50 Data handler Cancellation token for closing this subscription @@ -4665,7 +4665,7 @@ - The symbols to subscribe + The symbols to subscribe, for example `ETH-USDT` The amount of levels to receive, either 5 or 50 Data handler Cancellation token for closing this subscription @@ -4725,7 +4725,7 @@ Subscribe to index price updates - The symbol to subscribe + The symbol to subscribe, for example `USDT-BTC` 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 and to unsubscribe @@ -4735,7 +4735,7 @@ Subscribe to index price updates - The symbols to subscribe + The symbols to subscribe, for example `USDT-BTC` 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 and to unsubscribe @@ -4745,7 +4745,7 @@ Subscribe to mark price updates - The symbol to subscribe + The symbol to subscribe, for example `USDT-BTC` Data handler Cancellation token for closing this subscription @@ -4755,7 +4755,7 @@ Subscribe to mark price updates - The symbols to subscribe + The symbols to subscribe, for example `USDT-BTC` Data handler Cancellation token for closing this subscription @@ -4775,7 +4775,7 @@ Subscribe to margin order updates for an asset - Asset + Asset, for example `ETH-USDT` Data handler for order placement updates Data handler for order updates Data handler for order done updates