Class CalendarRequest

Encapsulates request parameters for ListCalendarAsync(CalendarRequest, CancellationToken) call.

Inheritance
System.Object
CalendarRequest
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 CalendarRequest

Constructors

| Improve this Doc View Source

CalendarRequest()

Creates new instance of CalendarRequest object.

Declaration
public CalendarRequest()
| Improve this Doc View Source

CalendarRequest(Interval<DateOnly>)

Creates new instance of CalendarRequest object.

Declaration
public CalendarRequest(Interval<DateOnly> dateInterval)
Parameters
Type Name Description
Alpaca.Markets.Interval<DateOnly> dateInterval

Initial value of the DateInterval property.
| Improve this Doc View Source

CalendarRequest(Nullable<DateOnly>, Nullable<DateOnly>)

Creates new instance of CalendarRequest object.

Declaration
public CalendarRequest(DateOnly? from, DateOnly? into)
Parameters
Type Name Description
System.Nullable<DateOnly> from

Start date for the resulting data set.
System.Nullable<DateOnly> into

End date for the resulting data set.

Properties

| Improve this Doc View Source

DateInterval

Gets inclusive date interval for filtering items in response.

Declaration
public Interval<DateOnly> DateInterval { get; }
Property Value
Type Description
Alpaca.Markets.Interval<DateOnly>
| 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>

Methods

| Improve this Doc View Source

GetForSingleDay(DateOnly)

Creates new instance of CalendarRequest object with the TimeInterval property configured for the single day.

Declaration
public static CalendarRequest GetForSingleDay(DateOnly date)
Parameters
Type Name Description
DateOnly date
Returns
Type Description
CalendarRequest
| Improve this Doc View Source

GetForSingleDay(DateTime)

Creates new instance of CalendarRequest object with the TimeInterval property configured for the single day.

Declaration
public static CalendarRequest GetForSingleDay(DateTime date)
Parameters
Type Name Description
DateTime date
Returns
Type Description
CalendarRequest
| Improve this Doc View Source

WithInterval(Interval<DateOnly>)

Sets time interval for filtering data returned by this request. ///

Declaration
public CalendarRequest WithInterval(Interval<DateOnly> value)
Parameters
Type Name Description
Alpaca.Markets.Interval<DateOnly> value

New filtering interval.
Returns
Type Description
CalendarRequest

Request with applied filtering.
| Improve this Doc View Source

WithInterval(Interval<DateTime>)

Sets time interval for filtering data returned by this request. ///

Declaration
public CalendarRequest WithInterval(Interval<DateTime> value)
Parameters
Type Name Description
Alpaca.Markets.Interval<DateTime> value

New filtering interval.
Returns
Type Description
CalendarRequest

Request with applied filtering.