Class CorporateActionsRequest

Encapsulates request parameters for ListCorporateActionsAsync(CorporateActionsRequest, CancellationToken) call.

Inheritance
System.Object
CorporateActionsRequest
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 CorporateActionsRequest : IHistoricalRequest<CorporateActionsRequest, ICorporateActionsResponse>, IHistoricalRequest

Properties

| Improve this Doc View Source

DateInterval

Gets the date range when searching corporate actions history (current day if empty).

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

Pagination

Gets the pagination parameters for the request (page size and token).

Declaration
public Pagination Pagination { get; }
Property Value
Type Description
Pagination
| Improve this Doc View Source

SortDirection

Gets or sets the result sorting direction (sort fields is timestamp).

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

Symbols

Gets asset symbols list for data retrieval (all symbols if list is empty).

Declaration
public IReadOnlyCollection<String> Symbols { get; }
Property Value
Type Description
IReadOnlyCollection<String>
| Improve this Doc View Source

Types

Gets corporate action types list for data retrieval (all types if list is empty).

Declaration
public IReadOnlyCollection<CorporateActionFilterType> Types { get; }
Property Value
Type Description
IReadOnlyCollection<CorporateActionFilterType>

Methods

| Improve this Doc View Source

WithDateInterval(Interval<DateOnly>)

Sets the DateInterval filter value for the request.

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

The inclusive date interval for data retrieval.
Returns
Type Description
CorporateActionsRequest

Fluent interface - returns the modified request object.
| Improve this Doc View Source

WithSymbol(String)

Adds a single symbol into the Symbols filter list.

Declaration
public CorporateActionsRequest WithSymbol(String symbol)
Parameters
Type Name Description
String symbol

Asset symbol for data retrieval.
Returns
Type Description
CorporateActionsRequest

Fluent interface - returns the modified request object.
| Improve this Doc View Source

WithSymbols(IEnumerable<String>)

Adds several symbols into the Symbols filter list.

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

Asset symbols for data retrieval.
Returns
Type Description
CorporateActionsRequest

Fluent interface - returns the modified request object.
| Improve this Doc View Source

WithType(CorporateActionFilterType)

Adds a single item into the Types filter list.

Declaration
public CorporateActionsRequest WithType(CorporateActionFilterType type)
Parameters
Type Name Description
CorporateActionFilterType type

Corporate action type for data retrieval.
Returns
Type Description
CorporateActionsRequest

Fluent interface - returns the modified request object.
| Improve this Doc View Source

WithTypes(IEnumerable<CorporateActionFilterType>)

Adds several items into the Types filter list.

Declaration
public CorporateActionsRequest WithTypes(IEnumerable<CorporateActionFilterType> types)
Parameters
Type Name Description
IEnumerable<CorporateActionFilterType> types

Corporate action types for data retrieval.
Returns
Type Description
CorporateActionsRequest

Fluent interface - returns the modified request object.

Explicit Interface Implementations

| Improve this Doc View Source

IHistoricalRequest<CorporateActionsRequest, ICorporateActionsResponse>.GetValidatedRequestWithoutPageToken()

Declaration
CorporateActionsRequest IHistoricalRequest<CorporateActionsRequest, ICorporateActionsResponse>.GetValidatedRequestWithoutPageToken()
Returns
Type Description
CorporateActionsRequest

Implements

Extension Methods