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

Class IPOOffering

java.lang.Object
markets.alpaca.client.openapi.broker.model.IPOOffering
All Implemented Interfaces:
Serializable
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", comments="Generator version: 7.23.0") public class IPOOffering extends Object implements Serializable
An IPO (Initial Public Offering) offering exposed via the IPO discovery REST API. Returned by `GET /v1/ipos` and `GET /v1/ipos/{offering_reference}`. Most IPO lifecycle changes (new offerings, prospectus availability, 60-minute mail, allocations, cancellations) are pushed in real time over the [IPO Events Stream](#operation/subscribeToIPOEventsSSE).
See Also:

  • Field Details

  • Constructor Details

    • IPOOffering

      public IPOOffering()

  • Method Details

    • anticipatedShares

      public IPOOffering anticipatedShares(@Nullable Long anticipatedShares)

    • getAnticipatedShares

      @Nullable public Long getAnticipatedShares()
      Anticipated total share count for the offering, when known.
      Returns:
      anticipatedShares

    • setAnticipatedShares

      public void setAnticipatedShares(@Nullable Long anticipatedShares)

    • availability

      public IPOOffering availability(@Nonnull IPOOffering.AvailabilityEnum availability)

    • getAvailability

      @Nonnull public IPOOffering.AvailabilityEnum getAvailability()
      Whether the offering is currently accepting orders. - `available` - accepting new orders. - `not_available` - not yet open for orders. - `closed` - no longer accepting orders. Note: the IPO Events Stream uses a different casing for the analogous `payload.available_to_order` field on `Offering`/`OfferingUpdate` events (`Available`, `NotAvailable`, `Closed`).
      Returns:
      availability

    • setAvailability

      public void setAvailability(@Nonnull IPOOffering.AvailabilityEnum availability)

    • cusipId

      public IPOOffering cusipId(@Nullable String cusipId)

    • getCusipId

      @Nullable public String getCusipId()
      CUSIP identifier of the offering.
      Returns:
      cusipId

    • setCusipId

      public void setCusipId(@Nullable String cusipId)

    • description

      public IPOOffering description(@Nullable String description)

    • getDescription

      @Nullable public String getDescription()
      A longer human-readable description of the offering, when available.
      Returns:
      description

    • setDescription

      public void setDescription(@Nullable String description)

    • ipoReference

      public IPOOffering ipoReference(@Nonnull String ipoReference)

    • getIpoReference

      @Nonnull public String getIpoReference()
      The unique offering identifier used across the IPO Events Stream and `/v1/ipos/{offering_reference}`. Note that this value is also used as the path parameter, where it is named `offering_reference`.
      Returns:
      ipoReference

    • setIpoReference

      public void setIpoReference(@Nonnull String ipoReference)

    • logoSmall

      public IPOOffering logoSmall(@Nullable String logoSmall)

    • getLogoSmall

      @Nullable public String getLogoSmall()
      URL to a small logo asset for the issuer.
      Returns:
      logoSmall

    • setLogoSmall

      public void setLogoSmall(@Nullable String logoSmall)

    • maxPrice

      public IPOOffering maxPrice(@Nonnull BigDecimal maxPrice)

    • getMaxPrice

      @Nonnull public BigDecimal getMaxPrice()
      Upper bound of the indicated price range.
      Returns:
      maxPrice

    • setMaxPrice

      public void setMaxPrice(@Nonnull BigDecimal maxPrice)

    • maxTicketSize

      public IPOOffering maxTicketSize(@Nullable String maxTicketSize)

    • getMaxTicketSize

      @Nullable public String getMaxTicketSize()
      Maximum allowed order amount.
      Returns:
      maxTicketSize

    • setMaxTicketSize

      public void setMaxTicketSize(@Nullable String maxTicketSize)

    • minPrice

      public IPOOffering minPrice(@Nonnull BigDecimal minPrice)

    • getMinPrice

      @Nonnull public BigDecimal getMinPrice()
      Lower bound of the indicated price range.
      Returns:
      minPrice

    • setMinPrice

      public void setMinPrice(@Nonnull BigDecimal minPrice)

    • minTicketSize

      public IPOOffering minTicketSize(@Nullable String minTicketSize)

    • getMinTicketSize

      @Nullable public String getMinTicketSize()
      Minimum allowed order amount.
      Returns:
      minTicketSize

    • setMinTicketSize

      public void setMinTicketSize(@Nullable String minTicketSize)

    • name

      public IPOOffering name(@Nonnull String name)

    • getName

      @Nonnull public String getName()
      The official name of the offering.
      Returns:
      name

    • setName

      public void setName(@Nonnull String name)

    • noNewOrders

      public IPOOffering noNewOrders(@Nonnull Boolean noNewOrders)

    • getNoNewOrders

      @Nonnull public Boolean getNoNewOrders()
      When `true`, the offering is in its 60-minute pricing window and is not accepting new orders. This mirrors the `SixtyMinMail` event on the IPO Events Stream.
      Returns:
      noNewOrders

    • setNoNewOrders

      public void setNoNewOrders(@Nonnull Boolean noNewOrders)

    • offeringType

      public IPOOffering offeringType(@Nonnull String offeringType)

    • getOfferingType

      @Nonnull public String getOfferingType()
      The type of offering. Currently always `IPO`.
      Returns:
      offeringType

    • setOfferingType

      public void setOfferingType(@Nonnull String offeringType)

    • prospectusUrl

      public IPOOffering prospectusUrl(@Nullable String prospectusUrl)

    • getProspectusUrl

      @Nullable public String getProspectusUrl()
      URL to the prospectus document. Mirrors the `prospectus_url` payload of the corresponding `Prospectus` event on the IPO Events Stream.
      Returns:
      prospectusUrl

    • setProspectusUrl

      public void setProspectusUrl(@Nullable String prospectusUrl)

    • settlementDate

      public IPOOffering settlementDate(@Nullable LocalDate settlementDate)

    • getSettlementDate

      @Nullable public LocalDate getSettlementDate()
      Anticipated settlement date.
      Returns:
      settlementDate

    • setSettlementDate

      public void setSettlementDate(@Nullable LocalDate settlementDate)

    • tickerSymbol

      public IPOOffering tickerSymbol(@Nullable String tickerSymbol)

    • getTickerSymbol

      @Nullable public String getTickerSymbol()
      The ticker symbol that will be used once the security begins trading on the secondary market.
      Returns:
      tickerSymbol

    • setTickerSymbol

      public void setTickerSymbol(@Nullable String tickerSymbol)

    • tradeDate

      public IPOOffering tradeDate(@Nullable LocalDate tradeDate)

    • getTradeDate

      @Nullable public LocalDate getTradeDate()
      Anticipated first trading date on the secondary market.
      Returns:
      tradeDate

    • setTradeDate

      public void setTradeDate(@Nullable LocalDate tradeDate)

    • underwriters

      public IPOOffering underwriters(@Nullable List<String> underwriters)

    • addUnderwritersItem

      public IPOOffering addUnderwritersItem(String underwritersItem)

    • getUnderwriters

      @Nullable public List<String> getUnderwriters()
      List of underwriter names participating in the offering.
      Returns:
      underwriters

    • setUnderwriters

      public void setUnderwriters(@Nullable List<String> underwriters)

    • unitStepSize

      public IPOOffering unitStepSize(@Nullable String unitStepSize)

    • getUnitStepSize

      @Nullable public String getUnitStepSize()
      The minimum increment in which order quantities can be specified.
      Returns:
      unitStepSize

    • setUnitStepSize

      public void setUnitStepSize(@Nullable String unitStepSize)

    • putAdditionalProperty

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

    • fromJson

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

    • toJson

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