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

Class IPOEvent

java.lang.Object
markets.alpaca.client.openapi.broker.model.IPOEvent
All Implemented Interfaces:
Serializable
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", comments="Generator version: 7.23.0") public class IPOEvent extends Object implements Serializable
Represents an IPO offering lifecycle event delivered over the IPO events streaming API (`/v2/events/ipos`). IPO events come in six `verb` types: - **`Offering`** - initial publication of an offering. The `payload` carries `name`, `available_to_order`, `ticker_symbol`, `min_price`, `max_price` (and optional `source`). - **`OfferingUpdate`** - update to a previously published offering. The `payload` shape is identical to `Offering`. - **`Prospectus`** - prospectus document is now available. The `payload` carries `prospectus_url` and `subject`. - **`SixtyMinMail`** - 60-minute pricing window has opened, no new orders accepted. The `payload` carries `sixty_minute_expiration_time` and `subject`. - **`Allocation`** - final allocation result for a specific account. The `payload` carries `cusip_id`, `final_price`, `allocated_shares`, `allocated_amount`, `subject`. **This is the only verb that is account-scoped**: `account_id` and `correspondent` are populated. - **`OfferingCancellation`** - offering was cancelled. **No `payload` is present.** See the example payloads below for a concrete example per verb.
See Also:

  • Field Details

  • Constructor Details

    • IPOEvent

      public IPOEvent()

  • Method Details

    • accountId

      public IPOEvent accountId(@Nullable UUID accountId)

    • getAccountId

      @Nullable public UUID getAccountId()
      The account this event applies to. Only populated for `Allocation` events; omitted for system-wide verbs (`Offering`, `OfferingUpdate`, `Prospectus`, `SixtyMinMail`, `OfferingCancellation`).
      Returns:
      accountId

    • setAccountId

      public void setAccountId(@Nullable UUID accountId)

    • at

      public IPOEvent at(@Nonnull OffsetDateTime at)

    • getAt

      @Nonnull public OffsetDateTime getAt()
      Timestamp the event was emitted by the streaming service.
      Returns:
      at

    • setAt

      public void setAt(@Nonnull OffsetDateTime at)

    • correspondent

      public IPOEvent correspondent(@Nullable String correspondent)

    • getCorrespondent

      @Nullable public String getCorrespondent()
      The correspondent that owns the account. Only populated for `Allocation` events.
      Returns:
      correspondent

    • setCorrespondent

      public void setCorrespondent(@Nullable String correspondent)

    • eventId

      public IPOEvent eventId(@Nonnull String eventId)

    • getEventId

      @Nonnull public String getEventId()
      Lexically sortable, monotonically increasing identifier for this event. Use this value with `since_id`/`until_id` to resume the stream from a known point.
      Returns:
      eventId

    • setEventId

      public void setEventId(@Nonnull String eventId)

    • offeringReference

      public IPOEvent offeringReference(@Nonnull String offeringReference)

    • getOfferingReference

      @Nonnull public String getOfferingReference()
      The IPO offering this event refers to. Use this value with `GET /v1/ipos/{offering_reference}` to fetch the full offering metadata.
      Returns:
      offeringReference

    • setOfferingReference

      public void setOfferingReference(@Nonnull String offeringReference)

    • payload

      public IPOEvent payload(@Nullable Object payload)

    • getPayload

      @Nullable public Object getPayload()
      Verb-specific payload. The shape varies by `verb` - see schema description and `components/examples` for the structure of each. **Omitted entirely for `OfferingCancellation`.**
      Returns:
      payload

    • setPayload

      public void setPayload(@Nullable Object payload)

    • receivedAt

      public IPOEvent receivedAt(@Nonnull OffsetDateTime receivedAt)

    • getReceivedAt

      @Nonnull public OffsetDateTime getReceivedAt()
      Timestamp the upstream event was first received by Alpaca's IPO ingestion pipeline (before fanout).
      Returns:
      receivedAt

    • setReceivedAt

      public void setReceivedAt(@Nonnull OffsetDateTime receivedAt)

    • verb

      public IPOEvent verb(@Nonnull IPOEvent.VerbEnum verb)

    • getVerb

      @Nonnull public IPOEvent.VerbEnum getVerb()
      The IPO event type. Determines the shape of `payload`.
      Returns:
      verb

    • setVerb

      public void setVerb(@Nonnull IPOEvent.VerbEnum verb)

    • putAdditionalProperty

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

    • fromJson

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

    • toJson

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