Class HistoricalRequestBase

Encapsulates base logic for all historical data requests on Alpaca Data API v2.

Inheritance
System.Object
HistoricalRequestBase
HistoricalAuctionsRequest
HistoricalBarsRequest
HistoricalCryptoBarsRequest
HistoricalCryptoQuotesRequest
HistoricalCryptoTradesRequest
HistoricalOptionBarsRequest
HistoricalOptionTradesRequest
HistoricalQuotesRequest
HistoricalTradesRequest
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 abstract class HistoricalRequestBase

Constructors

| Improve this Doc View Source

HistoricalRequestBase(IEnumerable<String>, IInclusiveTimeInterval)

Creates new instance of HistoricalRequestBase object.

Declaration
protected HistoricalRequestBase(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

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

Creates new instance of HistoricalRequestBase object.

Declaration
protected HistoricalRequestBase(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

HistoricalRequestBase(IEnumerable<String>, DateTime, DateTime)

Creates new instance of HistoricalRequestBase object.

Declaration
protected HistoricalRequestBase(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.

Properties

| Improve this Doc View Source

LastPathSegment

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

Declaration
protected abstract String LastPathSegment { get; }
Property Value
Type Description
String
| Improve this Doc View Source

Pagination

Gets the pagination parameters for the request (page size and token).

Declaration
public Pagination Pagination { get; }
Property Value
Type Description
Pagination
| Improve this Doc View Source

SortDirection

Gets or sets the result sorting direction (sort fields is timestamp).

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

Symbol

Gets asset symbol for data retrieval.

Declaration
public String Symbol { get; }
Property Value
Type Description
String
| Improve this Doc View Source

Symbols

Gets asset symbols list for data retrieval.

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

TimeInterval

Gets inclusive date interval for filtering items in response.

Declaration
public Interval<DateTime> TimeInterval { get; }
Property Value
Type Description
Alpaca.Markets.Interval<DateTime>