1
0
mirror of https://github.com/JKorf/CryptoExchange.Net.git synced 2026-10-13 22:51:39 +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
{
/// <summary>
/// Endpoint definition for retrieving all assets supported on an exchange.
/// Operation for retrieving all assets supported on an exchange.
/// </summary>
public interface IGetAllAssets : ISharedApiCapability
{
@@ -28,16 +28,11 @@ namespace CryptoExchange.Net.SharedApis
}
/// <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>
public interface IGetAllAssetsRest : IGetAllAssets, ISharedRest
{
/// <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>
/// <inheritdoc />
new Task<HttpResult<SharedAsset[]>> GetAllAssetsAsync(GetAssetsRequest request, CancellationToken ct = default);
}
}
@@ -8,7 +8,7 @@ using System.Threading.Tasks;
namespace CryptoExchange.Net.SharedApis
{
/// <summary>
/// Endpoint definition for retrieving an asset on an exchange.
/// Operation for retrieving asset info from an exchange.
/// </summary>
public interface IGetAsset : ISharedApiCapability
{
@@ -28,15 +28,11 @@ namespace CryptoExchange.Net.SharedApis
}
/// <summary>
/// Endpoint definition for retrieving an asset on an exchange.
/// Operation for retrieving asset info from an exchange via the REST API.
/// </summary>
public interface IGetAssetRest : IGetAsset, ISharedRest
{
/// <summary>
/// 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>
/// <inheritdoc />
new Task<HttpResult<SharedAsset>> GetAssetAsync(GetAssetRequest request, CancellationToken ct = default);
}
}
@@ -8,7 +8,7 @@ using System.Threading.Tasks;
namespace CryptoExchange.Net.SharedApis
{
/// <summary>
/// Endpoint definition for retrieving user asset balances on an exchange.
/// Operation for retrieving user asset balances from an exchange.
/// </summary>
public interface IGetBalances : ISharedApiCapability
{
@@ -29,16 +29,11 @@ namespace CryptoExchange.Net.SharedApis
}
/// <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>
public interface IGetBalancesRest : IGetBalances, ISharedRest
{
/// <summary>
/// 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>
/// <inheritdoc />
new Task<HttpResult<SharedBalance[]>> GetBalancesAsync(GetBalancesRequest request, CancellationToken ct = default);
}
}
@@ -7,7 +7,7 @@ using System.Threading.Tasks;
namespace CryptoExchange.Net.SharedApis
{
/// <summary>
/// Client for subscribing to user balance updates
/// Operation for subscribing to user balance updates
/// </summary>
public interface ISubscribeBalancesSocket : ISharedSubscription
{
@@ -8,7 +8,7 @@ using System.Threading.Tasks;
namespace CryptoExchange.Net.SharedApis
{
/// <summary>
/// Endpoint definition for retrieving user deposit addresses on an exchange.
/// Operation for retrieving user deposit addresses for an exchange.
/// </summary>
public interface IGetDepositAddresses : ISharedApiCapability
{
@@ -29,16 +29,11 @@ namespace CryptoExchange.Net.SharedApis
}
/// <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>
public interface IGetDepositAddressesRest : IGetDepositAddresses, ISharedRest
{
/// <summary>
/// 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>
/// <inheritdoc />
new Task<HttpResult<SharedDepositAddress[]>> GetDepositAddressesAsync(GetDepositAddressesRequest request, CancellationToken ct = default);
}
}
@@ -8,7 +8,7 @@ using System.Threading.Tasks;
namespace CryptoExchange.Net.SharedApis
{
/// <summary>
/// Endpoint definition for retrieving user deposit history on an exchange.
/// Operation for retrieving user deposit history from an exchange.
/// </summary>
public interface IGetDepositHistory : ISharedApiCapability
{
@@ -31,18 +31,11 @@ namespace CryptoExchange.Net.SharedApis
}
/// <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>
public interface IGetDepositHistoryRest : IGetDepositHistory, ISharedRest
{
/// <summary>
/// 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>
/// <inheritdoc />
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
{
/// <summary>
/// Endpoint definition for retrieving user trading fees on an exchange.
/// Operation for retrieving user trading fees from an exchange.
/// </summary>
public interface IGetFees : ISharedApiCapability
{
@@ -28,15 +28,11 @@ namespace CryptoExchange.Net.SharedApis
}
/// <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>
public interface IGetFeesRest : IGetFees, ISharedRest
{
/// <summary>
/// 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>
/// <inheritdoc />
new Task<HttpResult<SharedFee>> GetFeesAsync(GetFeeRequest request, CancellationToken ct = default);
}
}
@@ -8,7 +8,7 @@ using System.Threading.Tasks;
namespace CryptoExchange.Net.SharedApis
{
/// <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>
public interface IGetFundingRateHistory : ISharedApiCapability
{
@@ -27,19 +27,13 @@ namespace CryptoExchange.Net.SharedApis
/// <param name="ct">Cancellation token</param>
Task<ICallResult<SharedFundingRate[]>> GetFundingRateHistoryAsync(GetFundingRateHistoryRequest request, PageRequest? nextPageToken = null, CancellationToken ct = default);
}
/// <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>
public interface IGetFundingRateHistoryRest : IGetFundingRateHistory, ISharedRest
{
/// <summary>
/// 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>
/// <inheritdoc />
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
{
/// <summary>
/// A shared/common client interface
/// Shared API
/// </summary>
public interface ISharedApi
{
@@ -5,7 +5,7 @@ using System.Text;
namespace CryptoExchange.Net.SharedApis
{
/// <summary>
/// Interface for a shared API capability
/// Shared API capability
/// </summary>
public interface ISharedApiCapability : ISharedApi
{
@@ -5,7 +5,7 @@ using System.Text;
namespace CryptoExchange.Net.SharedApis
{
/// <summary>
/// Interface for a shared API endpoint
/// Shared REST API capabitlity
/// </summary>
public interface ISharedRest : ISharedApiCapability
{
@@ -5,7 +5,7 @@ using System.Text;
namespace CryptoExchange.Net.SharedApis
{
/// <summary>
/// Interface for a shared socket operation
/// Shared WebSocket API capabitlity
/// </summary>
public interface ISharedSocket : ISharedApiCapability
{
@@ -5,7 +5,7 @@ using System.Text;
namespace CryptoExchange.Net.SharedApis
{
/// <summary>
/// Identifies a fine-grained Shared API subscription capability.
/// Shared WebSocket API subscription capabitlity
/// </summary>
public interface ISharedSubscription : ISharedSocket
{
@@ -8,7 +8,7 @@ using System.Threading.Tasks;
namespace CryptoExchange.Net.SharedApis
{
/// <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>
public interface IGetIndexPriceKlines : ISharedApiCapability
{
@@ -29,17 +29,11 @@ namespace CryptoExchange.Net.SharedApis
}
/// <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>
public interface IGetIndexPriceKlinesRest : IGetIndexPriceKlines, ISharedRest
{
/// <summary>
/// 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>
/// <inheritdoc />
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
{
/// <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>
public interface IGetMarkPriceKlines : ISharedApiCapability
{
@@ -29,17 +29,11 @@ namespace CryptoExchange.Net.SharedApis
}
/// <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>
public interface IGetMarkPriceKlinesRest : IGetMarkPriceKlines, ISharedRest
{
/// <summary>
/// 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>
/// <inheritdoc />
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
{
/// <summary>
/// Request definition for getting kline/candlestick data from an exchange.
/// Operation for getting kline/candlestick data from an exchange.
/// </summary>
public interface IGetKlines : ISharedApiCapability
{
@@ -31,18 +31,11 @@ namespace CryptoExchange.Net.SharedApis
}
/// <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>
public interface IGetKlinesRest : IGetKlines, ISharedRest
{
/// <summary>
/// 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>
/// <inheritdoc />
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
{
/// <summary>
/// Client for subscribing to kline/candlestick updates for a symbol
/// Operation for subscribing to kline/candlestick updates for a symbol
/// </summary>
public interface ISubscribeKlinesSocket : ISharedSubscription
{
@@ -8,7 +8,7 @@ using System.Threading.Tasks;
namespace CryptoExchange.Net.SharedApis
{
/// <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>
public interface IGetLeverage : ISharedApiCapability
{
@@ -27,15 +27,11 @@ namespace CryptoExchange.Net.SharedApis
}
/// <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>
public interface IGetLeverageRest : IGetLeverage, ISharedRest
{
/// <summary>
/// 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>
/// <inheritdoc />
new Task<HttpResult<SharedLeverage>> GetLeverageAsync(GetLeverageRequest request, CancellationToken ct = default);
}
}
@@ -8,7 +8,7 @@ using System.Threading.Tasks;
namespace CryptoExchange.Net.SharedApis
{
/// <summary>
/// Endpoint definition for setting leverage on an exchange.
/// Operation for setting leverage on an exchange.
/// </summary>
public interface ISetLeverage : ISharedApiCapability
{
@@ -32,15 +32,11 @@ namespace CryptoExchange.Net.SharedApis
}
/// <summary>
/// Endpoint definition for setting leverage on an exchange.
/// Operation for setting leverage on an exchange via the REST API.
/// </summary>
public interface ISetLeverageRest : ISetLeverage, ISharedRest
{
/// <summary>
/// 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>
/// <inheritdoc />
new Task<HttpResult<SharedLeverage>> SetLeverageAsync(SetLeverageRequest request, CancellationToken ct = default);
}
}
@@ -8,7 +8,7 @@ using System.Threading.Tasks;
namespace CryptoExchange.Net.SharedApis
{
/// <summary>
/// Endpoint definition for retrieving open interest data from an exchange
/// Operation for retrieving open interest data from an exchange.
/// </summary>
public interface IGetOpenInterest : ISharedApiCapability
{
@@ -27,15 +27,11 @@ namespace CryptoExchange.Net.SharedApis
}
/// <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>
public interface IGetOpenInterestRest : IGetOpenInterest, ISharedRest
{
/// <summary>
/// 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>
/// <inheritdoc />
new Task<HttpResult<SharedOpenInterest>> GetOpenInterestAsync(GetOpenInterestRequest request, CancellationToken ct = default);
}
}
@@ -8,7 +8,7 @@ using System.Threading.Tasks;
namespace CryptoExchange.Net.SharedApis
{
/// <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>
public interface IGetBookTicker : ISharedApiCapability
{
@@ -29,16 +29,11 @@ namespace CryptoExchange.Net.SharedApis
}
/// <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>
public interface IGetBookTickerRest : IGetBookTicker, ISharedRest
{
/// <summary>
/// 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>
/// <inheritdoc />
new Task<HttpResult<SharedBookTicker>> GetBookTickerAsync(GetBookTickerRequest request, CancellationToken ct = default);
}
}
@@ -8,7 +8,7 @@ using System.Threading.Tasks;
namespace CryptoExchange.Net.SharedApis
{
/// <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>
public interface IGetOrderBook : ISharedApiCapability
{
@@ -29,16 +29,11 @@ namespace CryptoExchange.Net.SharedApis
}
/// <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>
public interface IGetOrderBookRest : IGetOrderBook, ISharedRest
{
/// <summary>
/// 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>
/// <inheritdoc />
new Task<HttpResult<SharedOrderBook>> GetOrderBookAsync(GetOrderBookRequest request, CancellationToken ct = default);
}
}
@@ -7,7 +7,7 @@ using System.Threading.Tasks;
namespace CryptoExchange.Net.SharedApis
{
/// <summary>
/// Client for subscribing to incremental order book updates for a symbol
/// Operation for subscribing to incremental order book updates for a symbol
/// </summary>
public interface ISubscribeIncrementalOrderBookSocket : ISharedSubscription
{
@@ -7,7 +7,7 @@ using System.Threading.Tasks;
namespace CryptoExchange.Net.SharedApis
{
/// <summary>
/// Client for subscribing to order book snapshot updates for a symbol
/// Operation for subscribing to order book snapshot updates for a symbol
/// </summary>
public interface ISubscribeOrderBookSocket : ISharedSubscription
{
@@ -8,7 +8,7 @@ using System.Threading.Tasks;
namespace CryptoExchange.Net.SharedApis
{
/// <summary>
/// Endpoint definition for canceling a futures order on an exchange.
/// Operation for canceling an open futures order on an exchange.
/// </summary>
public interface ICancelFuturesOrder : ISharedApiCapability
{
@@ -27,29 +27,21 @@ namespace CryptoExchange.Net.SharedApis
}
/// <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>
public interface ICancelFuturesOrderRest : ICancelFuturesOrder, ISharedRest
{
/// <summary>
/// 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>
/// <inheritdoc />
new Task<HttpResult<SharedId>> CancelFuturesOrderAsync(CancelOrderRequest request, CancellationToken ct = default);
}
/// <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>
public interface ICancelFuturesOrderSocket : ICancelFuturesOrder, ISharedSocket
{
/// <summary>
/// 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>
/// <inheritdoc />
new Task<QueryResult<SharedId>> CancelFuturesOrderAsync(CancelOrderRequest request, CancellationToken ct = default);
}
@@ -8,7 +8,7 @@ using System.Threading.Tasks;
namespace CryptoExchange.Net.SharedApis
{
/// <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>
public interface ICancelFuturesOrderByClientOrderId : ISharedApiCapability
{
@@ -27,28 +27,20 @@ namespace CryptoExchange.Net.SharedApis
}
/// <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>
public interface ICancelFuturesOrderByClientOrderIdRest : ICancelFuturesOrderByClientOrderId, ISharedRest
{
/// <summary>
/// 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>
/// <inheritdoc />
new Task<HttpResult<SharedId>> CancelFuturesOrderByClientOrderIdAsync(CancelOrderRequest request, CancellationToken ct = default);
}
/// <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>
public interface ICancelFuturesOrderByClientOrderIdSocket : ICancelFuturesOrderByClientOrderId, ISharedSocket
{
/// <summary>
/// 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>
/// <inheritdoc />
new Task<QueryResult<SharedId>> CancelFuturesOrderByClientOrderIdAsync(CancelOrderRequest request, CancellationToken ct = default);
}
}
@@ -8,7 +8,7 @@ using System.Threading.Tasks;
namespace CryptoExchange.Net.SharedApis
{
/// <summary>
/// Endpoint definition for retrieving closed futures orders on an exchange.
/// Operation for retrieving closed futures orders on an exchange.
/// </summary>
public interface IGetClosedFuturesOrders : ISharedApiCapability
{
@@ -29,17 +29,11 @@ namespace CryptoExchange.Net.SharedApis
}
/// <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>
public interface IGetClosedFuturesOrdersRest : IGetClosedFuturesOrders, ISharedRest
{
/// <summary>
/// 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>
/// <inheritdoc />
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
{
/// <summary>
/// Endpoint definition for retrieving a futures order on an exchange.
/// Operation for retrieving a futures order from an exchange.
/// </summary>
public interface IGetFuturesOrder : ISharedApiCapability
{
@@ -27,15 +27,11 @@ namespace CryptoExchange.Net.SharedApis
}
/// <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>
public interface IGetFuturesOrderRest : IGetFuturesOrder, ISharedRest
{
/// <summary>
/// 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>
/// <inheritdoc />
new Task<HttpResult<SharedFuturesOrder>> GetFuturesOrderAsync(GetOrderRequest request, CancellationToken ct = default);
}
}
@@ -32,11 +32,7 @@ namespace CryptoExchange.Net.SharedApis
/// </summary>
public interface IGetFuturesOrderByClientOrderIdRest : IGetFuturesOrderByClientOrderId, ISharedRest
{
/// <summary>
/// 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>
/// <inheritdoc />
new Task<HttpResult<SharedFuturesOrder>> GetFuturesOrderByClientOrderIdAsync(GetOrderRequest request, CancellationToken ct = default);
}
}
@@ -8,7 +8,7 @@ using System.Threading.Tasks;
namespace CryptoExchange.Net.SharedApis
{
/// <summary>
/// Endpoint definition for retrieving open futures orders on an exchange.
/// Operation for retrieving open futures orders from an exchange.
/// </summary>
public interface IGetOpenFuturesOrders : ISharedApiCapability
{
@@ -27,15 +27,11 @@ namespace CryptoExchange.Net.SharedApis
}
/// <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>
public interface IGetOpenFuturesOrdersRest : IGetOpenFuturesOrders, ISharedRest
{
/// <summary>
/// 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>
/// <inheritdoc />
new Task<HttpResult<SharedFuturesOrder[]>> GetOpenFuturesOrdersAsync(GetOpenOrdersRequest request, CancellationToken ct = default);
}
}
@@ -8,7 +8,7 @@ using System.Threading.Tasks;
namespace CryptoExchange.Net.SharedApis
{
/// <summary>
/// Endpoint definition for placing a futures order on an exchange.
/// Operation for placing a futures order on an exchange.
/// </summary>
public interface IPlaceFuturesOrder : ISharedApiCapability
{
@@ -55,28 +55,20 @@ namespace CryptoExchange.Net.SharedApis
}
/// <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>
public interface IPlaceFuturesOrderRest : IPlaceFuturesOrder, ISharedRest
{
/// <summary>
/// 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>
/// <inheritdoc />
new Task<HttpResult<SharedId>> PlaceFuturesOrderAsync(PlaceFuturesOrderRequest request, CancellationToken ct = default);
}
/// <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>
public interface IPlaceFuturesOrderSocket : IPlaceFuturesOrder, ISharedSocket
{
/// <summary>
/// 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>
/// <inheritdoc />
new Task<QueryResult<SharedId>> PlaceFuturesOrderAsync(PlaceFuturesOrderRequest request, CancellationToken ct = default);
}
}
@@ -7,7 +7,7 @@ using CryptoExchange.Net.Objects;
namespace CryptoExchange.Net.SharedApis
{
/// <summary>
/// Client for subscribing to position updates
/// Operation for subscribing to position updates
/// </summary>
public interface ISubscribePositionsSocket : ISharedSubscription
{
@@ -8,7 +8,7 @@ using System.Threading.Tasks;
namespace CryptoExchange.Net.SharedApis
{
/// <summary>
/// Request definition for canceling a spot order on an exchange.
/// Operation for canceling a spot order on an exchange.
/// </summary>
public interface ICancelSpotOrder : ISharedApiCapability
{
@@ -27,28 +27,20 @@ namespace CryptoExchange.Net.SharedApis
}
/// <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>
public interface ICancelSpotOrderRest : ICancelSpotOrder, ISharedRest
{
/// <summary>
/// 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>
/// <inheritdoc />
new Task<HttpResult<SharedId>> CancelSpotOrderAsync(CancelOrderRequest request, CancellationToken ct = default);
}
/// <summary>
/// Client for placing and managing spot orders
/// Operation for canceling a spot order on an exchange via the WebSocket API.
/// </summary>
public interface ICancelSpotOrderSocket : ICancelSpotOrder, ISharedSocket
{
/// <summary>
/// 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>
/// <inheritdoc />
new Task<QueryResult<SharedId>> CancelSpotOrderAsync(CancelOrderRequest request, CancellationToken ct = default);
}
@@ -8,7 +8,7 @@ using System.Threading.Tasks;
namespace CryptoExchange.Net.SharedApis
{
/// <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>
public interface ICancelSpotOrderByClientOrderId: ISharedApiCapability
{
@@ -27,28 +27,20 @@ namespace CryptoExchange.Net.SharedApis
}
/// <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>
public interface ICancelSpotOrderByClientOrderIdRest : ICancelSpotOrderByClientOrderId, ISharedRest
{
/// <summary>
/// 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>
/// <inheritdoc />
new Task<HttpResult<SharedId>> CancelSpotOrderByClientOrderIdAsync(CancelOrderRequest request, CancellationToken ct = default);
}
/// <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>
public interface ICancelSpotOrderByClientOrderIdSocket : ICancelSpotOrderByClientOrderId, ISharedSocket
{
/// <summary>
/// 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>
/// <inheritdoc />
new Task<QueryResult<SharedId>> CancelSpotOrderByClientOrderIdAsync(CancelOrderRequest request, CancellationToken ct = default);
}
}
@@ -8,7 +8,7 @@ using System.Threading.Tasks;
namespace CryptoExchange.Net.SharedApis
{
/// <summary>
/// Request definition for retrieving closed spot orders from an exchange.
/// Operation for retrieving closed spot orders from an exchange.
/// </summary>
public interface IGetClosedSpotOrders : ISharedApiCapability
{
@@ -29,17 +29,11 @@ namespace CryptoExchange.Net.SharedApis
}
/// <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>
public interface IGetClosedSpotOrdersRest : IGetClosedSpotOrders, ISharedRest
{
/// <summary>
/// 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>
/// <inheritdoc />
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
{
/// <summary>
/// Request definition for retrieving open spot order from an exchange.
/// Operation for retrieving open spot orders from an exchange.
/// </summary>
public interface IGetOpenSpotOrders : ISharedApiCapability
{
@@ -27,15 +27,11 @@ namespace CryptoExchange.Net.SharedApis
}
/// <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>
public interface IGetOpenSpotOrdersRest : IGetOpenSpotOrders, ISharedRest
{
/// <summary>
/// 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>
/// <inheritdoc />
new Task<HttpResult<SharedSpotOrder[]>> GetOpenSpotOrdersAsync(GetOpenOrdersRequest request, CancellationToken ct = default);
}
}
@@ -8,7 +8,7 @@ using System.Threading.Tasks;
namespace CryptoExchange.Net.SharedApis
{
/// <summary>
/// Request definition for retrieving a spot order from an exchange.
/// Operation for retrieving a spot order from an exchange.
/// </summary>
public interface IGetSpotOrder : ISharedApiCapability
{
@@ -27,15 +27,11 @@ namespace CryptoExchange.Net.SharedApis
}
/// <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>
public interface IGetSpotOrderRest : IGetSpotOrder, ISharedRest
{
/// <summary>
/// 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>
/// <inheritdoc />
new Task<HttpResult<SharedSpotOrder>> GetSpotOrderAsync(GetOrderRequest request, CancellationToken ct = default);
}
}
@@ -8,7 +8,7 @@ using System.Threading.Tasks;
namespace CryptoExchange.Net.SharedApis
{
/// <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>
public interface IGetSpotOrderByClientOrderId : ISharedApiCapability
{
@@ -29,15 +29,11 @@ namespace CryptoExchange.Net.SharedApis
}
/// <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>
public interface IGetSpotOrderByClientOrderIdRest : IGetSpotOrderByClientOrderId, ISharedRest
{
/// <summary>
/// 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>
/// <inheritdoc />
new Task<HttpResult<SharedSpotOrder>> GetSpotOrderByClientOrderIdAsync(GetOrderRequest request, CancellationToken ct = default);
}
@@ -7,6 +7,9 @@ using System.Threading.Tasks;
namespace CryptoExchange.Net.SharedApis
{
/// <summary>
/// Operation for placing a spot order on an exchange.
/// </summary>
public interface IPlaceSpotOrder : ISharedApiCapability
{
/// <summary>
@@ -42,35 +45,32 @@ namespace CryptoExchange.Net.SharedApis
/// Exchange specific parameters can be added to the request via the `ExchangeParameters` property of the request object.
/// </summary>
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(
PlaceSpotOrderRequest request,
CancellationToken ct = default);
}
/// <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>
public interface IPlaceSpotOrderRest : IPlaceSpotOrder, ISharedRest
{
/// <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>
/// <inheritdoc />
new Task<HttpResult<SharedId>> PlaceSpotOrderAsync(PlaceSpotOrderRequest request, CancellationToken ct = default);
}
/// <summary>
/// Client for placing and managing spot orders
/// Operation for placing a spot order on an exchange via the WebSocket API.
/// </summary>
public interface IPlaceSpotOrderSocket : IPlaceSpotOrder, ISharedSocket
{
/// <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>
/// <inheritdoc />
new Task<QueryResult<SharedId>> PlaceSpotOrderAsync(PlaceSpotOrderRequest request, CancellationToken ct = default);
}
}
@@ -7,7 +7,7 @@ using System.Threading.Tasks;
namespace CryptoExchange.Net.SharedApis
{
/// <summary>
/// Client for subscribing to user spot order updates
/// Operation for subscribing to user spot order updates
/// </summary>
public interface ISubscribeSpotOrdersSocket : ISharedSubscription
{
@@ -8,7 +8,7 @@ using System.Threading.Tasks;
namespace CryptoExchange.Net.SharedApis
{
/// <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>
public interface IGetPositionMode : ISharedApiCapability
{
@@ -27,15 +27,11 @@ namespace CryptoExchange.Net.SharedApis
}
/// <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>
public interface IGetPositionModeRest : IGetPositionMode, ISharedRest
{
/// <summary>
/// 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>
/// <inheritdoc />
new Task<HttpResult<SharedPositionModeResult>> GetPositionModeAsync(GetPositionModeRequest request, CancellationToken ct = default);
}
}
@@ -8,7 +8,7 @@ using System.Threading.Tasks;
namespace CryptoExchange.Net.SharedApis
{
/// <summary>
/// Endpoint definition for setting the user position mode on an exchange.
/// Operation for setting the user position mode on an exchange.
/// </summary>
public interface ISetPositionMode : ISharedApiCapability
{
@@ -32,15 +32,11 @@ namespace CryptoExchange.Net.SharedApis
}
/// <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>
public interface ISetPositionModeRest : ISetPositionMode, ISharedRest
{
/// <summary>
/// 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>
/// <inheritdoc />
new Task<HttpResult<SharedPositionModeResult>> SetPositionModeAsync(SetPositionModeRequest request, CancellationToken ct = default);
}
}
@@ -8,7 +8,7 @@ using System.Threading.Tasks;
namespace CryptoExchange.Net.SharedApis
{
/// <summary>
/// Request definition for closing a position on an exchange.
/// Operation for closing an open position on an exchange.
/// </summary>
public interface IClosePosition : ISharedApiCapability
{
@@ -28,16 +28,11 @@ namespace CryptoExchange.Net.SharedApis
}
/// <summary>
/// Request definition for closing a position on an exchange.
/// Operation for closing an open position on an exchange via the REST API.
/// </summary>
public interface IClosePositionRest : IClosePosition, ISharedRest
{
/// <summary>
/// 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>
/// <inheritdoc />
new Task<HttpResult<SharedId>> ClosePositionAsync(ClosePositionRequest request, CancellationToken ct = default);
}
}
@@ -8,7 +8,7 @@ using System.Threading.Tasks;
namespace CryptoExchange.Net.SharedApis
{
/// <summary>
/// Request definition for retrieving position history from an exchange.
/// Operation for retrieving position history from an exchange.
/// </summary>
public interface IGetPositionHistory : ISharedApiCapability
{
@@ -29,17 +29,11 @@ namespace CryptoExchange.Net.SharedApis
}
/// <summary>
/// Request definition for retrieving position history from an exchange.
/// Operation for retrieving position history from an exchange via the REST API.
/// </summary>
public interface IGetPositionHistoryRest : IGetPositionHistory, ISharedRest
{
/// <summary>
/// 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>
/// <inheritdoc />
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
{
/// <summary>
/// Request definition for retrieving open positions from an exchange.
/// Operation for retrieving open positions from an exchange.
/// </summary>
public interface IGetPositions : ISharedApiCapability
{
@@ -27,15 +27,11 @@ namespace CryptoExchange.Net.SharedApis
}
/// <summary>
/// Request definition for retrieving open positions from an exchange.
/// Operation for retrieving open positions from an exchange via the REST API.
/// </summary>
public interface IGetPositionsRest : IGetPositions, ISharedRest
{
/// <summary>
/// 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>
/// <inheritdoc />
new Task<HttpResult<SharedPosition[]>> GetPositionsAsync(GetPositionsRequest request, CancellationToken ct = default);
}
}
@@ -8,7 +8,7 @@ using System.Threading.Tasks;
namespace CryptoExchange.Net.SharedApis
{
/// <summary>
/// Request definition for getting futures symbols from an exchange
/// Operation for getting supported futures symbols from an exchange.
/// </summary>
public interface IGetFuturesSymbols : ISharedApiCapability
{
@@ -51,15 +51,11 @@ namespace CryptoExchange.Net.SharedApis
}
/// <summary>
/// Request definition for getting futures symbols from an exchange
/// Operation for getting supported futures symbols from an exchange via the REST API.
/// </summary>
public interface IGetFuturesSymbolsRest : IGetFuturesSymbols, ISharedRest
{
/// <summary>
/// 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>
/// <inheritdoc />
new Task<HttpResult<SharedFuturesSymbol[]>> GetFuturesSymbolsAsync(GetSymbolsRequest request, CancellationToken ct = default);
}
}
@@ -8,7 +8,7 @@ using System.Threading.Tasks;
namespace CryptoExchange.Net.SharedApis
{
/// <summary>
/// Request definition for retrieving spot symbols from an exchange.
/// Operation for getting supported spot symbols from an exchange.
/// </summary>
public interface IGetSpotSymbols: ISharedApiCapability
{
@@ -51,16 +51,11 @@ namespace CryptoExchange.Net.SharedApis
}
/// <summary>
/// Request definition for retrieving spot symbols from an exchange.
/// Operation for getting supported futures symbols from an exchange via the REST API.
/// </summary>
public interface IGetSpotSymbolsRest : IGetSpotSymbols, ISharedRest
{
/// <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>
/// <inheritdoc />
new Task<HttpResult<SharedSpotSymbol[]>> GetSpotSymbolsAsync(GetSymbolsRequest request, CancellationToken ct = default);
}
}
@@ -8,7 +8,7 @@ using System.Threading.Tasks;
namespace CryptoExchange.Net.SharedApis
{
/// <summary>
/// Request definition for retrieving all futures tickers from an exchange.
/// Operation for retrieving all futures tickers from an exchange.
/// </summary>
public interface IGetAllFuturesTickers : ISharedApiCapability
{
@@ -27,15 +27,11 @@ namespace CryptoExchange.Net.SharedApis
}
/// <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>
public interface IGetAllFuturesTickersRest : IGetAllFuturesTickers
{
/// <summary>
/// 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>
/// <inheritdoc />
new Task<HttpResult<SharedFuturesTicker[]>> GetAllFuturesTickersAsync(GetTickersRequest request, CancellationToken ct = default);
}
}
@@ -8,7 +8,7 @@ using System.Threading.Tasks;
namespace CryptoExchange.Net.SharedApis
{
/// <summary>
/// Request definition for retrieving a futures ticker from an exchange.
/// Operation for retrieving a single futures ticker from an exchange.
/// </summary>
public interface IGetFuturesTicker : ISharedApiCapability
{
@@ -27,15 +27,11 @@ namespace CryptoExchange.Net.SharedApis
}
/// <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>
public interface IGetFuturesTickerRest : IGetFuturesTicker, ISharedRest
{
/// <summary>
/// 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>
/// <inheritdoc />
new Task<HttpResult<SharedFuturesTicker>> GetFuturesTickerAsync(GetTickerRequest request, CancellationToken ct = default);
}
}
@@ -7,7 +7,7 @@ using System.Threading.Tasks;
namespace CryptoExchange.Net.SharedApis
{
/// <summary>
/// Client for subscribing to ticker updates for all symbols
/// Operation for subscribing to ticker updates for all symbols
/// </summary>
public interface ISubscribeAllTickersSocket : ISharedSubscription
{
@@ -7,7 +7,7 @@ using System.Threading.Tasks;
namespace CryptoExchange.Net.SharedApis
{
/// <summary>
/// Client for subscribing to book ticker updates for a symbol
/// Operation for subscribing to book ticker updates for a symbol
/// </summary>
public interface ISubscribeBookTickerSocket : ISharedSubscription
{
@@ -7,7 +7,7 @@ using System.Threading.Tasks;
namespace CryptoExchange.Net.SharedApis
{
/// <summary>
/// Client for subscribing to ticker updates for a symbol
/// Operation for subscribing to ticker updates for a symbol
/// </summary>
public interface ISubscribeTickerSocket : ISharedSubscription
{
@@ -8,7 +8,7 @@ using System.Threading.Tasks;
namespace CryptoExchange.Net.SharedApis
{
/// <summary>
/// Request definition for retrieving all spot tickers from an exchange.
/// Operation for retrieving all spot tickers from an exchange.
/// </summary>
public interface IGetAllSpotTickers : ISharedApiCapability
{
@@ -27,15 +27,11 @@ namespace CryptoExchange.Net.SharedApis
}
/// <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>
public interface IGetAllSpotTickersRest : IGetAllSpotTickers, ISharedRest
{
/// <summary>
/// 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>
/// <inheritdoc />
new Task<HttpResult<SharedSpotTicker[]>> GetAllSpotTickersAsync(GetTickersRequest request, CancellationToken ct = default);
}
}
@@ -8,7 +8,7 @@ using System.Threading.Tasks;
namespace CryptoExchange.Net.SharedApis
{
/// <summary>
/// Request definition for getting spot ticker info from an exchange.
/// Operation for retrieving a single spot ticker from an exchange.
/// </summary>
public interface IGetSpotTicker : ISharedApiCapability
{
@@ -27,15 +27,11 @@ namespace CryptoExchange.Net.SharedApis
}
/// <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>
public interface IGetSpotTickerRest : IGetSpotTicker, ISharedRest
{
/// <summary>
/// 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>
/// <inheritdoc />
new Task<HttpResult<SharedSpotTicker>> GetSpotTickerAsync(GetTickerRequest request, CancellationToken ct = default);
}
}
@@ -8,7 +8,7 @@ using System.Threading.Tasks;
namespace CryptoExchange.Net.SharedApis
{
/// <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>
public interface ICancelFuturesTpSl : ISharedApiCapability
{
@@ -28,16 +28,11 @@ namespace CryptoExchange.Net.SharedApis
}
/// <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>
public interface ICancelFuturesTpSlRest : ICancelFuturesTpSl, ISharedRest
{
/// <summary>
/// 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>
/// <inheritdoc />
new Task<HttpResult<bool>> CancelFuturesTpSlAsync(CancelTpSlRequest request, CancellationToken ct = default);
}
}
@@ -8,7 +8,7 @@ using System.Threading.Tasks;
namespace CryptoExchange.Net.SharedApis
{
/// <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>
public interface ISetFuturesTpSl : ISharedApiCapability
{
@@ -28,16 +28,11 @@ namespace CryptoExchange.Net.SharedApis
}
/// <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>
public interface ISetFuturesTpSlRest : ISetFuturesTpSl, ISharedRest
{
/// <summary>
/// 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>
/// <inheritdoc />
new Task<HttpResult<SharedId>> SetFuturesTpSlAsync(SetTpSlRequest request, CancellationToken ct = default);
}
}
@@ -8,7 +8,7 @@ using System.Threading.Tasks;
namespace CryptoExchange.Net.SharedApis
{
/// <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>
public interface IGetRecentTrades : ISharedApiCapability
{
@@ -29,17 +29,11 @@ namespace CryptoExchange.Net.SharedApis
}
/// <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>
public interface IGetRecentTradesRest : IGetRecentTrades, ISharedRest
{
/// <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>
/// <inheritdoc />
new Task<HttpResult<SharedTrade[]>> GetRecentTradesAsync(GetRecentTradesRequest request, CancellationToken ct = default);
}
}
@@ -8,7 +8,7 @@ using System.Threading.Tasks;
namespace CryptoExchange.Net.SharedApis
{
/// <summary>
/// Request definition for retrieving trade history from an exchange.
/// Operation for retrieving trade history from an exchange.
/// </summary>
public interface IGetTradeHistory : ISharedApiCapability
{
@@ -31,19 +31,11 @@ namespace CryptoExchange.Net.SharedApis
}
/// <summary>
/// Request definition for retrieving trade history from an exchange.
/// Operation for retrieving trade history from an exchange via the REST API.
/// </summary>
public interface IGetTradeHistoryRest : ISharedRest
public interface IGetTradeHistoryRest : IGetTradeHistory, ISharedRest
{
/// <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>
/// <inheritdoc />
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
{
/// <summary>
/// Request definition for transferring funds between account types on an exchange.
/// Operation for transferring funds between account types on an exchange.
/// </summary>
public interface ITransfer : ISharedApiCapability
{
@@ -28,15 +28,11 @@ namespace CryptoExchange.Net.SharedApis
}
/// <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>
public interface ITransferRest : ITransfer, ISharedRest
{
/// <summary>
/// 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>
{
/// <inheritdoc />
new Task<HttpResult<SharedId>> TransferAsync(TransferRequest request, CancellationToken ct = default);
}
}
@@ -8,7 +8,7 @@ using System.Threading.Tasks;
namespace CryptoExchange.Net.SharedApis
{
/// <summary>
/// Request definition for canceling a futures trigger order on an exchange.
/// Operation for canceling an active futures trigger order on an exchange.
/// </summary>
public interface ICancelFuturesTriggerOrder : ISharedApiCapability
{
@@ -27,15 +27,11 @@ namespace CryptoExchange.Net.SharedApis
}
/// <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>
public interface ICancelFuturesTriggerOrderRest : ICancelFuturesTriggerOrder, ISharedRest
{
/// <summary>
/// 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>
/// <inheritdoc />
new Task<HttpResult<SharedId>> CancelFuturesTriggerOrderAsync(CancelOrderRequest request, CancellationToken ct = default);
}
}
@@ -8,7 +8,7 @@ using System.Threading.Tasks;
namespace CryptoExchange.Net.SharedApis
{
/// <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>
public interface IGetFuturesTriggerOrder : ISharedApiCapability
{
@@ -27,15 +27,11 @@ namespace CryptoExchange.Net.SharedApis
}
/// <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>
public interface IGetFuturesTriggerOrderRest : IGetFuturesTriggerOrder, ISharedRest
{
/// <summary>
/// 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>
{
/// <inheritdoc />
new Task<HttpResult<SharedFuturesTriggerOrder>> GetFuturesTriggerOrderAsync(GetOrderRequest request, CancellationToken ct = default);
}
}
@@ -8,7 +8,7 @@ using System.Threading.Tasks;
namespace CryptoExchange.Net.SharedApis
{
/// <summary>
/// Request definition for placing a futures trigger order on an exchange.
/// Operation for placing a futures trigger order on an exchange.
/// </summary>
public interface IPlaceFuturesTriggerOrder : ISharedApiCapability
{
@@ -29,16 +29,11 @@ namespace CryptoExchange.Net.SharedApis
}
/// <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>
public interface IPlaceFuturesTriggerOrderRest : IPlaceFuturesTriggerOrder, ISharedRest
{
/// <summary>
/// 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>
/// <inheritdoc />
new Task<HttpResult<SharedId>> PlaceFuturesTriggerOrderAsync(PlaceFuturesTriggerOrderRequest request, CancellationToken ct = default);
}
}
@@ -8,7 +8,7 @@ using System.Threading.Tasks;
namespace CryptoExchange.Net.SharedApis
{
/// <summary>
/// Request definition for canceling a spot trigger order on an exchange
/// Operation for canceling a spot trigger order on an exchange.
/// </summary>
public interface ICancelSpotTriggerOrder : ISharedApiCapability
{
@@ -27,15 +27,11 @@ namespace CryptoExchange.Net.SharedApis
}
/// <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>
public interface ICancelSpotTriggerOrderRest : ICancelSpotTriggerOrder, ISharedRest
{
/// <summary>
/// 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>
/// <inheritdoc />
new Task<HttpResult<SharedId>> CancelSpotTriggerOrderAsync(CancelOrderRequest request, CancellationToken ct = default);
}
}
@@ -8,7 +8,7 @@ using System.Threading.Tasks;
namespace CryptoExchange.Net.SharedApis
{
/// <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>
public interface IGetSpotTriggerOrder : ISharedApiCapability
{
@@ -27,15 +27,11 @@ namespace CryptoExchange.Net.SharedApis
}
/// <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>
public interface IGetSpotTriggerOrderRest : IGetSpotTriggerOrder, ISharedRest
{
/// <summary>
/// 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>
/// <inheritdoc />
new Task<HttpResult<SharedSpotTriggerOrder>> GetSpotTriggerOrderAsync(GetOrderRequest request, CancellationToken ct = default);
}
}
@@ -8,7 +8,7 @@ using System.Threading.Tasks;
namespace CryptoExchange.Net.SharedApis
{
/// <summary>
/// Request definition for placing a spot trigger order on an exchange.
/// Operation for placing a spot trigger order on an exchange.
/// </summary>
public interface IPlaceSpotTriggerOrder : ISharedApiCapability
{
@@ -30,16 +30,11 @@ namespace CryptoExchange.Net.SharedApis
}
/// <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>
public interface IPlaceSpotTriggerOrderRest : IPlaceSpotTriggerOrder, ISharedRest
{
/// <summary>
/// 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>
/// <inheritdoc />
new Task<HttpResult<SharedId>> PlaceSpotTriggerOrderAsync(PlaceSpotTriggerOrderRequest request, CancellationToken ct = default);
}
@@ -8,7 +8,7 @@ using System.Threading.Tasks;
namespace CryptoExchange.Net.SharedApis
{
/// <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>
public interface IGetFuturesOrderTrades : ISharedApiCapability
{
@@ -27,15 +27,11 @@ namespace CryptoExchange.Net.SharedApis
}
/// <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>
public interface IGetFuturesOrderTradesRest : IGetFuturesOrderTrades, ISharedRest
{
/// <summary>
/// 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>
/// <inheritdoc />
new Task<HttpResult<SharedUserTrade[]>> GetFuturesOrderTradesAsync(GetOrderTradesRequest request, CancellationToken ct = default);
}
}
@@ -8,7 +8,7 @@ using System.Threading.Tasks;
namespace CryptoExchange.Net.SharedApis
{
/// <summary>
/// Request definition for retrieving futures user trade history from an exchange.
/// Operation for retrieving futures user trade history from an exchange.
/// </summary>
public interface IGetFuturesUserTradeHistory : ISharedApiCapability
{
@@ -29,17 +29,11 @@ namespace CryptoExchange.Net.SharedApis
}
/// <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>
public interface IGetFuturesUserTradeHistoryRest : IGetFuturesUserTradeHistory, ISharedRest
{
/// <summary>
/// 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>
/// <inheritdoc />
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
{
/// <summary>
/// Client for subscribing to user trade updates
/// Operation for subscribing to user trade updates
/// </summary>
public interface ISubscribeUserTradesSocket : ISharedSubscription
{
@@ -8,7 +8,7 @@ using System.Threading.Tasks;
namespace CryptoExchange.Net.SharedApis
{
/// <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>
public interface IGetSpotOrderTrades : ISharedApiCapability
{
@@ -29,16 +29,11 @@ namespace CryptoExchange.Net.SharedApis
}
/// <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>
public interface IGetSpotOrderTradesRest : IGetSpotOrderTrades, ISharedRest
{
/// <summary>
/// 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>
/// <inheritdoc />
new Task<HttpResult<SharedUserTrade[]>> GetSpotOrderTradesAsync(GetOrderTradesRequest request, CancellationToken ct = default);
}
@@ -8,7 +8,7 @@ using System.Threading.Tasks;
namespace CryptoExchange.Net.SharedApis
{
/// <summary>
/// Request definition for getting spot user trade history from an exchange
/// Operation for retrieving spot user trade history from an exchange.
/// </summary>
public interface IGetSpotUserTradeHistory : ISharedApiCapability
{
@@ -28,19 +28,12 @@ namespace CryptoExchange.Net.SharedApis
Task<ICallResult<SharedUserTrade[]>> GetSpotUserTradeHistoryAsync(GetUserTradesRequest request, PageRequest? nextPageToken = null, CancellationToken ct = default);
}
/// <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>
public interface IGetSpotUserTradeHistoryRest : IGetSpotUserTradeHistory, ISharedRest
{
/// <summary>
/// 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>
/// <inheritdoc />
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
{
/// <summary>
/// Request definition for retrieving withdrawal history from an exchange
/// Operation for retrieving withdrawal history from an exchange.
/// </summary>
public interface IGetWithdrawalHistory : ISharedApiCapability
{
@@ -31,19 +31,11 @@ namespace CryptoExchange.Net.SharedApis
}
/// <summary>
/// Request definition for retrieving withdrawal history from an exchange
/// Operation for retrieving withdrawal history from an exchange via the REST API.
/// </summary>
public interface IGetWithdrawalHistoryRest : IGetWithdrawalHistory, ISharedRest
{
/// <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>
/// <inheritdoc />
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
{
/// <summary>
/// Request definition for withdrawing a specific asset from an exchange.
/// Operation for withdrawing a specific asset from an exchange.
/// </summary>
public interface IWithdraw : ISharedApiCapability
{
@@ -29,17 +29,11 @@ namespace CryptoExchange.Net.SharedApis
}
/// <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>
public interface IWithdrawRest : IWithdraw, ISharedRest
{
/// <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>
/// <inheritdoc />
new Task<HttpResult<SharedId>> WithdrawAsync(WithdrawRequest request, CancellationToken ct = default);
}
}