Class PortfolioHistoryRequest

Encapsulates request parameters for GetPortfolioHistoryAsync(PortfolioHistoryRequest, CancellationToken) call.

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

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

ExtendedHours

Gets or sets flags, indicating that include extended hours included in the result. This is effective only for time frame less than 1 day.

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

Interval

Gets inclusive date interval for filtering items in response.

Declaration
public Interval<DateTime> Interval { get; }
Property Value
Type Description
Alpaca.Markets.Interval<DateTime>
| Improve this Doc View Source

IntradayProfitLoss

Gets or sets intraday profit/loss reset. Make sense only if TimeFrame are equal to Day.

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

IntradayReporting

Gets or sets intraday reporting style. Make sense only if TimeFrame are equal to Day.

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

Period

Gets or sets period value for desired history. Default value (if null) is 1 month.

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

TimeFrame

Gets or sets the time frame value for desired history. Default value (if null) is 1 minute for a period shorter than 7 days, 15 minutes for a period less than 30 days, or 1 day for a longer period.

Declaration
public TimeFrame? TimeFrame { get; set; }
Property Value
Type Description
System.Nullable<TimeFrame>
| 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

WithInterval(Interval<DateOnly>)

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

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

New filtering interval.
Returns
Type Description
PortfolioHistoryRequest

Request with applied filtering.
| Improve this Doc View Source

WithInterval(Interval<DateTime>)

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

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

New filtering interval.
Returns
Type Description
PortfolioHistoryRequest

Request with applied filtering.