Class AccountActivitiesRequest

Encapsulates request parameters for ListAccountActivitiesAsync(AccountActivitiesRequest, CancellationToken) call.

Inheritance

System.Object

AccountActivitiesRequest

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 AccountActivitiesRequest

Constructors

AccountActivitiesRequest()

Creates new instance of AccountActivitiesRequest object for all activity types.

Declaration

public AccountActivitiesRequest()

AccountActivitiesRequest(AccountActivityType)

Creates new instance of AccountActivitiesRequest object for a single activity types.

Declaration

public AccountActivitiesRequest(AccountActivityType activityType)

Parameters

Type	Name	Description
AccountActivityType	activityType	The activity type you want to view entries for.

AccountActivitiesRequest(IEnumerable<AccountActivityType>)

Creates new instance of AccountActivitiesRequest object for several activity types.

Declaration

public AccountActivitiesRequest(IEnumerable<AccountActivityType> activityTypes)

Parameters

Type	Name	Description
IEnumerable<AccountActivityType>	activityTypes	The list of activity types you want to view entries for.

Properties

ActivityTypes

Gets the activity types you want to view entries for. Empty list means 'all activity types'.

Declaration

public IReadOnlyCollection<AccountActivityType> ActivityTypes { get; }

Property Value

Type	Description
IReadOnlyCollection<AccountActivityType>

Date

Gets the date for which you want to see activities.

Declaration

public DateOnly? Date { get; }

Property Value

Type	Description
System.Nullable<DateOnly>

Direction

Gets or sets the sorting direction for results.

Declaration

public SortDirection? Direction { get; set; }

Property Value

Type	Description
System.Nullable<SortDirection>

PageSize

Gets or sets the maximum number of entries to return in the response.

Declaration

public Int64? PageSize { get; set; }

Property Value

Type	Description
System.Nullable<Int64>

PageToken

Gets or sets the ID of the end of your current page of results.

Declaration

public String? PageToken { get; set; }

Property Value

Type	Description
System.Nullable<String>

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

SetSingleDate(DateOnly)

Sets filtering for single date activities.

Declaration

public AccountActivitiesRequest SetSingleDate(DateOnly date)

Parameters

Type	Name	Description
DateOnly	date	Target date for filtering activities.

Returns

Type	Description
AccountActivitiesRequest	Fluent interface method return same AccountActivitiesRequest instance.

SetSingleDate(DateTime)

Sets filtering for single date activities.

Declaration

public AccountActivitiesRequest SetSingleDate(DateTime date)

Parameters

Type	Name	Description
DateTime	date	Target date for filtering activities.

Returns

Type	Description
AccountActivitiesRequest	Fluent interface method return same AccountActivitiesRequest instance.

WithInterval(Interval<DateTime>)

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

Declaration

public AccountActivitiesRequest WithInterval(Interval<DateTime> value)

Parameters

Type	Name	Description
Alpaca.Markets.Interval<DateTime>	value	New filtering interval.

Returns

Type	Description
AccountActivitiesRequest	Request with applied filtering.