Class HistoricalOptionBarsRequest

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

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

Constructors

| Improve this Doc View Source

HistoricalOptionBarsRequest(IEnumerable<String>, BarTimeFrame)

Creates new instance of HistoricalOptionBarsRequest object.

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

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

Creates new instance of HistoricalOptionBarsRequest object.

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

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

Creates new instance of HistoricalOptionBarsRequest object.

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

HistoricalOptionBarsRequest(String, BarTimeFrame)

Creates new instance of HistoricalOptionBarsRequest object.

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

HistoricalOptionBarsRequest(String, BarTimeFrame, Interval<DateTime>)

Creates new instance of HistoricalOptionBarsRequest object.

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

HistoricalOptionBarsRequest(String, DateTime, DateTime, BarTimeFrame)

Creates new instance of HistoricalOptionBarsRequest object.

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

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

TimeFrame

Gets type of time bars for retrieval.

Declaration
public BarTimeFrame TimeFrame { get; }
Property Value
Type Description
Alpaca.Markets.BarTimeFrame

Explicit Interface Implementations

| Improve this Doc View Source

IHistoricalRequest<HistoricalOptionBarsRequest, IBar>.GetValidatedRequestWithoutPageToken()

Declaration
HistoricalOptionBarsRequest IHistoricalRequest<HistoricalOptionBarsRequest, IBar>.GetValidatedRequestWithoutPageToken()
Returns
Type Description
HistoricalOptionBarsRequest

Implements

Extension Methods