Show / Hide Table of Contents

Class HistoricalAuctionsRequest

Encapsulates request parameters for ListHistoricalQuotesAsync(TRequest, CancellationToken) and GetHistoricalQuotesAsync(TRequest, CancellationToken) calls.

Inheritance
System.Object
HistoricalRequestBase
HistoricalAuctionsRequest
Implements
IHistoricalRequest<HistoricalAuctionsRequest, IAuction>
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 HistoricalAuctionsRequest : HistoricalRequestBase, IHistoricalRequest<HistoricalAuctionsRequest, IAuction>, IHistoricalRequest

Constructors

| Improve this Doc View Source

HistoricalAuctionsRequest(IEnumerable<String>)

Creates new instance of HistoricalAuctionsRequest object.

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

Asset symbols for data retrieval.

| Improve this Doc View Source

HistoricalAuctionsRequest(IEnumerable<String>, IInclusiveTimeInterval)

Creates new instance of HistoricalAuctionsRequest object.

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

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

Creates new instance of HistoricalAuctionsRequest object.

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

HistoricalAuctionsRequest(IEnumerable<String>, DateTime, DateTime)

Creates new instance of HistoricalAuctionsRequest object.

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

HistoricalAuctionsRequest(String)

Creates new instance of HistoricalAuctionsRequest object.

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

Asset symbol for data retrieval.

| Improve this Doc View Source

HistoricalAuctionsRequest(String, IInclusiveTimeInterval)

Creates new instance of HistoricalAuctionsRequest object.

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

HistoricalAuctionsRequest(String, Interval<DateTime>)

Creates new instance of HistoricalAuctionsRequest object.

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

HistoricalAuctionsRequest(String, DateTime, DateTime)

Creates new instance of HistoricalAuctionsRequest object.

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

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

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<HistoricalAuctionsRequest, IAuction>.GetValidatedRequestWithoutPageToken()

Declaration
HistoricalAuctionsRequest IHistoricalRequest<HistoricalAuctionsRequest, IAuction>.GetValidatedRequestWithoutPageToken()
Returns
Type Description
HistoricalAuctionsRequest

Implements

IHistoricalRequest<TRequest, TItem>
IHistoricalRequest

Extension Methods

HistoricalRequestBaseExtensions.WithPageSize<TRequest>(TRequest, UInt32)
HistoricalRequestBaseExtensions.WithPageToken<TRequest>(TRequest, String)
  • Improve this Doc
  • View Source
In This Article
Back to top Generated by DocFX