1
0
mirror of https://github.com/JKorf/CryptoExchange.Net.git synced 2026-10-14 23:21:48 +00:00
This commit is contained in:
Jkorf
2026-09-04 13:33:50 +02:00
parent 67bf7d08cb
commit a545efbb45
72 changed files with 208 additions and 499 deletions
@@ -8,7 +8,7 @@ using System.Threading.Tasks;
namespace CryptoExchange.Net.SharedApis namespace CryptoExchange.Net.SharedApis
{ {
/// <summary> /// <summary>
/// Endpoint definition for retrieving all assets supported on an exchange. /// Operation for retrieving all assets supported on an exchange.
/// </summary> /// </summary>
public interface IGetAllAssets : ISharedApiCapability public interface IGetAllAssets : ISharedApiCapability
{ {
@@ -28,16 +28,11 @@ namespace CryptoExchange.Net.SharedApis
} }
/// <summary> /// <summary>
/// Endpoint definition for retrieving all assets supported on an exchange. /// Operation for retrieving all assets supported on an exchange via the REST API.
/// </summary> /// </summary>
public interface IGetAllAssetsRest : IGetAllAssets, ISharedRest public interface IGetAllAssetsRest : IGetAllAssets, ISharedRest
{ {
/// <inheritdoc />
/// <summary>
/// Get info on all assets the exchange supports, see <see cref="GetAllAssetsOptions"/> for request options and exchange specific required/optional parameters. <br />
/// </summary>
/// <param name="request">Request info</param>
/// <param name="ct">Cancellation token</param>
new Task<HttpResult<SharedAsset[]>> GetAllAssetsAsync(GetAssetsRequest request, CancellationToken ct = default); new Task<HttpResult<SharedAsset[]>> GetAllAssetsAsync(GetAssetsRequest request, CancellationToken ct = default);
} }
} }
@@ -8,7 +8,7 @@ using System.Threading.Tasks;
namespace CryptoExchange.Net.SharedApis namespace CryptoExchange.Net.SharedApis
{ {
/// <summary> /// <summary>
/// Endpoint definition for retrieving an asset on an exchange. /// Operation for retrieving asset info from an exchange.
/// </summary> /// </summary>
public interface IGetAsset : ISharedApiCapability public interface IGetAsset : ISharedApiCapability
{ {
@@ -28,15 +28,11 @@ namespace CryptoExchange.Net.SharedApis
} }
/// <summary> /// <summary>
/// Endpoint definition for retrieving an asset on an exchange. /// Operation for retrieving asset info from an exchange via the REST API.
/// </summary> /// </summary>
public interface IGetAssetRest : IGetAsset, ISharedRest public interface IGetAssetRest : IGetAsset, ISharedRest
{ {
/// <summary> /// <inheritdoc />
/// Get info on a specific asset, see <see cref="GetAssetOptions"/> for request options and exchange specific required/optional parameters. <br />
/// </summary>
/// <param name="request">Request info</param>
/// <param name="ct">Cancellation token</param>
new Task<HttpResult<SharedAsset>> GetAssetAsync(GetAssetRequest request, CancellationToken ct = default); new Task<HttpResult<SharedAsset>> GetAssetAsync(GetAssetRequest request, CancellationToken ct = default);
} }
} }
@@ -8,7 +8,7 @@ using System.Threading.Tasks;
namespace CryptoExchange.Net.SharedApis namespace CryptoExchange.Net.SharedApis
{ {
/// <summary> /// <summary>
/// Endpoint definition for retrieving user asset balances on an exchange. /// Operation for retrieving user asset balances from an exchange.
/// </summary> /// </summary>
public interface IGetBalances : ISharedApiCapability public interface IGetBalances : ISharedApiCapability
{ {
@@ -29,16 +29,11 @@ namespace CryptoExchange.Net.SharedApis
} }
/// <summary> /// <summary>
/// Endpoint definition for retrieving user asset balances on an exchange. /// Operation for retrieving user asset balances from an exchange via the REST API.
/// </summary> /// </summary>
public interface IGetBalancesRest : IGetBalances, ISharedRest public interface IGetBalancesRest : IGetBalances, ISharedRest
{ {
/// <summary> /// <inheritdoc />
/// Get balances for the user, see <see cref="GetBalancesOptions"/> for request options and exchange specific required/optional parameters. <br />
/// </summary>
/// <param name="request">Request info</param>
/// <param name="ct">Cancellation token</param>
/// <returns></returns>
new Task<HttpResult<SharedBalance[]>> GetBalancesAsync(GetBalancesRequest request, CancellationToken ct = default); new Task<HttpResult<SharedBalance[]>> GetBalancesAsync(GetBalancesRequest request, CancellationToken ct = default);
} }
} }
@@ -7,7 +7,7 @@ using System.Threading.Tasks;
namespace CryptoExchange.Net.SharedApis namespace CryptoExchange.Net.SharedApis
{ {
/// <summary> /// <summary>
/// Client for subscribing to user balance updates /// Operation for subscribing to user balance updates
/// </summary> /// </summary>
public interface ISubscribeBalancesSocket : ISharedSubscription public interface ISubscribeBalancesSocket : ISharedSubscription
{ {
@@ -8,7 +8,7 @@ using System.Threading.Tasks;
namespace CryptoExchange.Net.SharedApis namespace CryptoExchange.Net.SharedApis
{ {
/// <summary> /// <summary>
/// Endpoint definition for retrieving user deposit addresses on an exchange. /// Operation for retrieving user deposit addresses for an exchange.
/// </summary> /// </summary>
public interface IGetDepositAddresses : ISharedApiCapability public interface IGetDepositAddresses : ISharedApiCapability
{ {
@@ -29,16 +29,11 @@ namespace CryptoExchange.Net.SharedApis
} }
/// <summary> /// <summary>
/// Endpoint definition for retrieving user deposit addresses on an exchange. /// Operation for retrieving user deposit addresses for an exchange via the REST API.
/// </summary> /// </summary>
public interface IGetDepositAddressesRest : IGetDepositAddresses, ISharedRest public interface IGetDepositAddressesRest : IGetDepositAddresses, ISharedRest
{ {
/// <summary> /// <inheritdoc />
/// Get deposit addresses for an asset, see <see cref="GetDepositAddressesOptions"/> for request options and exchange specific required/optional parameters. <br />
/// </summary>
/// <param name="request">Request info</param>
/// <param name="ct">Cancellation token</param>
/// <returns></returns>
new Task<HttpResult<SharedDepositAddress[]>> GetDepositAddressesAsync(GetDepositAddressesRequest request, CancellationToken ct = default); new Task<HttpResult<SharedDepositAddress[]>> GetDepositAddressesAsync(GetDepositAddressesRequest request, CancellationToken ct = default);
} }
} }
@@ -8,7 +8,7 @@ using System.Threading.Tasks;
namespace CryptoExchange.Net.SharedApis namespace CryptoExchange.Net.SharedApis
{ {
/// <summary> /// <summary>
/// Endpoint definition for retrieving user deposit history on an exchange. /// Operation for retrieving user deposit history from an exchange.
/// </summary> /// </summary>
public interface IGetDepositHistory : ISharedApiCapability public interface IGetDepositHistory : ISharedApiCapability
{ {
@@ -31,18 +31,11 @@ namespace CryptoExchange.Net.SharedApis
} }
/// <summary> /// <summary>
/// Endpoint definition for retrieving user deposit history on an exchange. /// Operation for retrieving user deposit history from an exchange via the REST API.
/// </summary> /// </summary>
public interface IGetDepositHistoryRest : IGetDepositHistory, ISharedRest public interface IGetDepositHistoryRest : IGetDepositHistory, ISharedRest
{ {
/// <summary> /// <inheritdoc />
/// Get deposit records, see <see cref="GetDepositHistoryOptions"/> for request options and exchange specific required/optional parameters. <br />
/// The result is paginated, if there are more results to be retrieved, the <see cref="HttpResult{T}.NextPageRequest"/> property of the result will contain the pagination request to be used for the next request to continue pagination.
/// </summary>
/// <param name="request">Request info</param>
/// <param name="nextPageToken">The pagination request from the previous request result <see cref="HttpResult{T}.NextPageRequest"/> property to continue pagination</param>
/// <param name="ct">Cancellation token</param>
/// <returns></returns>
new Task<HttpResult<SharedDeposit[]>> GetDepositHistoryAsync(GetDepositsRequest request, PageRequest? nextPageToken = null, CancellationToken ct = default); new Task<HttpResult<SharedDeposit[]>> GetDepositHistoryAsync(GetDepositsRequest request, PageRequest? nextPageToken = null, CancellationToken ct = default);
} }
} }
@@ -8,7 +8,7 @@ using System.Threading.Tasks;
namespace CryptoExchange.Net.SharedApis namespace CryptoExchange.Net.SharedApis
{ {
/// <summary> /// <summary>
/// Endpoint definition for retrieving user trading fees on an exchange. /// Operation for retrieving user trading fees from an exchange.
/// </summary> /// </summary>
public interface IGetFees : ISharedApiCapability public interface IGetFees : ISharedApiCapability
{ {
@@ -28,15 +28,11 @@ namespace CryptoExchange.Net.SharedApis
} }
/// <summary> /// <summary>
/// Endpoint definition for retrieving user trading fees on an exchange. /// Operation for retrieving user trading fees from an exchange via the REST API.
/// </summary> /// </summary>
public interface IGetFeesRest : IGetFees, ISharedRest public interface IGetFeesRest : IGetFees, ISharedRest
{ {
/// <summary> /// <inheritdoc />
/// Get trading fees for a symbol, see <see cref="GetFeeOptions"/> for request options and exchange specific required/optional parameters. <br />
/// </summary>
/// <param name="request">Request info</param>
/// <param name="ct">Cancellation token</param>
new Task<HttpResult<SharedFee>> GetFeesAsync(GetFeeRequest request, CancellationToken ct = default); new Task<HttpResult<SharedFee>> GetFeesAsync(GetFeeRequest request, CancellationToken ct = default);
} }
} }
@@ -8,7 +8,7 @@ using System.Threading.Tasks;
namespace CryptoExchange.Net.SharedApis namespace CryptoExchange.Net.SharedApis
{ {
/// <summary> /// <summary>
/// Endpoint definition for retrieving funding rate history for a symbol on an exchange. /// Operation for retrieving funding rate history for a symbol on an exchange.
/// </summary> /// </summary>
public interface IGetFundingRateHistory : ISharedApiCapability public interface IGetFundingRateHistory : ISharedApiCapability
{ {
@@ -29,17 +29,11 @@ namespace CryptoExchange.Net.SharedApis
} }
/// <summary> /// <summary>
/// Endpoint definition for retrieving funding rate history for a symbol on an exchange. /// Operation for retrieving funding rate history for a symbol on an exchange via the REST API.
/// </summary> /// </summary>
public interface IGetFundingRateHistoryRest : IGetFundingRateHistory, ISharedRest public interface IGetFundingRateHistoryRest : IGetFundingRateHistory, ISharedRest
{ {
/// <summary> /// <inheritdoc />
/// Get funding rate records, see <see cref="GetFundingRateHistoryOptions"/> for request options and exchange specific required/optional parameters. <br />
/// The result is paginated, if there are more results to be retrieved, the <see cref="HttpResult{T}.NextPageRequest"/> property of the result will contain the pagination request to be used for the next request to continue pagination.
/// </summary>
/// <param name="request">Request info</param>
/// <param name="nextPageToken">The pagination request from the previous request result <see cref="HttpResult{T}.NextPageRequest"/> property to continue pagination</param>
/// <param name="ct">Cancellation token</param>
new Task<HttpResult<SharedFundingRate[]>> GetFundingRateHistoryAsync(GetFundingRateHistoryRequest request, PageRequest? nextPageToken = null, CancellationToken ct = default); new Task<HttpResult<SharedFundingRate[]>> GetFundingRateHistoryAsync(GetFundingRateHistoryRequest request, PageRequest? nextPageToken = null, CancellationToken ct = default);
} }
} }
@@ -4,7 +4,7 @@ using System.Collections.Generic;
namespace CryptoExchange.Net.SharedApis namespace CryptoExchange.Net.SharedApis
{ {
/// <summary> /// <summary>
/// A shared/common client interface /// Shared API
/// </summary> /// </summary>
public interface ISharedApi public interface ISharedApi
{ {
@@ -5,7 +5,7 @@ using System.Text;
namespace CryptoExchange.Net.SharedApis namespace CryptoExchange.Net.SharedApis
{ {
/// <summary> /// <summary>
/// Interface for a shared API capability /// Shared API capability
/// </summary> /// </summary>
public interface ISharedApiCapability : ISharedApi public interface ISharedApiCapability : ISharedApi
{ {
@@ -5,7 +5,7 @@ using System.Text;
namespace CryptoExchange.Net.SharedApis namespace CryptoExchange.Net.SharedApis
{ {
/// <summary> /// <summary>
/// Interface for a shared API endpoint /// Shared REST API capabitlity
/// </summary> /// </summary>
public interface ISharedRest : ISharedApiCapability public interface ISharedRest : ISharedApiCapability
{ {
@@ -5,7 +5,7 @@ using System.Text;
namespace CryptoExchange.Net.SharedApis namespace CryptoExchange.Net.SharedApis
{ {
/// <summary> /// <summary>
/// Interface for a shared socket operation /// Shared WebSocket API capabitlity
/// </summary> /// </summary>
public interface ISharedSocket : ISharedApiCapability public interface ISharedSocket : ISharedApiCapability
{ {
@@ -5,7 +5,7 @@ using System.Text;
namespace CryptoExchange.Net.SharedApis namespace CryptoExchange.Net.SharedApis
{ {
/// <summary> /// <summary>
/// Identifies a fine-grained Shared API subscription capability. /// Shared WebSocket API subscription capabitlity
/// </summary> /// </summary>
public interface ISharedSubscription : ISharedSocket public interface ISharedSubscription : ISharedSocket
{ {
@@ -8,7 +8,7 @@ using System.Threading.Tasks;
namespace CryptoExchange.Net.SharedApis namespace CryptoExchange.Net.SharedApis
{ {
/// <summary> /// <summary>
/// Endpoint definition for retrieving index price kline/candlestick data from an exchange /// Operation for retrieving index price kline/candlestick data from an exchange
/// </summary> /// </summary>
public interface IGetIndexPriceKlines : ISharedApiCapability public interface IGetIndexPriceKlines : ISharedApiCapability
{ {
@@ -29,17 +29,11 @@ namespace CryptoExchange.Net.SharedApis
} }
/// <summary> /// <summary>
/// Endpoint definition for retrieving index price kline/candlestick data from an exchange /// Operation for retrieving index price kline/candlestick data from an exchange via the REST API.
/// </summary> /// </summary>
public interface IGetIndexPriceKlinesRest : IGetIndexPriceKlines, ISharedRest public interface IGetIndexPriceKlinesRest : IGetIndexPriceKlines, ISharedRest
{ {
/// <summary> /// <inheritdoc />
/// Get index price kline/candlestick data, see <see cref="GetIndexPriceKlinesOptions"/> for request options and exchange specific required/optional parameters. <br />
/// The result is paginated, if there are more results to be retrieved, the <see cref="HttpResult{T}.NextPageRequest"/> property of the result will contain the pagination request to be used for the next request to continue pagination.
/// </summary>
/// <param name="request">Request info</param>
/// <param name="nextPageToken">The pagination request from the previous request result <see cref="HttpResult{T}.NextPageRequest"/> property to continue pagination</param>
/// <param name="ct">Cancellation token</param>
new Task<HttpResult<SharedFuturesKline[]>> GetIndexPriceKlinesAsync(GetKlinesRequest request, PageRequest? nextPageToken = null, CancellationToken ct = default); new Task<HttpResult<SharedFuturesKline[]>> GetIndexPriceKlinesAsync(GetKlinesRequest request, PageRequest? nextPageToken = null, CancellationToken ct = default);
} }
} }
@@ -8,7 +8,7 @@ using System.Threading.Tasks;
namespace CryptoExchange.Net.SharedApis namespace CryptoExchange.Net.SharedApis
{ {
/// <summary> /// <summary>
/// Endpoint definition for retrieving mark price kline/candlestick data from an exchange. /// Operation for retrieving mark price kline/candlestick data from an exchange.
/// </summary> /// </summary>
public interface IGetMarkPriceKlines : ISharedApiCapability public interface IGetMarkPriceKlines : ISharedApiCapability
{ {
@@ -29,17 +29,11 @@ namespace CryptoExchange.Net.SharedApis
} }
/// <summary> /// <summary>
/// Endpoint definition for retrieving mark price kline/candlestick data from an exchange. /// Operation for retrieving mark price kline/candlestick data from an exchange via the REST API.
/// </summary> /// </summary>
public interface IGetMarkPriceKlinesRest : IGetMarkPriceKlines, ISharedRest public interface IGetMarkPriceKlinesRest : IGetMarkPriceKlines, ISharedRest
{ {
/// <summary> /// <inheritdoc />
/// Get mark price kline/candlestick data, see <see cref="GetMarkPriceKlinesOptions"/> for request options and exchange specific required/optional parameters. <br />
/// The result is paginated, if there are more results to be retrieved, the <see cref="HttpResult{T}.NextPageRequest"/> property of the result will contain the pagination request to be used for the next request to continue pagination.
/// </summary>
/// <param name="request">Request info</param>
/// <param name="nextPageToken">The pagination request from the previous request result <see cref="HttpResult{T}.NextPageRequest"/> property to continue pagination</param>
/// <param name="ct">Cancellation token</param>
new Task<HttpResult<SharedFuturesKline[]>> GetMarkPriceKlinesAsync(GetKlinesRequest request, PageRequest? nextPageToken = null, CancellationToken ct = default); new Task<HttpResult<SharedFuturesKline[]>> GetMarkPriceKlinesAsync(GetKlinesRequest request, PageRequest? nextPageToken = null, CancellationToken ct = default);
} }
} }
@@ -8,7 +8,7 @@ using System.Threading.Tasks;
namespace CryptoExchange.Net.SharedApis namespace CryptoExchange.Net.SharedApis
{ {
/// <summary> /// <summary>
/// Request definition for getting kline/candlestick data from an exchange. /// Operation for getting kline/candlestick data from an exchange.
/// </summary> /// </summary>
public interface IGetKlines : ISharedApiCapability public interface IGetKlines : ISharedApiCapability
{ {
@@ -31,18 +31,11 @@ namespace CryptoExchange.Net.SharedApis
} }
/// <summary> /// <summary>
/// Request definition for getting kline/candlestick data from an exchange. /// Operation for getting kline/candlestick data from an exchange via the REST API.
/// </summary> /// </summary>
public interface IGetKlinesRest : IGetKlines, ISharedRest public interface IGetKlinesRest : IGetKlines, ISharedRest
{ {
/// <summary> /// <inheritdoc />
/// Get kline/candlestick data, see <see cref="GetKlinesOptions"/> for request options and exchange specific required/optional parameters. <br />
/// The result is paginated, if there are more results to be retrieved, the <see cref="HttpResult{T}.NextPageRequest"/> property of the result will contain the pagination request to be used for the next request to continue pagination.
/// </summary>
/// <param name="request">Request info</param>
/// <param name="nextPageToken">The pagination request from the previous request result <see cref="HttpResult{T}.NextPageRequest"/> property to continue pagination</param>
/// <param name="ct">Cancellation token</param>
/// <returns></returns>
new Task<HttpResult<SharedKline[]>> GetKlinesAsync(GetKlinesRequest request, PageRequest? nextPageToken = null, CancellationToken ct = default); new Task<HttpResult<SharedKline[]>> GetKlinesAsync(GetKlinesRequest request, PageRequest? nextPageToken = null, CancellationToken ct = default);
} }
} }
@@ -7,7 +7,7 @@ using CryptoExchange.Net.Objects;
namespace CryptoExchange.Net.SharedApis namespace CryptoExchange.Net.SharedApis
{ {
/// <summary> /// <summary>
/// Client for subscribing to kline/candlestick updates for a symbol /// Operation for subscribing to kline/candlestick updates for a symbol
/// </summary> /// </summary>
public interface ISubscribeKlinesSocket : ISharedSubscription public interface ISubscribeKlinesSocket : ISharedSubscription
{ {
@@ -8,7 +8,7 @@ using System.Threading.Tasks;
namespace CryptoExchange.Net.SharedApis namespace CryptoExchange.Net.SharedApis
{ {
/// <summary> /// <summary>
/// Endpoint definition for retrieving leverage information for a symbol on an exchange. /// Operation for retrieving leverage information for a symbol on an exchange.
/// </summary> /// </summary>
public interface IGetLeverage : ISharedApiCapability public interface IGetLeverage : ISharedApiCapability
{ {
@@ -27,15 +27,11 @@ namespace CryptoExchange.Net.SharedApis
} }
/// <summary> /// <summary>
/// Endpoint definition for retrieving leverage information for a symbol on an exchange. /// Operation for retrieving leverage information for a symbol on an exchange via the REST API.
/// </summary> /// </summary>
public interface IGetLeverageRest : IGetLeverage, ISharedRest public interface IGetLeverageRest : IGetLeverage, ISharedRest
{ {
/// <summary> /// <inheritdoc />
/// Get the current leverage setting for a symbol, see <see cref="GetLeverageOptions"/> for request options and exchange specific required/optional parameters. <br />
/// </summary>
/// <param name="request">Request info</param>
/// <param name="ct">Cancellation token</param>
new Task<HttpResult<SharedLeverage>> GetLeverageAsync(GetLeverageRequest request, CancellationToken ct = default); new Task<HttpResult<SharedLeverage>> GetLeverageAsync(GetLeverageRequest request, CancellationToken ct = default);
} }
} }
@@ -8,7 +8,7 @@ using System.Threading.Tasks;
namespace CryptoExchange.Net.SharedApis namespace CryptoExchange.Net.SharedApis
{ {
/// <summary> /// <summary>
/// Endpoint definition for setting leverage on an exchange. /// Operation for setting leverage on an exchange.
/// </summary> /// </summary>
public interface ISetLeverage : ISharedApiCapability public interface ISetLeverage : ISharedApiCapability
{ {
@@ -32,15 +32,11 @@ namespace CryptoExchange.Net.SharedApis
} }
/// <summary> /// <summary>
/// Endpoint definition for setting leverage on an exchange. /// Operation for setting leverage on an exchange via the REST API.
/// </summary> /// </summary>
public interface ISetLeverageRest : ISetLeverage, ISharedRest public interface ISetLeverageRest : ISetLeverage, ISharedRest
{ {
/// <summary> /// <inheritdoc />
/// Set the leverage for a symbol, see <see cref="SetLeverageOptions"/> for request options and exchange specific required/optional parameters. <br />
/// </summary>
/// <param name="request">Request info</param>
/// <param name="ct">Cancellation token</param>
new Task<HttpResult<SharedLeverage>> SetLeverageAsync(SetLeverageRequest request, CancellationToken ct = default); new Task<HttpResult<SharedLeverage>> SetLeverageAsync(SetLeverageRequest request, CancellationToken ct = default);
} }
} }
@@ -8,7 +8,7 @@ using System.Threading.Tasks;
namespace CryptoExchange.Net.SharedApis namespace CryptoExchange.Net.SharedApis
{ {
/// <summary> /// <summary>
/// Endpoint definition for retrieving open interest data from an exchange /// Operation for retrieving open interest data from an exchange.
/// </summary> /// </summary>
public interface IGetOpenInterest : ISharedApiCapability public interface IGetOpenInterest : ISharedApiCapability
{ {
@@ -27,15 +27,11 @@ namespace CryptoExchange.Net.SharedApis
} }
/// <summary> /// <summary>
/// Endpoint definition for retrieving open interest data from an exchange /// Operation for retrieving open interest data from an exchange via the REST API.
/// </summary> /// </summary>
public interface IGetOpenInterestRest : IGetOpenInterest, ISharedRest public interface IGetOpenInterestRest : IGetOpenInterest, ISharedRest
{ {
/// <summary> /// <inheritdoc />
/// Get the open interest for a symbol, see <see cref="GetOpenInterestOptions"/> for request options and exchange specific required/optional parameters. <br />
/// </summary>
/// <param name="request">Request info</param>
/// <param name="ct">Cancellation token</param>
new Task<HttpResult<SharedOpenInterest>> GetOpenInterestAsync(GetOpenInterestRequest request, CancellationToken ct = default); new Task<HttpResult<SharedOpenInterest>> GetOpenInterestAsync(GetOpenInterestRequest request, CancellationToken ct = default);
} }
} }
@@ -8,7 +8,7 @@ using System.Threading.Tasks;
namespace CryptoExchange.Net.SharedApis namespace CryptoExchange.Net.SharedApis
{ {
/// <summary> /// <summary>
/// Request definition for retrieving the best bid/ask prices for a symbol on an exchange. /// Operation for retrieving the best bid/ask prices for a symbol on an exchange.
/// </summary> /// </summary>
public interface IGetBookTicker : ISharedApiCapability public interface IGetBookTicker : ISharedApiCapability
{ {
@@ -29,16 +29,11 @@ namespace CryptoExchange.Net.SharedApis
} }
/// <summary> /// <summary>
/// Request definition for retrieving the best bid/ask prices for a symbol on an exchange. /// Operation for retrieving the best bid/ask prices for a symbol on an exchange via the REST API.
/// </summary> /// </summary>
public interface IGetBookTickerRest : IGetBookTicker, ISharedRest public interface IGetBookTickerRest : IGetBookTicker, ISharedRest
{ {
/// <summary> /// <inheritdoc />
/// Get the best ask/bid info for a symbol, see <see cref="GetBookTickerOptions"/> for request options and exchange specific required/optional parameters. <br />
/// </summary>
/// <param name="request">Request info</param>
/// <param name="ct">Cancellation token</param>
/// <returns></returns>
new Task<HttpResult<SharedBookTicker>> GetBookTickerAsync(GetBookTickerRequest request, CancellationToken ct = default); new Task<HttpResult<SharedBookTicker>> GetBookTickerAsync(GetBookTickerRequest request, CancellationToken ct = default);
} }
} }
@@ -8,7 +8,7 @@ using System.Threading.Tasks;
namespace CryptoExchange.Net.SharedApis namespace CryptoExchange.Net.SharedApis
{ {
/// <summary> /// <summary>
/// Request definition for retrieving an order book snapshot for a symbol on an exchange. /// Operation for retrieving an order book snapshot for a symbol on an exchange.
/// </summary> /// </summary>
public interface IGetOrderBook : ISharedApiCapability public interface IGetOrderBook : ISharedApiCapability
{ {
@@ -29,16 +29,11 @@ namespace CryptoExchange.Net.SharedApis
} }
/// <summary> /// <summary>
/// Request definition for retrieving an order book snapshot for a symbol on an exchange. /// Operation for retrieving an order book snapshot for a symbol on an exchange via the REST API.
/// </summary> /// </summary>
public interface IGetOrderBookRest : IGetOrderBook, ISharedRest public interface IGetOrderBookRest : IGetOrderBook, ISharedRest
{ {
/// <summary> /// <inheritdoc />
/// Get the order book for a symbol, see <see cref="GetOrderBookOptions"/> for request options and exchange specific required/optional parameters. <br />
/// </summary>
/// <param name="request">Request info</param>
/// <param name="ct">Cancellation token</param>
/// <returns></returns>
new Task<HttpResult<SharedOrderBook>> GetOrderBookAsync(GetOrderBookRequest request, CancellationToken ct = default); new Task<HttpResult<SharedOrderBook>> GetOrderBookAsync(GetOrderBookRequest request, CancellationToken ct = default);
} }
} }
@@ -7,7 +7,7 @@ using System.Threading.Tasks;
namespace CryptoExchange.Net.SharedApis namespace CryptoExchange.Net.SharedApis
{ {
/// <summary> /// <summary>
/// Client for subscribing to incremental order book updates for a symbol /// Operation for subscribing to incremental order book updates for a symbol
/// </summary> /// </summary>
public interface ISubscribeIncrementalOrderBookSocket : ISharedSubscription public interface ISubscribeIncrementalOrderBookSocket : ISharedSubscription
{ {
@@ -7,7 +7,7 @@ using System.Threading.Tasks;
namespace CryptoExchange.Net.SharedApis namespace CryptoExchange.Net.SharedApis
{ {
/// <summary> /// <summary>
/// Client for subscribing to order book snapshot updates for a symbol /// Operation for subscribing to order book snapshot updates for a symbol
/// </summary> /// </summary>
public interface ISubscribeOrderBookSocket : ISharedSubscription public interface ISubscribeOrderBookSocket : ISharedSubscription
{ {
@@ -8,7 +8,7 @@ using System.Threading.Tasks;
namespace CryptoExchange.Net.SharedApis namespace CryptoExchange.Net.SharedApis
{ {
/// <summary> /// <summary>
/// Endpoint definition for canceling a futures order on an exchange. /// Operation for canceling an open futures order on an exchange.
/// </summary> /// </summary>
public interface ICancelFuturesOrder : ISharedApiCapability public interface ICancelFuturesOrder : ISharedApiCapability
{ {
@@ -27,29 +27,21 @@ namespace CryptoExchange.Net.SharedApis
} }
/// <summary> /// <summary>
/// Endpoint definition for canceling a futures order on an exchange. /// Operation for canceling an open futures order on an exchange via the REST API.
/// </summary> /// </summary>
public interface ICancelFuturesOrderRest : ICancelFuturesOrder, ISharedRest public interface ICancelFuturesOrderRest : ICancelFuturesOrder, ISharedRest
{ {
/// <summary> /// <inheritdoc />
/// Cancel a futures order, see <see cref="CancelFuturesOrderOptions"/> for request options and exchange specific required/optional parameters. <br />
/// </summary>
/// <param name="request">Request info</param>
/// <param name="ct">Cancellation token</param>
new Task<HttpResult<SharedId>> CancelFuturesOrderAsync(CancelOrderRequest request, CancellationToken ct = default); new Task<HttpResult<SharedId>> CancelFuturesOrderAsync(CancelOrderRequest request, CancellationToken ct = default);
} }
/// <summary> /// <summary>
/// Endpoint definition for canceling a futures order on an exchange. /// Operation for canceling an open futures order on an exchange via the WebSocket API.
/// </summary> /// </summary>
public interface ICancelFuturesOrderSocket : ICancelFuturesOrder, ISharedSocket public interface ICancelFuturesOrderSocket : ICancelFuturesOrder, ISharedSocket
{ {
/// <summary> /// <inheritdoc />
/// Cancel a futures order, see <see cref="CancelFuturesOrderOptions"/> for request options and exchange specific required/optional parameters. <br />
/// </summary>
/// <param name="request">Request info</param>
/// <param name="ct">Cancellation token</param>
new Task<QueryResult<SharedId>> CancelFuturesOrderAsync(CancelOrderRequest request, CancellationToken ct = default); new Task<QueryResult<SharedId>> CancelFuturesOrderAsync(CancelOrderRequest request, CancellationToken ct = default);
} }
@@ -8,7 +8,7 @@ using System.Threading.Tasks;
namespace CryptoExchange.Net.SharedApis namespace CryptoExchange.Net.SharedApis
{ {
/// <summary> /// <summary>
/// Endpoint definition for canceling a futures order by client order id on an exchange. /// Operation for canceling an open futures order by its client order id on an exchange.
/// </summary> /// </summary>
public interface ICancelFuturesOrderByClientOrderId : ISharedApiCapability public interface ICancelFuturesOrderByClientOrderId : ISharedApiCapability
{ {
@@ -27,28 +27,20 @@ namespace CryptoExchange.Net.SharedApis
} }
/// <summary> /// <summary>
/// Endpoint definition for canceling a futures order by client order id on an exchange. /// Operation for canceling an open futures order by its client order id on an exchange via the REST API.
/// </summary> /// </summary>
public interface ICancelFuturesOrderByClientOrderIdRest : ICancelFuturesOrderByClientOrderId, ISharedRest public interface ICancelFuturesOrderByClientOrderIdRest : ICancelFuturesOrderByClientOrderId, ISharedRest
{ {
/// <summary> /// <inheritdoc />
/// Cancel a futures order using client order id, see <see cref="CancelFuturesOrderByClientOrderIdOptions"/> for request options and exchange specific required/optional parameters. <br />
/// </summary>
/// <param name="request">Request info</param>
/// <param name="ct">Cancellation token</param>
new Task<HttpResult<SharedId>> CancelFuturesOrderByClientOrderIdAsync(CancelOrderRequest request, CancellationToken ct = default); new Task<HttpResult<SharedId>> CancelFuturesOrderByClientOrderIdAsync(CancelOrderRequest request, CancellationToken ct = default);
} }
/// <summary> /// <summary>
/// Endpoint definition for canceling a futures order by client order id on an exchange. /// Operation for canceling an open futures order by its client order id on an exchange via the WebSocket API.
/// </summary> /// </summary>
public interface ICancelFuturesOrderByClientOrderIdSocket : ICancelFuturesOrderByClientOrderId, ISharedSocket public interface ICancelFuturesOrderByClientOrderIdSocket : ICancelFuturesOrderByClientOrderId, ISharedSocket
{ {
/// <summary> /// <inheritdoc />
/// Cancel a futures order using client order id, see <see cref="CancelFuturesOrderByClientOrderIdOptions"/> for request options and exchange specific required/optional parameters. <br />
/// </summary>
/// <param name="request">Request info</param>
/// <param name="ct">Cancellation token</param>
new Task<QueryResult<SharedId>> CancelFuturesOrderByClientOrderIdAsync(CancelOrderRequest request, CancellationToken ct = default); new Task<QueryResult<SharedId>> CancelFuturesOrderByClientOrderIdAsync(CancelOrderRequest request, CancellationToken ct = default);
} }
} }
@@ -8,7 +8,7 @@ using System.Threading.Tasks;
namespace CryptoExchange.Net.SharedApis namespace CryptoExchange.Net.SharedApis
{ {
/// <summary> /// <summary>
/// Endpoint definition for retrieving closed futures orders on an exchange. /// Operation for retrieving closed futures orders on an exchange.
/// </summary> /// </summary>
public interface IGetClosedFuturesOrders : ISharedApiCapability public interface IGetClosedFuturesOrders : ISharedApiCapability
{ {
@@ -29,17 +29,11 @@ namespace CryptoExchange.Net.SharedApis
} }
/// <summary> /// <summary>
/// Endpoint definition for retrieving closed futures orders on an exchange. /// Operation for retrieving closed futures orders on an exchange via the REST API.
/// </summary> /// </summary>
public interface IGetClosedFuturesOrdersRest : IGetClosedFuturesOrders, ISharedRest public interface IGetClosedFuturesOrdersRest : IGetClosedFuturesOrders, ISharedRest
{ {
/// <summary> /// <inheritdoc />
/// Get info on closed futures orders, see <see cref="GetClosedFuturesOrdersOptions"/> for request options and exchange specific required/optional parameters. <br />
/// The result is paginated, if there are more results to be retrieved, the <see cref="HttpResult{T}.NextPageRequest"/> property of the result will contain the pagination request to be used for the next request to continue pagination.
/// </summary>
/// <param name="request">Request info</param>
/// <param name="nextPageToken">The pagination request from the previous request result <see cref="HttpResult{T}.NextPageRequest"/> property to continue pagination</param>
/// <param name="ct">Cancellation token</param>
new Task<HttpResult<SharedFuturesOrder[]>> GetClosedFuturesOrdersAsync(GetClosedOrdersRequest request, PageRequest? nextPageToken = null, CancellationToken ct = default); new Task<HttpResult<SharedFuturesOrder[]>> GetClosedFuturesOrdersAsync(GetClosedOrdersRequest request, PageRequest? nextPageToken = null, CancellationToken ct = default);
} }
} }
@@ -8,7 +8,7 @@ using System.Threading.Tasks;
namespace CryptoExchange.Net.SharedApis namespace CryptoExchange.Net.SharedApis
{ {
/// <summary> /// <summary>
/// Endpoint definition for retrieving a futures order on an exchange. /// Operation for retrieving a futures order from an exchange.
/// </summary> /// </summary>
public interface IGetFuturesOrder : ISharedApiCapability public interface IGetFuturesOrder : ISharedApiCapability
{ {
@@ -27,15 +27,11 @@ namespace CryptoExchange.Net.SharedApis
} }
/// <summary> /// <summary>
/// Endpoint definition for retrieving a futures order on an exchange. /// Operation for retrieving a futures order from an exchange via the REST API.
/// </summary> /// </summary>
public interface IGetFuturesOrderRest : IGetFuturesOrder, ISharedRest public interface IGetFuturesOrderRest : IGetFuturesOrder, ISharedRest
{ {
/// <summary> /// <inheritdoc />
/// Get info on a specific futures order, see <see cref="GetFuturesOrderOptions"/> for request options and exchange specific required/optional parameters. <br />
/// </summary>
/// <param name="request">Request info</param>
/// <param name="ct">Cancellation token</param>
new Task<HttpResult<SharedFuturesOrder>> GetFuturesOrderAsync(GetOrderRequest request, CancellationToken ct = default); new Task<HttpResult<SharedFuturesOrder>> GetFuturesOrderAsync(GetOrderRequest request, CancellationToken ct = default);
} }
} }
@@ -32,11 +32,7 @@ namespace CryptoExchange.Net.SharedApis
/// </summary> /// </summary>
public interface IGetFuturesOrderByClientOrderIdRest : IGetFuturesOrderByClientOrderId, ISharedRest public interface IGetFuturesOrderByClientOrderIdRest : IGetFuturesOrderByClientOrderId, ISharedRest
{ {
/// <summary> /// <inheritdoc />
/// Get info on a specific futures order using a client order id, see <see cref="GetFuturesOrderByClientOrderIdOptions"/> for request options and exchange specific required/optional parameters. <br />
/// </summary>
/// <param name="request">Request info</param>
/// <param name="ct">Cancellation token</param>
new Task<HttpResult<SharedFuturesOrder>> GetFuturesOrderByClientOrderIdAsync(GetOrderRequest request, CancellationToken ct = default); new Task<HttpResult<SharedFuturesOrder>> GetFuturesOrderByClientOrderIdAsync(GetOrderRequest request, CancellationToken ct = default);
} }
} }
@@ -8,7 +8,7 @@ using System.Threading.Tasks;
namespace CryptoExchange.Net.SharedApis namespace CryptoExchange.Net.SharedApis
{ {
/// <summary> /// <summary>
/// Endpoint definition for retrieving open futures orders on an exchange. /// Operation for retrieving open futures orders from an exchange.
/// </summary> /// </summary>
public interface IGetOpenFuturesOrders : ISharedApiCapability public interface IGetOpenFuturesOrders : ISharedApiCapability
{ {
@@ -27,15 +27,11 @@ namespace CryptoExchange.Net.SharedApis
} }
/// <summary> /// <summary>
/// Endpoint definition for retrieving open futures orders on an exchange. /// Operation for retrieving open futures orders from an exchange via the REST API.
/// </summary> /// </summary>
public interface IGetOpenFuturesOrdersRest : IGetOpenFuturesOrders, ISharedRest public interface IGetOpenFuturesOrdersRest : IGetOpenFuturesOrders, ISharedRest
{ {
/// <summary> /// <inheritdoc />
/// Get info on a open futures orders, see <see cref="GetOpenFuturesOrdersOptions"/> for request options and exchange specific required/optional parameters. <br />
/// </summary>
/// <param name="request">Request info</param>
/// <param name="ct">Cancellation token</param>
new Task<HttpResult<SharedFuturesOrder[]>> GetOpenFuturesOrdersAsync(GetOpenOrdersRequest request, CancellationToken ct = default); new Task<HttpResult<SharedFuturesOrder[]>> GetOpenFuturesOrdersAsync(GetOpenOrdersRequest request, CancellationToken ct = default);
} }
} }
@@ -8,7 +8,7 @@ using System.Threading.Tasks;
namespace CryptoExchange.Net.SharedApis namespace CryptoExchange.Net.SharedApis
{ {
/// <summary> /// <summary>
/// Endpoint definition for placing a futures order on an exchange. /// Operation for placing a futures order on an exchange.
/// </summary> /// </summary>
public interface IPlaceFuturesOrder : ISharedApiCapability public interface IPlaceFuturesOrder : ISharedApiCapability
{ {
@@ -55,28 +55,20 @@ namespace CryptoExchange.Net.SharedApis
} }
/// <summary> /// <summary>
/// Endpoint definition for placing a futures order on an exchange. /// Operation for placing a futures order on an exchange via the REST API.
/// </summary> /// </summary>
public interface IPlaceFuturesOrderRest : IPlaceFuturesOrder, ISharedRest public interface IPlaceFuturesOrderRest : IPlaceFuturesOrder, ISharedRest
{ {
/// <summary> /// <inheritdoc />
/// Place a new futures order, see <see cref="PlaceFuturesOrderOptions"/> for request options and exchange specific required/optional parameters. <br />
/// </summary>
/// <param name="request">Request info</param>
/// <param name="ct">Cancellation token</param>
new Task<HttpResult<SharedId>> PlaceFuturesOrderAsync(PlaceFuturesOrderRequest request, CancellationToken ct = default); new Task<HttpResult<SharedId>> PlaceFuturesOrderAsync(PlaceFuturesOrderRequest request, CancellationToken ct = default);
} }
/// <summary> /// <summary>
/// Endpoint definition for placing a futures order on an exchange. /// Operation for placing a futures order on an exchange via the WebSocket API.
/// </summary> /// </summary>
public interface IPlaceFuturesOrderSocket : IPlaceFuturesOrder, ISharedSocket public interface IPlaceFuturesOrderSocket : IPlaceFuturesOrder, ISharedSocket
{ {
/// <summary> /// <inheritdoc />
/// Place a new futures order, see <see cref="PlaceFuturesOrderOptions"/> for request options and exchange specific required/optional parameters. <br />
/// </summary>
/// <param name="request">Request info</param>
/// <param name="ct">Cancellation token</param>
new Task<QueryResult<SharedId>> PlaceFuturesOrderAsync(PlaceFuturesOrderRequest request, CancellationToken ct = default); new Task<QueryResult<SharedId>> PlaceFuturesOrderAsync(PlaceFuturesOrderRequest request, CancellationToken ct = default);
} }
} }
@@ -7,7 +7,7 @@ using CryptoExchange.Net.Objects;
namespace CryptoExchange.Net.SharedApis namespace CryptoExchange.Net.SharedApis
{ {
/// <summary> /// <summary>
/// Client for subscribing to position updates /// Operation for subscribing to position updates
/// </summary> /// </summary>
public interface ISubscribePositionsSocket : ISharedSubscription public interface ISubscribePositionsSocket : ISharedSubscription
{ {
@@ -8,7 +8,7 @@ using System.Threading.Tasks;
namespace CryptoExchange.Net.SharedApis namespace CryptoExchange.Net.SharedApis
{ {
/// <summary> /// <summary>
/// Request definition for canceling a spot order on an exchange. /// Operation for canceling a spot order on an exchange.
/// </summary> /// </summary>
public interface ICancelSpotOrder : ISharedApiCapability public interface ICancelSpotOrder : ISharedApiCapability
{ {
@@ -27,28 +27,20 @@ namespace CryptoExchange.Net.SharedApis
} }
/// <summary> /// <summary>
/// Request definition for canceling a spot order on an exchange. /// Operation for canceling a spot order on an exchange via the REST API.
/// </summary> /// </summary>
public interface ICancelSpotOrderRest : ICancelSpotOrder, ISharedRest public interface ICancelSpotOrderRest : ICancelSpotOrder, ISharedRest
{ {
/// <summary> /// <inheritdoc />
/// Cancel a spot order, see <see cref="CancelSpotOrderOptions"/> for request options and exchange specific required/optional parameters. <br />
/// </summary>
/// <param name="request">Request info</param>
/// <param name="ct">Cancellation token</param>
new Task<HttpResult<SharedId>> CancelSpotOrderAsync(CancelOrderRequest request, CancellationToken ct = default); new Task<HttpResult<SharedId>> CancelSpotOrderAsync(CancelOrderRequest request, CancellationToken ct = default);
} }
/// <summary> /// <summary>
/// Client for placing and managing spot orders /// Operation for canceling a spot order on an exchange via the WebSocket API.
/// </summary> /// </summary>
public interface ICancelSpotOrderSocket : ICancelSpotOrder, ISharedSocket public interface ICancelSpotOrderSocket : ICancelSpotOrder, ISharedSocket
{ {
/// <summary> /// <inheritdoc />
/// Cancel a spot order, see <see cref="CancelSpotOrderOptions"/> for request options and exchange specific required/optional parameters. <br />
/// </summary>
/// <param name="request">Request info</param>
/// <param name="ct">Cancellation token</param>
new Task<QueryResult<SharedId>> CancelSpotOrderAsync(CancelOrderRequest request, CancellationToken ct = default); new Task<QueryResult<SharedId>> CancelSpotOrderAsync(CancelOrderRequest request, CancellationToken ct = default);
} }
@@ -8,7 +8,7 @@ using System.Threading.Tasks;
namespace CryptoExchange.Net.SharedApis namespace CryptoExchange.Net.SharedApis
{ {
/// <summary> /// <summary>
/// Request definition for canceling a spot order by client order id on an exchange. /// Operation for canceling a spot order by client order id on an exchange.
/// </summary> /// </summary>
public interface ICancelSpotOrderByClientOrderId: ISharedApiCapability public interface ICancelSpotOrderByClientOrderId: ISharedApiCapability
{ {
@@ -27,28 +27,20 @@ namespace CryptoExchange.Net.SharedApis
} }
/// <summary> /// <summary>
/// Request definition for canceling a spot order by client order id on an exchange. /// Operation for canceling a spot order by client order id on an exchange via the REST API.
/// </summary> /// </summary>
public interface ICancelSpotOrderByClientOrderIdRest : ICancelSpotOrderByClientOrderId, ISharedRest public interface ICancelSpotOrderByClientOrderIdRest : ICancelSpotOrderByClientOrderId, ISharedRest
{ {
/// <summary> /// <inheritdoc />
/// Cancel a spot order using client order id, see <see cref="CancelSpotOrderByClientOrderIdOptions"/> for request options and exchange specific required/optional parameters. <br />
/// </summary>
/// <param name="request">Request info</param>
/// <param name="ct">Cancellation token</param>
new Task<HttpResult<SharedId>> CancelSpotOrderByClientOrderIdAsync(CancelOrderRequest request, CancellationToken ct = default); new Task<HttpResult<SharedId>> CancelSpotOrderByClientOrderIdAsync(CancelOrderRequest request, CancellationToken ct = default);
} }
/// <summary> /// <summary>
/// Request definition for canceling a spot order by client order id on an exchange. /// Operation for canceling a spot order by client order id on an exchange via the WebSocket API.
/// </summary> /// </summary>
public interface ICancelSpotOrderByClientOrderIdSocket : ICancelSpotOrderByClientOrderId, ISharedSocket public interface ICancelSpotOrderByClientOrderIdSocket : ICancelSpotOrderByClientOrderId, ISharedSocket
{ {
/// <summary> /// <inheritdoc />
/// Cancel a spot order using client order id, see <see cref="CancelSpotOrderByClientOrderIdOptions"/> for request options and exchange specific required/optional parameters. <br />
/// </summary>
/// <param name="request">Request info</param>
/// <param name="ct">Cancellation token</param>
new Task<QueryResult<SharedId>> CancelSpotOrderByClientOrderIdAsync(CancelOrderRequest request, CancellationToken ct = default); new Task<QueryResult<SharedId>> CancelSpotOrderByClientOrderIdAsync(CancelOrderRequest request, CancellationToken ct = default);
} }
} }
@@ -8,7 +8,7 @@ using System.Threading.Tasks;
namespace CryptoExchange.Net.SharedApis namespace CryptoExchange.Net.SharedApis
{ {
/// <summary> /// <summary>
/// Request definition for retrieving closed spot orders from an exchange. /// Operation for retrieving closed spot orders from an exchange.
/// </summary> /// </summary>
public interface IGetClosedSpotOrders : ISharedApiCapability public interface IGetClosedSpotOrders : ISharedApiCapability
{ {
@@ -29,17 +29,11 @@ namespace CryptoExchange.Net.SharedApis
} }
/// <summary> /// <summary>
/// Request definition for retrieving closed spot orders from an exchange. /// Operation for retrieving closed spot orders from an exchange via the REST API.
/// </summary> /// </summary>
public interface IGetClosedSpotOrdersRest : IGetClosedSpotOrders, ISharedRest public interface IGetClosedSpotOrdersRest : IGetClosedSpotOrders, ISharedRest
{ {
/// <summary> /// <inheritdoc />
/// Get info on closed spot orders, see <see cref="GetClosedSpotOrdersOptions"/> for request options and exchange specific required/optional parameters. <br />
/// The result is paginated, if there are more results to be retrieved, the <see cref="HttpResult{T}.NextPageRequest"/> property of the result will contain the pagination request to be used for the next request to continue pagination.
/// </summary>
/// <param name="request">Request info</param>
/// <param name="nextPageToken">The pagination request from the previous request result <see cref="HttpResult{T}.NextPageRequest"/> property to continue pagination</param>
/// <param name="ct">Cancellation token</param>
new Task<HttpResult<SharedSpotOrder[]>> GetClosedSpotOrdersAsync(GetClosedOrdersRequest request, PageRequest? nextPageToken = null, CancellationToken ct = default); new Task<HttpResult<SharedSpotOrder[]>> GetClosedSpotOrdersAsync(GetClosedOrdersRequest request, PageRequest? nextPageToken = null, CancellationToken ct = default);
} }
} }
@@ -8,7 +8,7 @@ using System.Threading.Tasks;
namespace CryptoExchange.Net.SharedApis namespace CryptoExchange.Net.SharedApis
{ {
/// <summary> /// <summary>
/// Request definition for retrieving open spot order from an exchange. /// Operation for retrieving open spot orders from an exchange.
/// </summary> /// </summary>
public interface IGetOpenSpotOrders : ISharedApiCapability public interface IGetOpenSpotOrders : ISharedApiCapability
{ {
@@ -27,15 +27,11 @@ namespace CryptoExchange.Net.SharedApis
} }
/// <summary> /// <summary>
/// Request definition for retrieving open spot order from an exchange. /// Operation for retrieving open spot orders from an exchange via the REST API.
/// </summary> /// </summary>
public interface IGetOpenSpotOrdersRest : IGetOpenSpotOrders, ISharedRest public interface IGetOpenSpotOrdersRest : IGetOpenSpotOrders, ISharedRest
{ {
/// <summary> /// <inheritdoc />
/// Get info on a open spot orders, see <see cref="GetOpenSpotOrdersOptions"/> for request options and exchange specific required/optional parameters. <br />
/// </summary>
/// <param name="request">Request info</param>
/// <param name="ct">Cancellation token</param>
new Task<HttpResult<SharedSpotOrder[]>> GetOpenSpotOrdersAsync(GetOpenOrdersRequest request, CancellationToken ct = default); new Task<HttpResult<SharedSpotOrder[]>> GetOpenSpotOrdersAsync(GetOpenOrdersRequest request, CancellationToken ct = default);
} }
} }
@@ -8,7 +8,7 @@ using System.Threading.Tasks;
namespace CryptoExchange.Net.SharedApis namespace CryptoExchange.Net.SharedApis
{ {
/// <summary> /// <summary>
/// Request definition for retrieving a spot order from an exchange. /// Operation for retrieving a spot order from an exchange.
/// </summary> /// </summary>
public interface IGetSpotOrder : ISharedApiCapability public interface IGetSpotOrder : ISharedApiCapability
{ {
@@ -27,15 +27,11 @@ namespace CryptoExchange.Net.SharedApis
} }
/// <summary> /// <summary>
/// Request definition for retrieving a spot order from an exchange. /// Operation for retrieving a spot order from an exchange via the REST API.
/// </summary> /// </summary>
public interface IGetSpotOrderRest : IGetSpotOrder, ISharedRest public interface IGetSpotOrderRest : IGetSpotOrder, ISharedRest
{ {
/// <summary> /// <inheritdoc />
/// Get info on a specific spot order, see <see cref="GetSpotOrderOptions"/> for request options and exchange specific required/optional parameters. <br />
/// </summary>
/// <param name="request">Request info</param>
/// <param name="ct">Cancellation token</param>
new Task<HttpResult<SharedSpotOrder>> GetSpotOrderAsync(GetOrderRequest request, CancellationToken ct = default); new Task<HttpResult<SharedSpotOrder>> GetSpotOrderAsync(GetOrderRequest request, CancellationToken ct = default);
} }
} }
@@ -8,7 +8,7 @@ using System.Threading.Tasks;
namespace CryptoExchange.Net.SharedApis namespace CryptoExchange.Net.SharedApis
{ {
/// <summary> /// <summary>
/// Request definition for retrieving a spot order by client order id from an exchange. /// Operation for retrieving a spot order by client order id from an exchange.
/// </summary> /// </summary>
public interface IGetSpotOrderByClientOrderId : ISharedApiCapability public interface IGetSpotOrderByClientOrderId : ISharedApiCapability
{ {
@@ -29,15 +29,11 @@ namespace CryptoExchange.Net.SharedApis
} }
/// <summary> /// <summary>
/// Request definition for retrieving a spot order by client order id from an exchange. /// Operation for retrieving a spot order by client order id from an exchange via the REST API.
/// </summary> /// </summary>
public interface IGetSpotOrderByClientOrderIdRest : IGetSpotOrderByClientOrderId, ISharedRest public interface IGetSpotOrderByClientOrderIdRest : IGetSpotOrderByClientOrderId, ISharedRest
{ {
/// <summary> /// <inheritdoc />
/// Get info on a specific spot order using a client order id, see <see cref="GetSpotOrderByClientOrderIdOptions"/> for request options and exchange specific required/optional parameters. <br />
/// </summary>
/// <param name="request">Request info</param>
/// <param name="ct">Cancellation token</param>
new Task<HttpResult<SharedSpotOrder>> GetSpotOrderByClientOrderIdAsync(GetOrderRequest request, CancellationToken ct = default); new Task<HttpResult<SharedSpotOrder>> GetSpotOrderByClientOrderIdAsync(GetOrderRequest request, CancellationToken ct = default);
} }
@@ -7,6 +7,9 @@ using System.Threading.Tasks;
namespace CryptoExchange.Net.SharedApis namespace CryptoExchange.Net.SharedApis
{ {
/// <summary>
/// Operation for placing a spot order on an exchange.
/// </summary>
public interface IPlaceSpotOrder : ISharedApiCapability public interface IPlaceSpotOrder : ISharedApiCapability
{ {
/// <summary> /// <summary>
@@ -43,34 +46,31 @@ namespace CryptoExchange.Net.SharedApis
/// </summary> /// </summary>
PlaceSpotOrderOptions PlaceSpotOrderOptions { get; } PlaceSpotOrderOptions PlaceSpotOrderOptions { get; }
/// <summary>
/// Place a new spot order, see <see cref="PlaceSpotOrderOptions"/> for request options and exchange specific required/optional parameters. <br />
/// </summary>
/// <param name="request">Request info</param>
/// <param name="ct">Cancellation token</param>
Task<ICallResult<SharedId>> PlaceSpotOrderAsync( Task<ICallResult<SharedId>> PlaceSpotOrderAsync(
PlaceSpotOrderRequest request, PlaceSpotOrderRequest request,
CancellationToken ct = default); CancellationToken ct = default);
} }
/// <summary> /// <summary>
/// Request definition for placing a spot order on an exchange. /// Operation for placing a spot order on an exchange via the REST API.
/// </summary> /// </summary>
public interface IPlaceSpotOrderRest : IPlaceSpotOrder, ISharedRest public interface IPlaceSpotOrderRest : IPlaceSpotOrder, ISharedRest
{ {
/// <summary> /// <inheritdoc />
/// Place a new spot order, see <see cref="PlaceSpotOrderOptions"/> for request options and exchange specific required/optional parameters. <br />
/// </summary>
/// <param name="request">Request info</param>
/// <param name="ct">Cancellation token</param>
new Task<HttpResult<SharedId>> PlaceSpotOrderAsync(PlaceSpotOrderRequest request, CancellationToken ct = default); new Task<HttpResult<SharedId>> PlaceSpotOrderAsync(PlaceSpotOrderRequest request, CancellationToken ct = default);
} }
/// <summary> /// <summary>
/// Client for placing and managing spot orders /// Operation for placing a spot order on an exchange via the WebSocket API.
/// </summary> /// </summary>
public interface IPlaceSpotOrderSocket : IPlaceSpotOrder, ISharedSocket public interface IPlaceSpotOrderSocket : IPlaceSpotOrder, ISharedSocket
{ {
/// <summary> /// <inheritdoc />
/// Place a new spot order, see <see cref="PlaceSpotOrderOptions"/> for request options and exchange specific required/optional parameters. <br />
/// </summary>
/// <param name="request">Request info</param>
/// <param name="ct">Cancellation token</param>
new Task<QueryResult<SharedId>> PlaceSpotOrderAsync(PlaceSpotOrderRequest request, CancellationToken ct = default); new Task<QueryResult<SharedId>> PlaceSpotOrderAsync(PlaceSpotOrderRequest request, CancellationToken ct = default);
} }
} }
@@ -7,7 +7,7 @@ using System.Threading.Tasks;
namespace CryptoExchange.Net.SharedApis namespace CryptoExchange.Net.SharedApis
{ {
/// <summary> /// <summary>
/// Client for subscribing to user spot order updates /// Operation for subscribing to user spot order updates
/// </summary> /// </summary>
public interface ISubscribeSpotOrdersSocket : ISharedSubscription public interface ISubscribeSpotOrdersSocket : ISharedSubscription
{ {
@@ -8,7 +8,7 @@ using System.Threading.Tasks;
namespace CryptoExchange.Net.SharedApis namespace CryptoExchange.Net.SharedApis
{ {
/// <summary> /// <summary>
/// Request defintion for getting the current user position mode setting on an exchange. /// Operation for getting the current user position mode setting from an exchange.
/// </summary> /// </summary>
public interface IGetPositionMode : ISharedApiCapability public interface IGetPositionMode : ISharedApiCapability
{ {
@@ -27,15 +27,11 @@ namespace CryptoExchange.Net.SharedApis
} }
/// <summary> /// <summary>
/// Request defintion for getting the current user position mode setting on an exchange. /// Operation for getting the current user position mode setting from an exchange via the REST API.
/// </summary> /// </summary>
public interface IGetPositionModeRest : IGetPositionMode, ISharedRest public interface IGetPositionModeRest : IGetPositionMode, ISharedRest
{ {
/// <summary> /// <inheritdoc />
/// Get the current position mode setting, see <see cref="GetPositionModeOptions"/> for request options and exchange specific required/optional parameters. <br />
/// </summary>
/// <param name="request">Request info</param>
/// <param name="ct">Cancellation token</param>
new Task<HttpResult<SharedPositionModeResult>> GetPositionModeAsync(GetPositionModeRequest request, CancellationToken ct = default); new Task<HttpResult<SharedPositionModeResult>> GetPositionModeAsync(GetPositionModeRequest request, CancellationToken ct = default);
} }
} }
@@ -8,7 +8,7 @@ using System.Threading.Tasks;
namespace CryptoExchange.Net.SharedApis namespace CryptoExchange.Net.SharedApis
{ {
/// <summary> /// <summary>
/// Endpoint definition for setting the user position mode on an exchange. /// Operation for setting the user position mode on an exchange.
/// </summary> /// </summary>
public interface ISetPositionMode : ISharedApiCapability public interface ISetPositionMode : ISharedApiCapability
{ {
@@ -32,15 +32,11 @@ namespace CryptoExchange.Net.SharedApis
} }
/// <summary> /// <summary>
/// Endpoint definition for setting the user position mode on an exchange. /// Operation for setting the user position mode on an exchange via the REST API.
/// </summary> /// </summary>
public interface ISetPositionModeRest : ISetPositionMode, ISharedRest public interface ISetPositionModeRest : ISetPositionMode, ISharedRest
{ {
/// <summary> /// <inheritdoc />
/// Set the position mode to a new value, see <see cref="SetPositionModeOptions"/> for request options and exchange specific required/optional parameters. <br />
/// </summary>
/// <param name="request">Request info</param>
/// <param name="ct">Cancellation token</param>
new Task<HttpResult<SharedPositionModeResult>> SetPositionModeAsync(SetPositionModeRequest request, CancellationToken ct = default); new Task<HttpResult<SharedPositionModeResult>> SetPositionModeAsync(SetPositionModeRequest request, CancellationToken ct = default);
} }
} }
@@ -8,7 +8,7 @@ using System.Threading.Tasks;
namespace CryptoExchange.Net.SharedApis namespace CryptoExchange.Net.SharedApis
{ {
/// <summary> /// <summary>
/// Request definition for closing a position on an exchange. /// Operation for closing an open position on an exchange.
/// </summary> /// </summary>
public interface IClosePosition : ISharedApiCapability public interface IClosePosition : ISharedApiCapability
{ {
@@ -28,16 +28,11 @@ namespace CryptoExchange.Net.SharedApis
} }
/// <summary> /// <summary>
/// Request definition for closing a position on an exchange. /// Operation for closing an open position on an exchange via the REST API.
/// </summary> /// </summary>
public interface IClosePositionRest : IClosePosition, ISharedRest public interface IClosePositionRest : IClosePosition, ISharedRest
{ {
/// <summary> /// <inheritdoc />
/// Close a currently open position, see <see cref="ClosePositionOptions"/> for request options and exchange specific required/optional parameters. <br />
/// </summary>
/// <param name="request">Request info</param>
/// <param name="ct">Cancellation token</param>
/// <returns></returns>
new Task<HttpResult<SharedId>> ClosePositionAsync(ClosePositionRequest request, CancellationToken ct = default); new Task<HttpResult<SharedId>> ClosePositionAsync(ClosePositionRequest request, CancellationToken ct = default);
} }
} }
@@ -8,7 +8,7 @@ using System.Threading.Tasks;
namespace CryptoExchange.Net.SharedApis namespace CryptoExchange.Net.SharedApis
{ {
/// <summary> /// <summary>
/// Request definition for retrieving position history from an exchange. /// Operation for retrieving position history from an exchange.
/// </summary> /// </summary>
public interface IGetPositionHistory : ISharedApiCapability public interface IGetPositionHistory : ISharedApiCapability
{ {
@@ -29,17 +29,11 @@ namespace CryptoExchange.Net.SharedApis
} }
/// <summary> /// <summary>
/// Request definition for retrieving position history from an exchange. /// Operation for retrieving position history from an exchange via the REST API.
/// </summary> /// </summary>
public interface IGetPositionHistoryRest : IGetPositionHistory, ISharedRest public interface IGetPositionHistoryRest : IGetPositionHistory, ISharedRest
{ {
/// <summary> /// <inheritdoc />
/// Get position history, see <see cref="GetPositionHistoryOptions"/> for request options and exchange specific required/optional parameters. <br />
/// The result is paginated, if there are more results to be retrieved, the <see cref="HttpResult{T}.NextPageRequest"/> property of the result will contain the pagination request to be used for the next request to continue pagination.
/// </summary>
/// <param name="request">Request info</param>
/// <param name="nextPageToken">The pagination request from the previous request result <see cref="HttpResult{T}.NextPageRequest"/> property to continue pagination</param>
/// <param name="ct">Cancellation token</param>
new Task<HttpResult<SharedPositionHistory[]>> GetPositionHistoryAsync(GetPositionHistoryRequest request, PageRequest? nextPageToken = null, CancellationToken ct = default); new Task<HttpResult<SharedPositionHistory[]>> GetPositionHistoryAsync(GetPositionHistoryRequest request, PageRequest? nextPageToken = null, CancellationToken ct = default);
} }
} }
@@ -8,7 +8,7 @@ using System.Threading.Tasks;
namespace CryptoExchange.Net.SharedApis namespace CryptoExchange.Net.SharedApis
{ {
/// <summary> /// <summary>
/// Request definition for retrieving open positions from an exchange. /// Operation for retrieving open positions from an exchange.
/// </summary> /// </summary>
public interface IGetPositions : ISharedApiCapability public interface IGetPositions : ISharedApiCapability
{ {
@@ -27,15 +27,11 @@ namespace CryptoExchange.Net.SharedApis
} }
/// <summary> /// <summary>
/// Request definition for retrieving open positions from an exchange. /// Operation for retrieving open positions from an exchange via the REST API.
/// </summary> /// </summary>
public interface IGetPositionsRest : IGetPositions, ISharedRest public interface IGetPositionsRest : IGetPositions, ISharedRest
{ {
/// <summary> /// <inheritdoc />
/// Get open position info, see <see cref="GetPositionsOptions"/> for request options and exchange specific required/optional parameters. <br />
/// </summary>
/// <param name="request">Request info</param>
/// <param name="ct">Cancellation token</param>
new Task<HttpResult<SharedPosition[]>> GetPositionsAsync(GetPositionsRequest request, CancellationToken ct = default); new Task<HttpResult<SharedPosition[]>> GetPositionsAsync(GetPositionsRequest request, CancellationToken ct = default);
} }
} }
@@ -8,7 +8,7 @@ using System.Threading.Tasks;
namespace CryptoExchange.Net.SharedApis namespace CryptoExchange.Net.SharedApis
{ {
/// <summary> /// <summary>
/// Request definition for getting futures symbols from an exchange /// Operation for getting supported futures symbols from an exchange.
/// </summary> /// </summary>
public interface IGetFuturesSymbols : ISharedApiCapability public interface IGetFuturesSymbols : ISharedApiCapability
{ {
@@ -51,15 +51,11 @@ namespace CryptoExchange.Net.SharedApis
} }
/// <summary> /// <summary>
/// Request definition for getting futures symbols from an exchange /// Operation for getting supported futures symbols from an exchange via the REST API.
/// </summary> /// </summary>
public interface IGetFuturesSymbolsRest : IGetFuturesSymbols, ISharedRest public interface IGetFuturesSymbolsRest : IGetFuturesSymbols, ISharedRest
{ {
/// <summary> /// <inheritdoc />
/// Get info on all futures symbols supported on the exchange, see <see cref="GetFuturesSymbolsOptions"/> for request options and exchange specific required/optional parameters. <br />
/// </summary>
/// <param name="request">Request info</param>
/// <param name="ct">Cancellation token</param>
new Task<HttpResult<SharedFuturesSymbol[]>> GetFuturesSymbolsAsync(GetSymbolsRequest request, CancellationToken ct = default); new Task<HttpResult<SharedFuturesSymbol[]>> GetFuturesSymbolsAsync(GetSymbolsRequest request, CancellationToken ct = default);
} }
} }
@@ -8,7 +8,7 @@ using System.Threading.Tasks;
namespace CryptoExchange.Net.SharedApis namespace CryptoExchange.Net.SharedApis
{ {
/// <summary> /// <summary>
/// Request definition for retrieving spot symbols from an exchange. /// Operation for getting supported spot symbols from an exchange.
/// </summary> /// </summary>
public interface IGetSpotSymbols: ISharedApiCapability public interface IGetSpotSymbols: ISharedApiCapability
{ {
@@ -51,16 +51,11 @@ namespace CryptoExchange.Net.SharedApis
} }
/// <summary> /// <summary>
/// Request definition for retrieving spot symbols from an exchange. /// Operation for getting supported futures symbols from an exchange via the REST API.
/// </summary> /// </summary>
public interface IGetSpotSymbolsRest : IGetSpotSymbols, ISharedRest public interface IGetSpotSymbolsRest : IGetSpotSymbols, ISharedRest
{ {
/// <inheritdoc />
/// <summary>
/// Get info on all available spot symbols on the exchange, see <see cref="GetSpotSymbolsOptions"/> for request options and exchange specific required/optional parameters. <br />
/// </summary>
/// <param name="request">Request info</param>
/// <param name="ct">Cancellation token</param>
new Task<HttpResult<SharedSpotSymbol[]>> GetSpotSymbolsAsync(GetSymbolsRequest request, CancellationToken ct = default); new Task<HttpResult<SharedSpotSymbol[]>> GetSpotSymbolsAsync(GetSymbolsRequest request, CancellationToken ct = default);
} }
} }
@@ -8,7 +8,7 @@ using System.Threading.Tasks;
namespace CryptoExchange.Net.SharedApis namespace CryptoExchange.Net.SharedApis
{ {
/// <summary> /// <summary>
/// Request definition for retrieving all futures tickers from an exchange. /// Operation for retrieving all futures tickers from an exchange.
/// </summary> /// </summary>
public interface IGetAllFuturesTickers : ISharedApiCapability public interface IGetAllFuturesTickers : ISharedApiCapability
{ {
@@ -27,15 +27,11 @@ namespace CryptoExchange.Net.SharedApis
} }
/// <summary> /// <summary>
/// Request definition for retrieving all futures tickers from an exchange. /// Operation for retrieving all futures tickers from an exchange via the REST API.
/// </summary> /// </summary>
public interface IGetAllFuturesTickersRest : IGetAllFuturesTickers public interface IGetAllFuturesTickersRest : IGetAllFuturesTickers
{ {
/// <summary> /// <inheritdoc />
/// Get ticker info for all futures symbols, see <see cref="GetAllFuturesTickersOptions"/> for request options and exchange specific required/optional parameters. <br />
/// </summary>
/// <param name="request">Request info</param>
/// <param name="ct">Cancellation token</param>
new Task<HttpResult<SharedFuturesTicker[]>> GetAllFuturesTickersAsync(GetTickersRequest request, CancellationToken ct = default); new Task<HttpResult<SharedFuturesTicker[]>> GetAllFuturesTickersAsync(GetTickersRequest request, CancellationToken ct = default);
} }
} }
@@ -8,7 +8,7 @@ using System.Threading.Tasks;
namespace CryptoExchange.Net.SharedApis namespace CryptoExchange.Net.SharedApis
{ {
/// <summary> /// <summary>
/// Request definition for retrieving a futures ticker from an exchange. /// Operation for retrieving a single futures ticker from an exchange.
/// </summary> /// </summary>
public interface IGetFuturesTicker : ISharedApiCapability public interface IGetFuturesTicker : ISharedApiCapability
{ {
@@ -27,15 +27,11 @@ namespace CryptoExchange.Net.SharedApis
} }
/// <summary> /// <summary>
/// Request definition for retrieving a futures ticker from an exchange. /// Operation for retrieving a single futures ticker from an exchange via the REST API.
/// </summary> /// </summary>
public interface IGetFuturesTickerRest : IGetFuturesTicker, ISharedRest public interface IGetFuturesTickerRest : IGetFuturesTicker, ISharedRest
{ {
/// <summary> /// <inheritdoc />
/// Get ticker info for a specific futures symbol, see <see cref="GetFuturesTickerOptions"/> for request options and exchange specific required/optional parameters. <br />
/// </summary>
/// <param name="request">Request info</param>
/// <param name="ct">Cancellation token</param>
new Task<HttpResult<SharedFuturesTicker>> GetFuturesTickerAsync(GetTickerRequest request, CancellationToken ct = default); new Task<HttpResult<SharedFuturesTicker>> GetFuturesTickerAsync(GetTickerRequest request, CancellationToken ct = default);
} }
} }
@@ -7,7 +7,7 @@ using System.Threading.Tasks;
namespace CryptoExchange.Net.SharedApis namespace CryptoExchange.Net.SharedApis
{ {
/// <summary> /// <summary>
/// Client for subscribing to ticker updates for all symbols /// Operation for subscribing to ticker updates for all symbols
/// </summary> /// </summary>
public interface ISubscribeAllTickersSocket : ISharedSubscription public interface ISubscribeAllTickersSocket : ISharedSubscription
{ {
@@ -7,7 +7,7 @@ using System.Threading.Tasks;
namespace CryptoExchange.Net.SharedApis namespace CryptoExchange.Net.SharedApis
{ {
/// <summary> /// <summary>
/// Client for subscribing to book ticker updates for a symbol /// Operation for subscribing to book ticker updates for a symbol
/// </summary> /// </summary>
public interface ISubscribeBookTickerSocket : ISharedSubscription public interface ISubscribeBookTickerSocket : ISharedSubscription
{ {
@@ -7,7 +7,7 @@ using System.Threading.Tasks;
namespace CryptoExchange.Net.SharedApis namespace CryptoExchange.Net.SharedApis
{ {
/// <summary> /// <summary>
/// Client for subscribing to ticker updates for a symbol /// Operation for subscribing to ticker updates for a symbol
/// </summary> /// </summary>
public interface ISubscribeTickerSocket : ISharedSubscription public interface ISubscribeTickerSocket : ISharedSubscription
{ {
@@ -8,7 +8,7 @@ using System.Threading.Tasks;
namespace CryptoExchange.Net.SharedApis namespace CryptoExchange.Net.SharedApis
{ {
/// <summary> /// <summary>
/// Request definition for retrieving all spot tickers from an exchange. /// Operation for retrieving all spot tickers from an exchange.
/// </summary> /// </summary>
public interface IGetAllSpotTickers : ISharedApiCapability public interface IGetAllSpotTickers : ISharedApiCapability
{ {
@@ -27,15 +27,11 @@ namespace CryptoExchange.Net.SharedApis
} }
/// <summary> /// <summary>
/// Request definition for retrieving all spot tickers from an exchange. /// Operation for retrieving all spot tickers from an exchange via the REST API.
/// </summary> /// </summary>
public interface IGetAllSpotTickersRest : IGetAllSpotTickers, ISharedRest public interface IGetAllSpotTickersRest : IGetAllSpotTickers, ISharedRest
{ {
/// <summary> /// <inheritdoc />
/// Get tickers for all spot symbols, see <see cref="GetAllSpotTickersOptions"/> for request options and exchange specific required/optional parameters. <br />
/// </summary>
/// <param name="request">Request info</param>
/// <param name="ct">Cancellation token</param>
new Task<HttpResult<SharedSpotTicker[]>> GetAllSpotTickersAsync(GetTickersRequest request, CancellationToken ct = default); new Task<HttpResult<SharedSpotTicker[]>> GetAllSpotTickersAsync(GetTickersRequest request, CancellationToken ct = default);
} }
} }
@@ -8,7 +8,7 @@ using System.Threading.Tasks;
namespace CryptoExchange.Net.SharedApis namespace CryptoExchange.Net.SharedApis
{ {
/// <summary> /// <summary>
/// Request definition for getting spot ticker info from an exchange. /// Operation for retrieving a single spot ticker from an exchange.
/// </summary> /// </summary>
public interface IGetSpotTicker : ISharedApiCapability public interface IGetSpotTicker : ISharedApiCapability
{ {
@@ -27,15 +27,11 @@ namespace CryptoExchange.Net.SharedApis
} }
/// <summary> /// <summary>
/// Request definition for getting spot ticker info from an exchange. /// Operation for retrieving a single spot ticker from an exchange via the REST API
/// </summary> /// </summary>
public interface IGetSpotTickerRest : IGetSpotTicker, ISharedRest public interface IGetSpotTickerRest : IGetSpotTicker, ISharedRest
{ {
/// <summary> /// <inheritdoc />
/// Get ticker for a specific spot symbol, see <see cref="GetSpotTickerOptions"/> for request options and exchange specific required/optional parameters. <br />
/// </summary>
/// <param name="request">Request info</param>
/// <param name="ct">Cancellation token</param>
new Task<HttpResult<SharedSpotTicker>> GetSpotTickerAsync(GetTickerRequest request, CancellationToken ct = default); new Task<HttpResult<SharedSpotTicker>> GetSpotTickerAsync(GetTickerRequest request, CancellationToken ct = default);
} }
} }
@@ -8,7 +8,7 @@ using System.Threading.Tasks;
namespace CryptoExchange.Net.SharedApis namespace CryptoExchange.Net.SharedApis
{ {
/// <summary> /// <summary>
/// Request definition for canceling a take profit and/or stop loss for an open position on an exchange. /// Operation for canceling a take profit and/or stop loss for an open position on an exchange.
/// </summary> /// </summary>
public interface ICancelFuturesTpSl : ISharedApiCapability public interface ICancelFuturesTpSl : ISharedApiCapability
{ {
@@ -28,16 +28,11 @@ namespace CryptoExchange.Net.SharedApis
} }
/// <summary> /// <summary>
/// Request definition for canceling a take profit and/or stop loss for an open position on an exchange. /// Operation for canceling a take profit and/or stop loss for an open position on an exchange via the REST API.
/// </summary> /// </summary>
public interface ICancelFuturesTpSlRest : ICancelFuturesTpSl, ISharedRest public interface ICancelFuturesTpSlRest : ICancelFuturesTpSl, ISharedRest
{ {
/// <summary> /// <inheritdoc />
/// Cancel an active take profit and/or stop loss for an open position, see <see cref="CancelFuturesTpSlOptions"/> for request options and exchange specific required/optional parameters. <br />
/// </summary>
/// <param name="request">Request info</param>
/// <param name="ct">Cancellation token</param>
/// <returns></returns>
new Task<HttpResult<bool>> CancelFuturesTpSlAsync(CancelTpSlRequest request, CancellationToken ct = default); new Task<HttpResult<bool>> CancelFuturesTpSlAsync(CancelTpSlRequest request, CancellationToken ct = default);
} }
} }
@@ -8,7 +8,7 @@ using System.Threading.Tasks;
namespace CryptoExchange.Net.SharedApis namespace CryptoExchange.Net.SharedApis
{ {
/// <summary> /// <summary>
/// Request definition for setting take profit and/or stop loss for an open position on an exchange. /// Operation for setting a take profit and/or stop loss for an open position on an exchange.
/// </summary> /// </summary>
public interface ISetFuturesTpSl : ISharedApiCapability public interface ISetFuturesTpSl : ISharedApiCapability
{ {
@@ -28,16 +28,11 @@ namespace CryptoExchange.Net.SharedApis
} }
/// <summary> /// <summary>
/// Request definition for setting take profit and/or stop loss for an open position on an exchange. /// Operation for setting a take profit and/or stop loss for an open position on an exchange via the REST API.
/// </summary> /// </summary>
public interface ISetFuturesTpSlRest : ISetFuturesTpSl, ISharedRest public interface ISetFuturesTpSlRest : ISetFuturesTpSl, ISharedRest
{ {
/// <summary> /// <inheritdoc />
/// Set a take profit and/or stop loss for an open position, see <see cref="SetFuturesTpSlOptions"/> for request options and exchange specific required/optional parameters. <br />
/// </summary>
/// <param name="request">Request info</param>
/// <param name="ct">Cancellation token</param>
/// <returns></returns>
new Task<HttpResult<SharedId>> SetFuturesTpSlAsync(SetTpSlRequest request, CancellationToken ct = default); new Task<HttpResult<SharedId>> SetFuturesTpSlAsync(SetTpSlRequest request, CancellationToken ct = default);
} }
} }
@@ -8,7 +8,7 @@ using System.Threading.Tasks;
namespace CryptoExchange.Net.SharedApis namespace CryptoExchange.Net.SharedApis
{ {
/// <summary> /// <summary>
/// Request definition for retrieving recent trades for a symbol on an exchange. /// Operation for retrieving the most recent trades for a symbol on an exchange.
/// </summary> /// </summary>
public interface IGetRecentTrades : ISharedApiCapability public interface IGetRecentTrades : ISharedApiCapability
{ {
@@ -29,17 +29,11 @@ namespace CryptoExchange.Net.SharedApis
} }
/// <summary> /// <summary>
/// Request definition for retrieving recent trades for a symbol on an exchange. /// Operation for retrieving the most recent trades for a symbol on an exchange via the REST API.
/// </summary> /// </summary>
public interface IGetRecentTradesRest : IGetRecentTrades, ISharedRest public interface IGetRecentTradesRest : IGetRecentTrades, ISharedRest
{ {
/// <inheritdoc />
/// <summary>
/// Get the most recent public trades, see <see cref="GetRecentTradesOptions"/> for request options and exchange specific required/optional parameters. <br />
/// </summary>
/// <param name="request">Request info</param>
/// <param name="ct">Cancellation token</param>
/// <returns></returns>
new Task<HttpResult<SharedTrade[]>> GetRecentTradesAsync(GetRecentTradesRequest request, CancellationToken ct = default); new Task<HttpResult<SharedTrade[]>> GetRecentTradesAsync(GetRecentTradesRequest request, CancellationToken ct = default);
} }
} }
@@ -8,7 +8,7 @@ using System.Threading.Tasks;
namespace CryptoExchange.Net.SharedApis namespace CryptoExchange.Net.SharedApis
{ {
/// <summary> /// <summary>
/// Request definition for retrieving trade history from an exchange. /// Operation for retrieving trade history from an exchange.
/// </summary> /// </summary>
public interface IGetTradeHistory : ISharedApiCapability public interface IGetTradeHistory : ISharedApiCapability
{ {
@@ -31,19 +31,11 @@ namespace CryptoExchange.Net.SharedApis
} }
/// <summary> /// <summary>
/// Request definition for retrieving trade history from an exchange. /// Operation for retrieving trade history from an exchange via the REST API.
/// </summary> /// </summary>
public interface IGetTradeHistoryRest : ISharedRest public interface IGetTradeHistoryRest : IGetTradeHistory, ISharedRest
{ {
/// <inheritdoc />
/// <summary>
/// Get public trade history, see <see cref="GetTradeHistoryOptions"/> for request options and exchange specific required/optional parameters. <br />
/// The result is paginated, if there are more results to be retrieved, the <see cref="HttpResult{T}.NextPageRequest"/> property of the result will contain the pagination request to be used for the next request to continue pagination.
/// </summary>
/// <param name="request">Request info</param>
/// <param name="nextPageToken">The pagination request from the previous request result <see cref="HttpResult{T}.NextPageRequest"/> property to continue pagination</param>
/// <param name="ct">Cancellation token</param>
/// <returns></returns>
new Task<HttpResult<SharedTrade[]>> GetTradeHistoryAsync(GetTradeHistoryRequest request, PageRequest? nextPageToken = null, CancellationToken ct = default); new Task<HttpResult<SharedTrade[]>> GetTradeHistoryAsync(GetTradeHistoryRequest request, PageRequest? nextPageToken = null, CancellationToken ct = default);
} }
} }
@@ -8,7 +8,7 @@ using System.Threading.Tasks;
namespace CryptoExchange.Net.SharedApis namespace CryptoExchange.Net.SharedApis
{ {
/// <summary> /// <summary>
/// Request definition for transferring funds between account types on an exchange. /// Operation for transferring funds between account types on an exchange.
/// </summary> /// </summary>
public interface ITransfer : ISharedApiCapability public interface ITransfer : ISharedApiCapability
{ {
@@ -28,15 +28,11 @@ namespace CryptoExchange.Net.SharedApis
} }
/// <summary> /// <summary>
/// Request definition for transferring funds between account types on an exchange. /// Operation for transferring funds between account types on an exchange via the REST API.
/// </summary> /// </summary>
public interface ITransferRest : ITransfer, ISharedRest public interface ITransferRest : ITransfer, ISharedRest
{ {
/// <summary> /// <inheritdoc />
/// Transfer funds between account types, see <see cref="TransferOptions"/> for request options and exchange specific required/optional parameters. <br />
/// </summary>
/// <param name="request">Request info</param>
/// <param name="ct">Cancellation token</param>
new Task<HttpResult<SharedId>> TransferAsync(TransferRequest request, CancellationToken ct = default); new Task<HttpResult<SharedId>> TransferAsync(TransferRequest request, CancellationToken ct = default);
} }
} }
@@ -8,7 +8,7 @@ using System.Threading.Tasks;
namespace CryptoExchange.Net.SharedApis namespace CryptoExchange.Net.SharedApis
{ {
/// <summary> /// <summary>
/// Request definition for canceling a futures trigger order on an exchange. /// Operation for canceling an active futures trigger order on an exchange.
/// </summary> /// </summary>
public interface ICancelFuturesTriggerOrder : ISharedApiCapability public interface ICancelFuturesTriggerOrder : ISharedApiCapability
{ {
@@ -27,15 +27,11 @@ namespace CryptoExchange.Net.SharedApis
} }
/// <summary> /// <summary>
/// Request definition for canceling a futures trigger order on an exchange. /// Operation for canceling an active futures trigger order on an exchange via the REST API.
/// </summary> /// </summary>
public interface ICancelFuturesTriggerOrderRest : ICancelFuturesTriggerOrder, ISharedRest public interface ICancelFuturesTriggerOrderRest : ICancelFuturesTriggerOrder, ISharedRest
{ {
/// <summary> /// <inheritdoc />
/// Cancel a trigger order, see <see cref="CancelFuturesTriggerOrderOptions"/> for request options and exchange specific required/optional parameters. <br />
/// </summary>
/// <param name="request">Request info</param>
/// <param name="ct">Cancellation token</param>
new Task<HttpResult<SharedId>> CancelFuturesTriggerOrderAsync(CancelOrderRequest request, CancellationToken ct = default); new Task<HttpResult<SharedId>> CancelFuturesTriggerOrderAsync(CancelOrderRequest request, CancellationToken ct = default);
} }
} }
@@ -8,7 +8,7 @@ using System.Threading.Tasks;
namespace CryptoExchange.Net.SharedApis namespace CryptoExchange.Net.SharedApis
{ {
/// <summary> /// <summary>
/// Request definition for getting a specific futures trigger order from the exchange. /// Operation for getting a specific futures trigger order from the exchange.
/// </summary> /// </summary>
public interface IGetFuturesTriggerOrder : ISharedApiCapability public interface IGetFuturesTriggerOrder : ISharedApiCapability
{ {
@@ -27,15 +27,11 @@ namespace CryptoExchange.Net.SharedApis
} }
/// <summary> /// <summary>
/// Request definition for getting a specific futures trigger order from the exchange. /// Operation for getting a specific futures trigger order from the exchange via the REST API.
/// </summary> /// </summary>
public interface IGetFuturesTriggerOrderRest : IGetFuturesTriggerOrder, ISharedRest public interface IGetFuturesTriggerOrderRest : IGetFuturesTriggerOrder, ISharedRest
{ {
/// <summary> /// <inheritdoc />
/// Get info on a specific trigger order, see <see cref="GetFuturesTriggerOrderOptions"/> for request options and exchange specific required/optional parameters. <br />
/// </summary>
/// <param name="request">Request info</param>
/// <param name="ct">Cancellation token</param>
new Task<HttpResult<SharedFuturesTriggerOrder>> GetFuturesTriggerOrderAsync(GetOrderRequest request, CancellationToken ct = default); new Task<HttpResult<SharedFuturesTriggerOrder>> GetFuturesTriggerOrderAsync(GetOrderRequest request, CancellationToken ct = default);
} }
} }
@@ -8,7 +8,7 @@ using System.Threading.Tasks;
namespace CryptoExchange.Net.SharedApis namespace CryptoExchange.Net.SharedApis
{ {
/// <summary> /// <summary>
/// Request definition for placing a futures trigger order on an exchange. /// Operation for placing a futures trigger order on an exchange.
/// </summary> /// </summary>
public interface IPlaceFuturesTriggerOrder : ISharedApiCapability public interface IPlaceFuturesTriggerOrder : ISharedApiCapability
{ {
@@ -29,16 +29,11 @@ namespace CryptoExchange.Net.SharedApis
} }
/// <summary> /// <summary>
/// Request definition for placing a futures trigger order on an exchange. /// Operation for placing a futures trigger order on an exchange via the REST API.
/// </summary> /// </summary>
public interface IPlaceFuturesTriggerOrderRest : IPlaceFuturesTriggerOrder, ISharedRest public interface IPlaceFuturesTriggerOrderRest : IPlaceFuturesTriggerOrder, ISharedRest
{ {
/// <summary> /// <inheritdoc />
/// Place a new trigger order, see <see cref="PlaceFuturesTriggerOrderOptions"/> for request options and exchange specific required/optional parameters. <br />
/// </summary>
/// <param name="request">Request info</param>
/// <param name="ct">Cancellation token</param>
/// <returns></returns>
new Task<HttpResult<SharedId>> PlaceFuturesTriggerOrderAsync(PlaceFuturesTriggerOrderRequest request, CancellationToken ct = default); new Task<HttpResult<SharedId>> PlaceFuturesTriggerOrderAsync(PlaceFuturesTriggerOrderRequest request, CancellationToken ct = default);
} }
} }
@@ -8,7 +8,7 @@ using System.Threading.Tasks;
namespace CryptoExchange.Net.SharedApis namespace CryptoExchange.Net.SharedApis
{ {
/// <summary> /// <summary>
/// Request definition for canceling a spot trigger order on an exchange /// Operation for canceling a spot trigger order on an exchange.
/// </summary> /// </summary>
public interface ICancelSpotTriggerOrder : ISharedApiCapability public interface ICancelSpotTriggerOrder : ISharedApiCapability
{ {
@@ -27,15 +27,11 @@ namespace CryptoExchange.Net.SharedApis
} }
/// <summary> /// <summary>
/// Request definition for canceling a spot trigger order on an exchange /// Operation for canceling a spot trigger order on an exchange via the REST API.
/// </summary> /// </summary>
public interface ICancelSpotTriggerOrderRest : ICancelSpotTriggerOrder, ISharedRest public interface ICancelSpotTriggerOrderRest : ICancelSpotTriggerOrder, ISharedRest
{ {
/// <summary> /// <inheritdoc />
/// Cancel a trigger order, see <see cref="CancelSpotTriggerOrderOptions"/> for request options and exchange specific required/optional parameters. <br />
/// </summary>
/// <param name="request">Request info</param>
/// <param name="ct">Cancellation token</param>
new Task<HttpResult<SharedId>> CancelSpotTriggerOrderAsync(CancelOrderRequest request, CancellationToken ct = default); new Task<HttpResult<SharedId>> CancelSpotTriggerOrderAsync(CancelOrderRequest request, CancellationToken ct = default);
} }
} }
@@ -8,7 +8,7 @@ using System.Threading.Tasks;
namespace CryptoExchange.Net.SharedApis namespace CryptoExchange.Net.SharedApis
{ {
/// <summary> /// <summary>
/// Request definition for getting a specific spot trigger order on an exchange /// Operation for retrieving a specific spot trigger order from an exchange.
/// </summary> /// </summary>
public interface IGetSpotTriggerOrder : ISharedApiCapability public interface IGetSpotTriggerOrder : ISharedApiCapability
{ {
@@ -27,15 +27,11 @@ namespace CryptoExchange.Net.SharedApis
} }
/// <summary> /// <summary>
/// Request definition for getting a specific spot trigger order on an exchange /// Operation for retrieving a specific spot trigger order from an exchange via the REST API.
/// </summary> /// </summary>
public interface IGetSpotTriggerOrderRest : IGetSpotTriggerOrder, ISharedRest public interface IGetSpotTriggerOrderRest : IGetSpotTriggerOrder, ISharedRest
{ {
/// <summary> /// <inheritdoc />
/// Get info on a specific trigger order, see <see cref="GetSpotTriggerOrderOptions"/> for request options and exchange specific required/optional parameters. <br />
/// </summary>
/// <param name="request">Request info</param>
/// <param name="ct">Cancellation token</param>
new Task<HttpResult<SharedSpotTriggerOrder>> GetSpotTriggerOrderAsync(GetOrderRequest request, CancellationToken ct = default); new Task<HttpResult<SharedSpotTriggerOrder>> GetSpotTriggerOrderAsync(GetOrderRequest request, CancellationToken ct = default);
} }
} }
@@ -8,7 +8,7 @@ using System.Threading.Tasks;
namespace CryptoExchange.Net.SharedApis namespace CryptoExchange.Net.SharedApis
{ {
/// <summary> /// <summary>
/// Request definition for placing a spot trigger order on an exchange. /// Operation for placing a spot trigger order on an exchange.
/// </summary> /// </summary>
public interface IPlaceSpotTriggerOrder : ISharedApiCapability public interface IPlaceSpotTriggerOrder : ISharedApiCapability
{ {
@@ -30,16 +30,11 @@ namespace CryptoExchange.Net.SharedApis
} }
/// <summary> /// <summary>
/// Request definition for placing a spot trigger order on an exchange. /// Operation for placing a spot trigger order on an exchange via the REST API.
/// </summary> /// </summary>
public interface IPlaceSpotTriggerOrderRest : IPlaceSpotTriggerOrder, ISharedRest public interface IPlaceSpotTriggerOrderRest : IPlaceSpotTriggerOrder, ISharedRest
{ {
/// <summary> /// <inheritdoc />
/// Place a new trigger order, see <see cref="PlaceSpotTriggerOrderOptions"/> for request options and exchange specific required/optional parameters. <br />
/// </summary>
/// <param name="request">Request info</param>
/// <param name="ct">Cancellation token</param>
/// <returns></returns>
new Task<HttpResult<SharedId>> PlaceSpotTriggerOrderAsync(PlaceSpotTriggerOrderRequest request, CancellationToken ct = default); new Task<HttpResult<SharedId>> PlaceSpotTriggerOrderAsync(PlaceSpotTriggerOrderRequest request, CancellationToken ct = default);
} }
@@ -8,7 +8,7 @@ using System.Threading.Tasks;
namespace CryptoExchange.Net.SharedApis namespace CryptoExchange.Net.SharedApis
{ {
/// <summary> /// <summary>
/// Request definition for getting trades for a specific futures order on an exchange. /// Operation for retrieving trades for a specific futures order on an exchange.
/// </summary> /// </summary>
public interface IGetFuturesOrderTrades : ISharedApiCapability public interface IGetFuturesOrderTrades : ISharedApiCapability
{ {
@@ -27,15 +27,11 @@ namespace CryptoExchange.Net.SharedApis
} }
/// <summary> /// <summary>
/// Request definition for getting trades for a specific futures order on an exchange. /// Operation for retrieving trades for a specific futures order on an exchange via the REST API.
/// </summary> /// </summary>
public interface IGetFuturesOrderTradesRest : IGetFuturesOrderTrades, ISharedRest public interface IGetFuturesOrderTradesRest : IGetFuturesOrderTrades, ISharedRest
{ {
/// <summary> /// <inheritdoc />
/// Get trades for a specific futures order, see <see cref="GetFuturesOrderTradesOptions"/> for request options and exchange specific required/optional parameters. <br />
/// </summary>
/// <param name="request">Request info</param>
/// <param name="ct">Cancellation token</param>
new Task<HttpResult<SharedUserTrade[]>> GetFuturesOrderTradesAsync(GetOrderTradesRequest request, CancellationToken ct = default); new Task<HttpResult<SharedUserTrade[]>> GetFuturesOrderTradesAsync(GetOrderTradesRequest request, CancellationToken ct = default);
} }
} }
@@ -8,7 +8,7 @@ using System.Threading.Tasks;
namespace CryptoExchange.Net.SharedApis namespace CryptoExchange.Net.SharedApis
{ {
/// <summary> /// <summary>
/// Request definition for retrieving futures user trade history from an exchange. /// Operation for retrieving futures user trade history from an exchange.
/// </summary> /// </summary>
public interface IGetFuturesUserTradeHistory : ISharedApiCapability public interface IGetFuturesUserTradeHistory : ISharedApiCapability
{ {
@@ -29,17 +29,11 @@ namespace CryptoExchange.Net.SharedApis
} }
/// <summary> /// <summary>
/// Request definition for retrieving futures user trade history from an exchange. /// Operation for retrieving futures user trade history from an exchange via the REST API.
/// </summary> /// </summary>
public interface IGetFuturesUserTradeHistoryRest : IGetFuturesUserTradeHistory, ISharedRest public interface IGetFuturesUserTradeHistoryRest : IGetFuturesUserTradeHistory, ISharedRest
{ {
/// <summary> /// <inheritdoc />
/// Get futures user trade records, see <see cref="GetFuturesUserTradeHistoryOptions"/> for request options and exchange specific required/optional parameters. <br />
/// The result is paginated, if there are more results to be retrieved, the <see cref="HttpResult{T}.NextPageRequest"/> property of the result will contain the pagination request to be used for the next request to continue pagination.
/// </summary>
/// <param name="request">Request info</param>
/// <param name="nextPageToken">The pagination request from the previous request result <see cref="HttpResult{T}.NextPageRequest"/> property to continue pagination</param>
/// <param name="ct">Cancellation token</param>
new Task<HttpResult<SharedUserTrade[]>> GetFuturesUserTradeHistoryAsync(GetUserTradesRequest request, PageRequest? nextPageToken = null, CancellationToken ct = default); new Task<HttpResult<SharedUserTrade[]>> GetFuturesUserTradeHistoryAsync(GetUserTradesRequest request, PageRequest? nextPageToken = null, CancellationToken ct = default);
} }
} }
@@ -7,7 +7,7 @@ using System.Threading.Tasks;
namespace CryptoExchange.Net.SharedApis namespace CryptoExchange.Net.SharedApis
{ {
/// <summary> /// <summary>
/// Client for subscribing to user trade updates /// Operation for subscribing to user trade updates
/// </summary> /// </summary>
public interface ISubscribeUserTradesSocket : ISharedSubscription public interface ISubscribeUserTradesSocket : ISharedSubscription
{ {
@@ -8,7 +8,7 @@ using System.Threading.Tasks;
namespace CryptoExchange.Net.SharedApis namespace CryptoExchange.Net.SharedApis
{ {
/// <summary> /// <summary>
/// Request definition for getting trades for a specific spot order on an exchange. /// Operation for getting trades for a specific spot order on an exchange.
/// </summary> /// </summary>
public interface IGetSpotOrderTrades : ISharedApiCapability public interface IGetSpotOrderTrades : ISharedApiCapability
{ {
@@ -29,16 +29,11 @@ namespace CryptoExchange.Net.SharedApis
} }
/// <summary> /// <summary>
/// Request definition for getting trades for a specific spot order on an exchange. /// Operation for getting trades for a specific spot order on an exchange via the REST API.
/// </summary> /// </summary>
public interface IGetSpotOrderTradesRest : IGetSpotOrderTrades, ISharedRest public interface IGetSpotOrderTradesRest : IGetSpotOrderTrades, ISharedRest
{ {
/// <summary> /// <inheritdoc />
/// Get trades for a specific spot order, see <see cref="GetSpotOrderTradesOptions"/> for request options and exchange specific required/optional parameters. <br />
/// The result is paginated, if there are more results to be retrieved, the `NextPageRequest` property of the result will contain the pagination request to be used for the next request to continue pagination.
/// </summary>
/// <param name="request">Request info</param>
/// <param name="ct">Cancellation token</param>
new Task<HttpResult<SharedUserTrade[]>> GetSpotOrderTradesAsync(GetOrderTradesRequest request, CancellationToken ct = default); new Task<HttpResult<SharedUserTrade[]>> GetSpotOrderTradesAsync(GetOrderTradesRequest request, CancellationToken ct = default);
} }
@@ -8,7 +8,7 @@ using System.Threading.Tasks;
namespace CryptoExchange.Net.SharedApis namespace CryptoExchange.Net.SharedApis
{ {
/// <summary> /// <summary>
/// Request definition for getting spot user trade history from an exchange /// Operation for retrieving spot user trade history from an exchange.
/// </summary> /// </summary>
public interface IGetSpotUserTradeHistory : ISharedApiCapability public interface IGetSpotUserTradeHistory : ISharedApiCapability
{ {
@@ -28,19 +28,12 @@ namespace CryptoExchange.Net.SharedApis
Task<ICallResult<SharedUserTrade[]>> GetSpotUserTradeHistoryAsync(GetUserTradesRequest request, PageRequest? nextPageToken = null, CancellationToken ct = default); Task<ICallResult<SharedUserTrade[]>> GetSpotUserTradeHistoryAsync(GetUserTradesRequest request, PageRequest? nextPageToken = null, CancellationToken ct = default);
} }
/// <summary> /// <summary>
/// Request definition for getting spot user trade history from an exchange /// Operation for retrieving spot user trade history from an exchange via the REST API.
/// </summary> /// </summary>
public interface IGetSpotUserTradeHistoryRest : IGetSpotUserTradeHistory, ISharedRest public interface IGetSpotUserTradeHistoryRest : IGetSpotUserTradeHistory, ISharedRest
{ {
/// <summary> /// <inheritdoc />
/// Get spot user trade records, see <see cref="SharedApis.GetSpotUserTradeHistoryOptions"/> for request options and exchange specific required/optional parameters. <br />
/// The result is paginated, if there are more results to be retrieved, the <see cref="HttpResult{T}.NextPageRequest"/> property of the result will contain the pagination request to be used for the next request to continue pagination.
/// </summary>
/// <param name="request">Request info</param>
/// <param name="nextPageToken">The pagination request from the previous request result <see cref="HttpResult{T}.NextPageRequest"/> property to continue pagination</param>
/// <param name="ct">Cancellation token</param>
new Task<HttpResult<SharedUserTrade[]>> GetSpotUserTradeHistoryAsync(GetUserTradesRequest request, PageRequest? nextPageToken = null, CancellationToken ct = default); new Task<HttpResult<SharedUserTrade[]>> GetSpotUserTradeHistoryAsync(GetUserTradesRequest request, PageRequest? nextPageToken = null, CancellationToken ct = default);
} }
} }
@@ -8,7 +8,7 @@ using System.Threading.Tasks;
namespace CryptoExchange.Net.SharedApis namespace CryptoExchange.Net.SharedApis
{ {
/// <summary> /// <summary>
/// Request definition for retrieving withdrawal history from an exchange /// Operation for retrieving withdrawal history from an exchange.
/// </summary> /// </summary>
public interface IGetWithdrawalHistory : ISharedApiCapability public interface IGetWithdrawalHistory : ISharedApiCapability
{ {
@@ -31,19 +31,11 @@ namespace CryptoExchange.Net.SharedApis
} }
/// <summary> /// <summary>
/// Request definition for retrieving withdrawal history from an exchange /// Operation for retrieving withdrawal history from an exchange via the REST API.
/// </summary> /// </summary>
public interface IGetWithdrawalHistoryRest : IGetWithdrawalHistory, ISharedRest public interface IGetWithdrawalHistoryRest : IGetWithdrawalHistory, ISharedRest
{ {
/// <inheritdoc />
/// <summary>
/// Get withdrawal records, see <see cref="GetWithdrawalHistoryOptions"/> for request options and exchange specific required/optional parameters. <br />
/// The result is paginated, if there are more results to be retrieved, the <see cref="HttpResult{T}.NextPageRequest"/> property of the result will contain the pagination request to be used for the next request to continue pagination.
/// </summary>
/// <param name="request">Request info</param>
/// <param name="nextPageToken">The pagination request from the previous request result <see cref="HttpResult{T}.NextPageRequest"/> property to continue pagination</param>
/// <param name="ct">Cancellation token</param>
/// <returns></returns>
new Task<HttpResult<SharedWithdrawal[]>> GetWithdrawalHistoryAsync(GetWithdrawalsRequest request, PageRequest? nextPageToken = null, CancellationToken ct = default); new Task<HttpResult<SharedWithdrawal[]>> GetWithdrawalHistoryAsync(GetWithdrawalsRequest request, PageRequest? nextPageToken = null, CancellationToken ct = default);
} }
} }
@@ -8,7 +8,7 @@ using System.Threading.Tasks;
namespace CryptoExchange.Net.SharedApis namespace CryptoExchange.Net.SharedApis
{ {
/// <summary> /// <summary>
/// Request definition for withdrawing a specific asset from an exchange. /// Operation for withdrawing a specific asset from an exchange.
/// </summary> /// </summary>
public interface IWithdraw : ISharedApiCapability public interface IWithdraw : ISharedApiCapability
{ {
@@ -29,17 +29,11 @@ namespace CryptoExchange.Net.SharedApis
} }
/// <summary> /// <summary>
/// Request definition for withdrawing a specific asset from an exchange. /// Operation for withdrawing a specific asset from an exchange via the REST API.
/// </summary> /// </summary>
public interface IWithdrawRest : IWithdraw, ISharedRest public interface IWithdrawRest : IWithdraw, ISharedRest
{ {
/// <inheritdoc />
/// <summary>
/// Request a withdrawal, see <see cref="WithdrawOptions"/> for request options and exchange specific required/optional parameters. <br />
/// </summary>
/// <param name="request">Request info</param>
/// <param name="ct">Cancellation token</param>
/// <returns></returns>
new Task<HttpResult<SharedId>> WithdrawAsync(WithdrawRequest request, CancellationToken ct = default); new Task<HttpResult<SharedId>> WithdrawAsync(WithdrawRequest request, CancellationToken ct = default);
} }
} }