1
0
mirror of https://github.com/JKorf/CryptoExchange.Net.git synced 2026-10-14 23:21:48 +00:00
Files
CryptoExchange.Net/CryptoExchange.Net/SharedApis/V2/Tickers/GetTicker/IGetTicker.cs
T
Jkorf 7629455dec wip
2026-09-07 15:23:08 +02:00

38 lines
1.6 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 a single ticker from an exchange.
/// </summary>
public interface IGetTicker : ISharedApiCapability
{
/// <summary>
/// Ticker 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>
GetTickerOptions GetTickerOptions { get; }
/// <summary>
/// Get ticker for a specific symbol, see <see cref="GetTickerOptions"/> 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<SharedTicker>> GetTickerAsync(GetTickerRequest request, CancellationToken ct = default);
}
/// <summary>
/// Operation for retrieving a single ticker from an exchange via the REST API
/// </summary>
public interface IGetTickerRest : IGetTicker, ISharedRest
{
/// <inheritdoc />
new Task<HttpResult<SharedTicker>> GetTickerAsync(GetTickerRequest request, CancellationToken ct = default);
}
}