Class HistoricalCryptoTradesRequest

Encapsulates request parameters for ListHistoricalTradesAsync(TRequest, CancellationToken) and GetHistoricalTradesAsync(TRequest, CancellationToken) calls.

Inheritance
System.Object
HistoricalRequestBase
HistoricalCryptoTradesRequest
Implements
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: Alpaca.Markets
Assembly: Alpaca.Markets.dll
Syntax
public sealed class HistoricalCryptoTradesRequest : HistoricalRequestBase, IHistoricalRequest<HistoricalCryptoTradesRequest, ITrade>, IHistoricalRequest

Constructors

| Improve this Doc View Source

HistoricalCryptoTradesRequest(IEnumerable<String>)

Creates new instance of HistoricalCryptoTradesRequest object.

Declaration
public HistoricalCryptoTradesRequest(IEnumerable<String> symbols)
Parameters
Type Name Description
IEnumerable<String> symbols

Asset symbols for data retrieval.
| Improve this Doc View Source

HistoricalCryptoTradesRequest(IEnumerable<String>, IInclusiveTimeInterval)

Creates new instance of HistoricalCryptoTradesRequest object.

Declaration
public HistoricalCryptoTradesRequest(IEnumerable<String> symbols, IInclusiveTimeInterval timeInterval)
Parameters
Type Name Description
IEnumerable<String> symbols

Asset symbols for data retrieval.
IInclusiveTimeInterval timeInterval

Inclusive time interval for filtering items in response.
| Improve this Doc View Source

HistoricalCryptoTradesRequest(IEnumerable<String>, Interval<DateTime>)

Creates new instance of HistoricalCryptoTradesRequest object.

Declaration
public HistoricalCryptoTradesRequest(IEnumerable<String> symbols, Interval<DateTime> timeInterval)
Parameters
Type Name Description
IEnumerable<String> symbols

Asset symbols for data retrieval.
Alpaca.Markets.Interval<DateTime> timeInterval

Inclusive time interval for filtering items in response.
| Improve this Doc View Source

HistoricalCryptoTradesRequest(IEnumerable<String>, DateTime, DateTime)

Creates new instance of HistoricalCryptoTradesRequest object.

Declaration
public HistoricalCryptoTradesRequest(IEnumerable<String> symbols, DateTime from, DateTime into)
Parameters
Type Name Description
IEnumerable<String> symbols

Asset symbols for data retrieval.
DateTime from

Filter data equal to or after this time.
DateTime into

Filter data equal to or before this time.
| Improve this Doc View Source

HistoricalCryptoTradesRequest(String)

Creates new instance of HistoricalCryptoTradesRequest object.

Declaration
public HistoricalCryptoTradesRequest(String symbol)
Parameters
Type Name Description
String symbol

Asset symbol for data retrieval.
| Improve this Doc View Source

HistoricalCryptoTradesRequest(String, IInclusiveTimeInterval)

Creates new instance of HistoricalCryptoTradesRequest object.

Declaration
public HistoricalCryptoTradesRequest(String symbol, IInclusiveTimeInterval timeInterval)
Parameters
Type Name Description
String symbol

Asset symbol for data retrieval.
IInclusiveTimeInterval timeInterval

Inclusive time interval for filtering items in response.
| Improve this Doc View Source

HistoricalCryptoTradesRequest(String, Interval<DateTime>)

Creates new instance of HistoricalCryptoTradesRequest object.

Declaration
public HistoricalCryptoTradesRequest(String symbol, Interval<DateTime> timeInterval)
Parameters
Type Name Description
String symbol

Asset symbol for data retrieval.
Alpaca.Markets.Interval<DateTime> timeInterval

Inclusive time interval for filtering items in response.
| Improve this Doc View Source

HistoricalCryptoTradesRequest(String, DateTime, DateTime)

Creates new instance of HistoricalCryptoTradesRequest object.

Declaration
public HistoricalCryptoTradesRequest(String symbol, DateTime from, DateTime into)
Parameters
Type Name Description
String symbol

Asset symbol for data retrieval.
DateTime from

Filter data equal to or after this time.
DateTime into

Filter data equal to or before this time.

Properties

| Improve this Doc View Source

Exchanges

Gets crypto exchanges list for data retrieval (empty list means 'all exchanges').

Declaration
public IReadOnlyCollection<CryptoExchange> Exchanges { get; }
Property Value
Type Description
IReadOnlyCollection<CryptoExchange>
| Improve this Doc View Source

LastPathSegment

Gets the last part of the full REST endpoint URL path.

Declaration
protected override String LastPathSegment { get; }
Property Value
Type Description
String
Overrides

Methods

| Improve this Doc View Source

WithExchanges(CryptoExchange[])

Creates new instance of HistoricalCryptoTradesRequest object with the updated Exchanges list.

Declaration
public HistoricalCryptoTradesRequest WithExchanges(params CryptoExchange[] exchanges)
Parameters
Type Name Description
CryptoExchange[] exchanges

Crypto exchanges to add into the list.
Returns
Type Description
HistoricalCryptoTradesRequest

The new instance of the HistoricalCryptoTradesRequest object.
| Improve this Doc View Source

WithExchanges(IEnumerable<CryptoExchange>)

Creates new instance of HistoricalCryptoTradesRequest object with the updated Exchanges list.

Declaration
public HistoricalCryptoTradesRequest WithExchanges(IEnumerable<CryptoExchange> exchanges)
Parameters
Type Name Description
IEnumerable<CryptoExchange> exchanges

Crypto exchanges to add into the list.
Returns
Type Description
HistoricalCryptoTradesRequest

The new instance of the HistoricalCryptoTradesRequest object.

Explicit Interface Implementations

| Improve this Doc View Source

IHistoricalRequest<HistoricalCryptoTradesRequest, ITrade>.GetValidatedRequestWithoutPageToken()

Declaration
HistoricalCryptoTradesRequest IHistoricalRequest<HistoricalCryptoTradesRequest, ITrade>.GetValidatedRequestWithoutPageToken()
Returns
Type Description
HistoricalCryptoTradesRequest

Implements

Extension Methods