1
0
mirror of https://github.com/JKorf/CryptoExchange.Net.git synced 2026-10-14 15:11:44 +00:00
Files
CryptoExchange.Net/CryptoExchange.Net/SharedApis/V2/Withdrawals/GetWithdrawalHistory/IGetWithdrawalHistory.cs
T
Jkorf 15f7ba32e1 wip
2026-09-18 13:54:48 +02:00

42 lines
2.2 KiB
C#

using CryptoExchange.Net.Objects;
using System;
using System.Collections.Generic;
using System.Text;
using System.Threading;
using System.Threading.Tasks;
namespace CryptoExchange.Net.SharedApis
{
/// <summary>
/// Operation for retrieving withdrawal history from an exchange.
/// </summary>
public interface IGetWithdrawalHistory : ISharedApiCapability
{
/// <summary>
/// Withdrawal records request options.<br />
/// Use <see cref="CapabilityOptions.RequestParameterRules"/> and <see cref="CapabilityOptions.ExchangeParameterRules"/> to check for required and optional parameters for the request. <br />
/// Exchange specific parameters can be added to the request via the `ExchangeParameters` property of the request object.
/// </summary>
GetWithdrawalHistoryOptions GetWithdrawalHistoryOptions { get; }
/// <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>
Task<IExchangeCallResult<SharedWithdrawal[]>> GetWithdrawalHistoryAsync(GetWithdrawalsRequest request, PageRequest? nextPageToken = null, CancellationToken ct = default);
}
/// <summary>
/// Operation for retrieving withdrawal history from an exchange via the REST API.
/// </summary>
public interface IGetWithdrawalHistoryRest : IGetWithdrawalHistory, ISharedRest
{
/// <inheritdoc />
new Task<HttpResult<SharedWithdrawal[]>> GetWithdrawalHistoryAsync(GetWithdrawalsRequest request, PageRequest? nextPageToken = null, CancellationToken ct = default);
}
}