Class HistoricalTradesRequest

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

Inheritance
System.Object
HistoricalRequestBase
HistoricalTradesRequest
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 HistoricalTradesRequest : HistoricalRequestBase, IHistoricalRequest<HistoricalTradesRequest, ITrade>, IHistoricalRequest

Constructors

| Improve this Doc View Source

HistoricalTradesRequest(IEnumerable<String>)

Creates new instance of HistoricalTradesRequest object.

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

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

HistoricalTradesRequest(IEnumerable<String>, IInclusiveTimeInterval)

Creates new instance of HistoricalTradesRequest object.

Declaration
public HistoricalTradesRequest(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

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

Creates new instance of HistoricalTradesRequest object.

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

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

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

HistoricalTradesRequest(IEnumerable<String>, DateTime, DateTime)

Creates new instance of HistoricalTradesRequest object.

Declaration
public HistoricalTradesRequest(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

HistoricalTradesRequest(String)

Creates new instance of HistoricalTradesRequest object.

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

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

HistoricalTradesRequest(String, IInclusiveTimeInterval)

Creates new instance of HistoricalTradesRequest object.

Declaration
public HistoricalTradesRequest(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

HistoricalTradesRequest(String, Interval<DateTime>)

Creates new instance of HistoricalTradesRequest object.

Declaration
public HistoricalTradesRequest(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

HistoricalTradesRequest(String, DateTime, DateTime)

Creates new instance of HistoricalTradesRequest object.

Declaration
public HistoricalTradesRequest(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

Currency

Gets or sets the optional parameter for the returned prices in ISO 4217 standard. For example: USD, EUR, JPY, etc. In case of null the default USD will be used.

Declaration
public String? Currency { get; set; }
Property Value
Type Description
System.Nullable<String>
| Improve this Doc View Source

Feed

Gets or sets the feed to pull market data from. The Sip and Otc are only available to those with a subscription. Default is Iex for free plans and Sip for paid.

Declaration
public MarketDataFeed? Feed { get; set; }
Property Value
Type Description
System.Nullable<MarketDataFeed>
| 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
| Improve this Doc View Source

UseSymbolAsOfTheDate

Gets or sets the optional parameter for mapping symbol to contract by a specific date.

Declaration
public DateOnly? UseSymbolAsOfTheDate { get; set; }
Property Value
Type Description
System.Nullable<DateOnly>

Explicit Interface Implementations

| Improve this Doc View Source

IHistoricalRequest<HistoricalTradesRequest, ITrade>.GetValidatedRequestWithoutPageToken()

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

Implements

Extension Methods