Interface IAnnouncement
Encapsulates corporate action announcement information from Alpaca REST API.
Namespace: Alpaca.Markets
Assembly: Alpaca.Markets.dll
Syntax
public interface IAnnouncement
Properties
| Improve this Doc View SourceCash
Gets the amount of cash to be paid per share held by an account on the record date.
Declaration
Decimal Cash { get; }
Property Value
Type | Description |
---|---|
Decimal |
CorporateActionId
Gets ID that remains consistent across all announcements for the same corporate action. Unlike Id, this can be used to connect multiple announcements to see how the terms have changed throughout the lifecycle of the corporate action event.
Declaration
String CorporateActionId { get; }
Property Value
Type | Description |
---|---|
String |
Id
Gets ID that is specific to a single announcement.
Declaration
Guid Id { get; }
Property Value
Type | Description |
---|---|
Guid |
InitiatingCusip
Gets CUSIP of the company initiating the announcement.
Declaration
String InitiatingCusip { get; }
Property Value
Type | Description |
---|---|
String |
InitiatingSymbol
Gets symbol of the company initiating the announcement.
Declaration
String InitiatingSymbol { get; }
Property Value
Type | Description |
---|---|
String |
NewRate
Gets the numerator to determine any quantity change ratios in positions.
Declaration
Decimal NewRate { get; }
Property Value
Type | Description |
---|---|
Decimal |
OldRate
Gets the denominator to determine any quantity change ratios in positions.
Declaration
Decimal OldRate { get; }
Property Value
Type | Description |
---|---|
Decimal |
SubType
Gets corporate action sub-type.
Declaration
CorporateActionSubType SubType { get; }
Property Value
Type | Description |
---|---|
CorporateActionSubType |
TargetCusip
Gets CUSIP of the child company involved in the announcement.
Declaration
String TargetCusip { get; }
Property Value
Type | Description |
---|---|
String |
TargetSymbol
Gets symbol of the child company involved in the announcement.
Declaration
String TargetSymbol { get; }
Property Value
Type | Description |
---|---|
String |
Type
Gets corporate action type.
Declaration
CorporateActionType Type { get; }
Property Value
Type | Description |
---|---|
CorporateActionType |
Methods
| Improve this Doc View SourceGetDate(CorporateActionDateType)
Gets the corporate action date by date type or null
if date not specified.
Declaration
DateOnly? GetDate(CorporateActionDateType dateType)
Parameters
Type | Name | Description |
---|---|---|
CorporateActionDateType | dateType | Corporate action date type. |
Returns
Type | Description |
---|---|
System.Nullable<DateOnly> | Specific date for this corporate action if it's applicable and specified. |