Package markets.alpaca.client.openapi.broker.model

Class Announcement

java.lang.Object
markets.alpaca.client.openapi.broker.model.Announcement
All Implemented Interfaces:
Serializable
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", comments="Generator version: 7.23.0") public class Announcement extends Object implements Serializable
The announcements endpoint contains public information on previous and upcoming dividends, mergers, spinoffs, and stock splits. Announcement data is made available through the API as soon as it is ingested by Alpaca, which is typically the following trading day after the declaration date. This provides insight into future account stock position and cash balance changes that will take effect on an announcement's payable date. Additionally, viewing previous announcement details can improve bookkeeping and reconciling previous account cash and position changes.
See Also:

  • Field Details

  • Constructor Details

    • Announcement

      public Announcement()

  • Method Details

    • caSubType

      public Announcement caSubType(@Nonnull AnnouncementCASubType caSubType)

    • getCaSubType

      @Nonnull public AnnouncementCASubType getCaSubType()
      Get caSubType
      Returns:
      caSubType

    • setCaSubType

      public void setCaSubType(@Nonnull AnnouncementCASubType caSubType)

    • caType

      public Announcement caType(@Nonnull AnnouncementCAType caType)

    • getCaType

      @Nonnull public AnnouncementCAType getCaType()
      Get caType
      Returns:
      caType

    • setCaType

      public void setCaType(@Nonnull AnnouncementCAType caType)

    • cash

      public Announcement cash(@Nullable String cash)

    • getCash

      @Nullable public String getCash()
      The amount of cash to be paid per share held by an account on the record date.
      Returns:
      cash

    • setCash

      public void setCash(@Nullable String cash)

    • corporateActionId

      public Announcement corporateActionId(@Nonnull String corporateActionId)

    • getCorporateActionId

      @Nonnull public String getCorporateActionId()
      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.
      Returns:
      corporateActionId

    • setCorporateActionId

      public void setCorporateActionId(@Nonnull String corporateActionId)

    • declarationDate

      public Announcement declarationDate(@Nonnull String declarationDate)

    • getDeclarationDate

      @Nonnull public String getDeclarationDate()
      Date the corporate action or subsequent terms update was announced.
      Returns:
      declarationDate

    • setDeclarationDate

      public void setDeclarationDate(@Nonnull String declarationDate)

    • exDate

      public Announcement exDate(@Nullable String exDate)

    • getExDate

      @Nullable public String getExDate()
      The first date that purchasing a security will not result in a corporate action entitlement.
      Returns:
      exDate

    • setExDate

      public void setExDate(@Nullable String exDate)

    • id

      public Announcement id(@Nonnull String id)

    • getId

      @Nonnull public String getId()
      ID that is specific to a single announcement.
      Returns:
      id

    • setId

      public void setId(@Nonnull String id)

    • initiatingOriginalCusip

      public Announcement initiatingOriginalCusip(@Nonnull String initiatingOriginalCusip)

    • getInitiatingOriginalCusip

      @Nonnull public String getInitiatingOriginalCusip()
      CUSIP of the company initiating the announcement.
      Returns:
      initiatingOriginalCusip

    • setInitiatingOriginalCusip

      public void setInitiatingOriginalCusip(@Nonnull String initiatingOriginalCusip)

    • initiatingSymbol

      public Announcement initiatingSymbol(@Nonnull String initiatingSymbol)

    • getInitiatingSymbol

      @Nonnull public String getInitiatingSymbol()
      Symbol of the company initiating the announcement.
      Returns:
      initiatingSymbol

    • setInitiatingSymbol

      public void setInitiatingSymbol(@Nonnull String initiatingSymbol)

    • newRate

      public Announcement newRate(@Nullable String newRate)

    • getNewRate

      @Nullable public String getNewRate()
      The numerator to determine any quantity change ratios in positions.
      Returns:
      newRate

    • setNewRate

      public void setNewRate(@Nullable String newRate)

    • oldRate

      public Announcement oldRate(@Nullable String oldRate)

    • getOldRate

      @Nullable public String getOldRate()
      The denominator to determine any quantity change ratios in positions.
      Returns:
      oldRate

    • setOldRate

      public void setOldRate(@Nullable String oldRate)

    • payableDate

      public Announcement payableDate(@Nonnull String payableDate)

    • getPayableDate

      @Nonnull public String getPayableDate()
      The date the announcement will take effect. On this date, account stock and cash balances are expected to be processed accordingly.
      Returns:
      payableDate

    • setPayableDate

      public void setPayableDate(@Nonnull String payableDate)

    • recordDate

      public Announcement recordDate(@Nullable String recordDate)

    • getRecordDate

      @Nullable public String getRecordDate()
      The date an account must hold a settled position in the security in order to receive the corporate action entitlement.
      Returns:
      recordDate

    • setRecordDate

      public void setRecordDate(@Nullable String recordDate)

    • targetOriginalCusip

      public Announcement targetOriginalCusip(@Nullable String targetOriginalCusip)

    • getTargetOriginalCusip

      @Nullable public String getTargetOriginalCusip()
      CUSIP of the child company involved in the announcement.
      Returns:
      targetOriginalCusip

    • setTargetOriginalCusip

      public void setTargetOriginalCusip(@Nullable String targetOriginalCusip)

    • targetSymbol

      public Announcement targetSymbol(@Nullable String targetSymbol)

    • getTargetSymbol

      @Nullable public String getTargetSymbol()
      Symbol of the child company involved in the announcement.
      Returns:
      targetSymbol

    • setTargetSymbol

      public void setTargetSymbol(@Nullable String targetSymbol)

    • putAdditionalProperty

      public Announcement putAdditionalProperty(String key, Object value)
      Set the additional (undeclared) property with the specified name and value. If the property does not already exist, create it otherwise replace it.
      Parameters:
      key - name of the property
      value - value of the property
      Returns:
      the Announcement instance itself

    • getAdditionalProperties

      public Map<String,Object> getAdditionalProperties()
      Return the additional (undeclared) property.
      Returns:
      a map of objects

    • getAdditionalProperty

      public Object getAdditionalProperty(String key)
      Return the additional (undeclared) property with the specified name.
      Parameters:
      key - name of the property
      Returns:
      an object

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • validateJsonElement

      public static void validateJsonElement(com.google.gson.JsonElement jsonElement) throws IOException
      Validates the JSON Element and throws an exception if issues found
      Parameters:
      jsonElement - JSON Element
      Throws:
      IOException - if the JSON Element is invalid with respect to Announcement

    • fromJson

      public static Announcement fromJson(String jsonString) throws IOException
      Create an instance of Announcement given an JSON string
      Parameters:
      jsonString - JSON string
      Returns:
      An instance of Announcement
      Throws:
      IOException - if the JSON string is invalid with respect to Announcement

    • toJson

      public String toJson()
      Convert an instance of Announcement to an JSON string
      Returns:
      JSON string