Class AnnouncementsRequest

Encapsulates request parameters for ListAnnouncementsAsync(AnnouncementsRequest, CancellationToken) call.

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

Constructors

| Improve this Doc View Source

AnnouncementsRequest(CorporateActionType, IInclusiveTimeInterval)

Creates new instance of AnnouncementsRequest object.

Declaration
public AnnouncementsRequest(CorporateActionType corporateActionType, IInclusiveTimeInterval timeInterval)
Parameters
Type Name Description
CorporateActionType corporateActionType

Single corporate action type for filtering.
IInclusiveTimeInterval timeInterval

Date range when searching corporate action announcements.
| Improve this Doc View Source

AnnouncementsRequest(CorporateActionType, Interval<DateOnly>)

Creates new instance of AnnouncementsRequest object.

Declaration
public AnnouncementsRequest(CorporateActionType corporateActionType, Interval<DateOnly> dateInterval)
Parameters
Type Name Description
CorporateActionType corporateActionType

Single corporate action type for filtering.
Alpaca.Markets.Interval<DateOnly> dateInterval

Date range when searching corporate action announcements.
| Improve this Doc View Source

AnnouncementsRequest(IEnumerable<CorporateActionType>, IInclusiveTimeInterval)

Creates new instance of AnnouncementsRequest object.

Declaration
public AnnouncementsRequest(IEnumerable<CorporateActionType> corporateActionTypes, IInclusiveTimeInterval timeInterval)
Parameters
Type Name Description
IEnumerable<CorporateActionType> corporateActionTypes

List of the corporate action types for filtering.
IInclusiveTimeInterval timeInterval

Date range when searching corporate action announcements.
| Improve this Doc View Source

AnnouncementsRequest(IEnumerable<CorporateActionType>, Interval<DateOnly>)

Creates new instance of AnnouncementsRequest object.

Declaration
public AnnouncementsRequest(IEnumerable<CorporateActionType> corporateActionTypes, Interval<DateOnly> dateInterval)
Parameters
Type Name Description
IEnumerable<CorporateActionType> corporateActionTypes

List of the corporate action types for filtering.
Alpaca.Markets.Interval<DateOnly> dateInterval

Date range when searching corporate action announcements.

Properties

| Improve this Doc View Source

CorporateActionTypes

Gets the list of the corporate action types for filtering.

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

Cusip

Gets or sets the CUSIP of the company initiating the announcement.

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

DateInterval

Gets the date range when searching corporate action announcements.

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

DateType

Gets or sets the type of date for filtering by DateInterval parameter.

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

Symbol

Gets or sets the symbol of the company initiating the announcement.

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

TimeInterval

Gets the date range when searching corporate action announcements.

Declaration
public IInclusiveTimeInterval TimeInterval { get; }
Property Value
Type Description
IInclusiveTimeInterval