Class HistoricalBarsRequest

Encapsulates request parameters for ListHistoricalBarsAsync(TRequest, CancellationToken) and GetHistoricalBarsAsync(TRequest, CancellationToken) calls.

Inheritance

System.Object

HistoricalRequestBase

HistoricalBarsRequest

Implements

IHistoricalRequest<HistoricalBarsRequest, IBar>

IHistoricalRequest

Inherited Members

HistoricalRequestBase.Symbol

HistoricalRequestBase.Symbols

HistoricalRequestBase.TimeInterval

HistoricalRequestBase.Pagination

HistoricalRequestBase.SortDirection

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 HistoricalBarsRequest : HistoricalRequestBase, IHistoricalRequest<HistoricalBarsRequest, IBar>, IHistoricalRequest

Constructors

| Improve this Doc View Source

HistoricalBarsRequest(IEnumerable<String>, BarTimeFrame)

Creates new instance of HistoricalBarsRequest object.

Declaration

public HistoricalBarsRequest(IEnumerable<String> symbols, BarTimeFrame timeFrame)

Parameters

Type	Name	Description
IEnumerable<String>	symbols	Asset symbols for data retrieval.
Alpaca.Markets.BarTimeFrame	timeFrame	Type of time bars for retrieval.

| Improve this Doc View Source

HistoricalBarsRequest(IEnumerable<String>, IInclusiveTimeInterval, BarTimeFrame)

Creates new instance of HistoricalBarsRequest object.

Declaration

public HistoricalBarsRequest(IEnumerable<String> symbols, IInclusiveTimeInterval timeInterval, BarTimeFrame timeFrame)

Parameters

Type	Name	Description
IEnumerable<String>	symbols	Asset symbols for data retrieval.
IInclusiveTimeInterval	timeInterval	Inclusive time interval for filtering items in response.
Alpaca.Markets.BarTimeFrame	timeFrame	Type of time bars for retrieval.

| Improve this Doc View Source

HistoricalBarsRequest(IEnumerable<String>, Interval<DateTime>, BarTimeFrame)

Creates new instance of HistoricalBarsRequest object.

Declaration

public HistoricalBarsRequest(IEnumerable<String> symbols, Interval<DateTime> timeInterval, BarTimeFrame timeFrame)

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.
Alpaca.Markets.BarTimeFrame	timeFrame	Type of time bars for retrieval.

| Improve this Doc View Source

HistoricalBarsRequest(IEnumerable<String>, DateTime, DateTime, BarTimeFrame)

Creates new instance of HistoricalBarsRequest object.

Declaration

public HistoricalBarsRequest(IEnumerable<String> symbols, DateTime from, DateTime into, BarTimeFrame timeFrame)

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.
Alpaca.Markets.BarTimeFrame	timeFrame	Type of time bars for retrieval.

| Improve this Doc View Source

HistoricalBarsRequest(String, BarTimeFrame)

Creates new instance of HistoricalBarsRequest object.

Declaration

public HistoricalBarsRequest(String symbol, BarTimeFrame timeFrame)

Parameters

Type	Name	Description
String	symbol	Asset symbol for data retrieval.
Alpaca.Markets.BarTimeFrame	timeFrame	Type of time bars for retrieval.

| Improve this Doc View Source

HistoricalBarsRequest(String, BarTimeFrame, IInclusiveTimeInterval)

Creates new instance of HistoricalBarsRequest object.

Declaration

public HistoricalBarsRequest(String symbol, BarTimeFrame timeFrame, IInclusiveTimeInterval timeInterval)

Parameters

Type	Name	Description
String	symbol	Asset symbol for data retrieval.
Alpaca.Markets.BarTimeFrame	timeFrame	Type of time bars for retrieval.
IInclusiveTimeInterval	timeInterval	Inclusive time interval for filtering items in response.

| Improve this Doc View Source

HistoricalBarsRequest(String, BarTimeFrame, Interval<DateTime>)

Creates new instance of HistoricalBarsRequest object.

Declaration

public HistoricalBarsRequest(String symbol, BarTimeFrame timeFrame, Interval<DateTime> timeInterval)

Parameters

Type	Name	Description
String	symbol	Asset symbol for data retrieval.
Alpaca.Markets.BarTimeFrame	timeFrame	Type of time bars for retrieval.
Alpaca.Markets.Interval<DateTime>	timeInterval	Inclusive time interval for filtering items in response.

| Improve this Doc View Source

HistoricalBarsRequest(String, DateTime, DateTime, BarTimeFrame)

Creates new instance of HistoricalBarsRequest object.

Declaration

public HistoricalBarsRequest(String symbol, DateTime from, DateTime into, BarTimeFrame timeFrame)

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.
Alpaca.Markets.BarTimeFrame	timeFrame	Type of time bars for retrieval.

Properties

| Improve this Doc View Source

Adjustment

Gets or sets adjustment type of time bars for retrieval.

Declaration

public Adjustment? Adjustment { get; set; }

Property Value

Type	Description
System.Nullable<Adjustment>

| 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

HistoricalRequestBase.LastPathSegment

| Improve this Doc View Source

TimeFrame

Gets type of time bars for retrieval.

Declaration

public BarTimeFrame TimeFrame { get; }

Property Value

Type	Description
Alpaca.Markets.BarTimeFrame

| 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<HistoricalBarsRequest, IBar>.GetValidatedRequestWithoutPageToken()

Declaration

HistoricalBarsRequest IHistoricalRequest<HistoricalBarsRequest, IBar>.GetValidatedRequestWithoutPageToken()

Returns

Type	Description
HistoricalBarsRequest

Implements

IHistoricalRequest<TRequest, TItem>

IHistoricalRequest

Extension Methods

HistoricalRequestBaseExtensions.WithPageSize<TRequest>(TRequest, UInt32)

HistoricalRequestBaseExtensions.WithPageToken<TRequest>(TRequest, String)