Package markets.alpaca.client.openapi.trading.model

Class NonTradeActivities

java.lang.Object
markets.alpaca.client.openapi.trading.model.NonTradeActivities
All Implemented Interfaces:
Serializable
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", comments="Generator version: 7.23.0") public class NonTradeActivities extends Object implements Serializable
NonTradeActivities
See Also:

  • Field Details

  • Constructor Details

    • NonTradeActivities

      public NonTradeActivities()

  • Method Details

    • activitySubType

      public NonTradeActivities activitySubType(@Nullable String activitySubType)

    • getActivitySubType

      @Nullable public String getActivitySubType()
      Represents a more specific classification to the `activity_type`. This field is optional and may not always be populated, depending on the activity type and the available data. Each `activity_type` has a set of valid `activity_sub_type` values. Full mapping of `activity_type` to `activity_sub_type`: - **DIV**: Dividend activity sub-types: - **CDIV**: Cash Dividend - **SDIV**: Stock Dividend - **SPD**: Substitute Payment In Lieu Of Dividend - **FEE**: Fee-related activity sub-types: - **REG**: Regulatory Fee - **TAF**: Trading Activity Fee - **LCT**: Local Currency Trading Fee - **ORF**: Options Regulatory Fee - **OCC**: Options Clearing Corporation Fee - **NRC**: Non-Retail Commission Fee - **NRV**: Non-Retail Venue Fee - **COM**: Commission - **CAT**: Consolidated Audit Trail Fee - **INT**: Interest-related activity sub-types: - **MGN**: Margin Interest - **CDT**: Credit Interest - **SWP**: Sweep Interest - **QII**: Qualified Interest - **MA**: Merger and Acquisition activity sub-types: - **CMA**: Cash Merger - **SMA**: Stock Merger - **SCMA**: Stock & Cash Merger - **NC**: Name Change activity sub types - **SNC**: Symbol Name Change - **CNC**: CUSIP Name Change - **SCNC**: Symbol & CUSIP Name Change - **OPCA**: Option Corporate Action activity sub-types: - **DIV.CDIV**: Cash Dividend - **DIV.SDIV**: Stock Dividend - **MA.CMA**: Cash Merger - **MA.SMA**: Stock Merger - **MA.SCMA**: Stock & Cash Merger - **NC.CNC**: CUSIP Name Change - **NC.SNC**: Symbol Name Change - **NC.SCNC**: Symbol & CUSIP Name Change - **SPIN**: Spin-off - **SPLIT.FSPLIT**: Forward Stock Split - **SPLIT.RSPLIT**: Reverse Stock Split - **SPLIT.USPLIT**: Unit Split - **REORG**: Reorganization activity sub-types: - **WRM**: Worthless Removal - **SPLIT**: Stock Split activity sub-types: - **FSPLIT**: Forward Stock Split - **RSPLIT**: Reverse Stock Split - **USPLIT**: Unit Split - **VOF**: Voluntary Offering activity sub-types: - **VTND**: Tender Offer - **VWRT**: Warrant Exercise - **VRGT**: Rights Offer - **VEXH**: Exchange Offer - **WH**: Withholding activity sub-types: - **SWH**: State Withholding - **FWH**: Federal Withholding - **SLWH**: Sales Withholding
      Returns:
      activitySubType

    • setActivitySubType

      public void setActivitySubType(@Nullable String activitySubType)

    • activityType

      public NonTradeActivities activityType(@Nonnull NonTradeActivities.ActivityTypeEnum activityType)

    • getActivityType

      @Nonnull public NonTradeActivities.ActivityTypeEnum getActivityType()
      Get activityType
      Returns:
      activityType

    • setActivityType

      public void setActivityType(@Nonnull NonTradeActivities.ActivityTypeEnum activityType)

    • createdAt

      public NonTradeActivities createdAt(@Nullable OffsetDateTime createdAt)

    • getCreatedAt

      @Nullable public OffsetDateTime getCreatedAt()
      Valid only for non-trading activity types. Null for trading activites.
      Returns:
      createdAt

    • setCreatedAt

      public void setCreatedAt(@Nullable OffsetDateTime createdAt)

    • currency

      public NonTradeActivities currency(@Nullable String currency)

    • getCurrency

      @Nullable public String getCurrency()
      Currency denomination of the activity (e.g. USD). Included in NTA stream events and activity responses.
      Returns:
      currency

    • setCurrency

      public void setCurrency(@Nullable String currency)

    • cusip

      public NonTradeActivities cusip(@Nullable String cusip)

    • getCusip

      @Nullable public String getCusip()
      The CUSIP of the security involved with the activity. Not present for all activity types.
      Returns:
      cusip

    • setCusip

      public void setCusip(@Nullable String cusip)

    • date

      public NonTradeActivities date(@Nullable OffsetDateTime date)

    • getDate

      @Nullable public OffsetDateTime getDate()
      The date on which the activity occurred or on which the transaction associated with the activity settled.
      Returns:
      date

    • setDate

      public void setDate(@Nullable OffsetDateTime date)

    • groupId

      public NonTradeActivities groupId(@Nullable String groupId)

    • getGroupId

      @Nullable public String getGroupId()
      ID used to link activities who share a sibling relationship.
      Returns:
      groupId

    • setGroupId

      public void setGroupId(@Nullable String groupId)

    • id

      public NonTradeActivities id(@Nullable String id)

    • getId

      @Nullable public String getId()
      An ID for the activity, always in \"::\" format. Can be sent as page_token in requests to facilitate the paging of results.
      Returns:
      id

    • setId

      public void setId(@Nullable String id)

    • netAmount

      public NonTradeActivities netAmount(@Nullable String netAmount)

    • getNetAmount

      @Nullable public String getNetAmount()
      The net amount of money (positive or negative) associated with the activity.
      Returns:
      netAmount

    • setNetAmount

      public void setNetAmount(@Nullable String netAmount)

    • perShareAmount

      public NonTradeActivities perShareAmount(@Nullable String perShareAmount)

    • getPerShareAmount

      @Nullable public String getPerShareAmount()
      For dividend activities, the average amount paid per share. Not present for other activity types.
      Returns:
      perShareAmount

    • setPerShareAmount

      public void setPerShareAmount(@Nullable String perShareAmount)

    • qty

      public NonTradeActivities qty(@Nullable String qty)

    • getQty

      @Nullable public String getQty()
      For dividend activities, the number of shares that contributed to the payment. Not present for other activity types.
      Returns:
      qty

    • setQty

      public void setQty(@Nullable String qty)

    • status

      public NonTradeActivities status(@Nullable NonTradeActivities.StatusEnum status)

    • getStatus

      @Nullable public NonTradeActivities.StatusEnum getStatus()
      The activity status.
      Returns:
      status

    • setStatus

      public void setStatus(@Nullable NonTradeActivities.StatusEnum status)

    • symbol

      public NonTradeActivities symbol(@Nullable String symbol)

    • getSymbol

      @Nullable public String getSymbol()
      The symbol of the security involved with the activity. Not present for all activity types.
      Returns:
      symbol

    • setSymbol

      public void setSymbol(@Nullable String symbol)

    • putAdditionalProperty

      public NonTradeActivities 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 NonTradeActivities 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 NonTradeActivities

    • fromJson

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

    • toJson

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