Package markets.alpaca.client.openapi.broker.api

Class IpoApi

java.lang.Object
markets.alpaca.client.openapi.broker.api.IpoApi
public class IpoApi extends Object
Generated client for IpoApi operations.

This class is generated from the configured OpenAPI spec. Operation method Javadocs include OAS summaries, descriptions, parameters, return types, response details, and external documentation links when present in the spec.

Operations

  • getIPOOffering: Retrieve an IPO Offering
  • listIPOOfferings: List IPO Offerings

  • Constructor Details

    • IpoApi

      public IpoApi()

    • IpoApi

      public IpoApi(ApiClient apiClient)

  • Method Details

    • getApiClient

      public ApiClient getApiClient()

    • setApiClient

      public void setApiClient(ApiClient apiClient)

    • getHostIndex

      public int getHostIndex()

    • setHostIndex

      public void setHostIndex(int hostIndex)

    • getCustomBaseUrl

      public String getCustomBaseUrl()

    • setCustomBaseUrl

      public void setCustomBaseUrl(String customBaseUrl)

    • getIPOOfferingCall

      public okhttp3.Call getIPOOfferingCall(@Nonnull String offeringReference, ApiCallback _callback) throws ApiException
      Build call for getIPOOffering
      Parameters:
      offeringReference - The unique offering identifier (also referred to as `ipo_reference` in the response body). (required)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object
      HTTP Response Details:
      Response Details
      Status Code Description Response Headers
      200 The requested IPO offering. -
      404 No IPO offering exists for the given `offering_reference`. -

    • getIPOOffering

      public IPOOfferingResponse getIPOOffering(@Nonnull String offeringReference) throws ApiException
      Retrieve an IPO Offering Returns a single IPO offering by `offering_reference`. The `offering_reference` value matches the one delivered on the [IPO Events Stream](#operation/subscribeToIPOEventsSSE).
      Parameters:
      offeringReference - The unique offering identifier (also referred to as `ipo_reference` in the response body). (required)
      Returns:
      IPOOfferingResponse
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      HTTP Response Details:
      Response Details
      Status Code Description Response Headers
      200 The requested IPO offering. -
      404 No IPO offering exists for the given `offering_reference`. -

    • getIPOOfferingWithHttpInfo

      public ApiResponse<IPOOfferingResponse> getIPOOfferingWithHttpInfo(@Nonnull String offeringReference) throws ApiException
      Retrieve an IPO Offering Returns a single IPO offering by `offering_reference`. The `offering_reference` value matches the one delivered on the [IPO Events Stream](#operation/subscribeToIPOEventsSSE).
      Parameters:
      offeringReference - The unique offering identifier (also referred to as `ipo_reference` in the response body). (required)
      Returns:
      ApiResponse<IPOOfferingResponse>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      HTTP Response Details:
      Response Details
      Status Code Description Response Headers
      200 The requested IPO offering. -
      404 No IPO offering exists for the given `offering_reference`. -

    • getIPOOfferingAsync

      public okhttp3.Call getIPOOfferingAsync(@Nonnull String offeringReference, ApiCallback<IPOOfferingResponse> _callback) throws ApiException
      Retrieve an IPO Offering (asynchronously) Returns a single IPO offering by `offering_reference`. The `offering_reference` value matches the one delivered on the [IPO Events Stream](#operation/subscribeToIPOEventsSSE).
      Parameters:
      offeringReference - The unique offering identifier (also referred to as `ipo_reference` in the response body). (required)
      _callback - The callback to be executed when the API call finishes
      Returns:
      The request call
      Throws:
      ApiException - If fail to process the API call, e.g. serializing the request body object
      HTTP Response Details:
      Response Details
      Status Code Description Response Headers
      200 The requested IPO offering. -
      404 No IPO offering exists for the given `offering_reference`. -

    • listIPOOfferingsCall

      public okhttp3.Call listIPOOfferingsCall(@Nullable String availability, @Nullable String ticker, @Nullable Integer limit, @Nullable String pageToken, ApiCallback _callback) throws ApiException
      Build call for listIPOOfferings
      Parameters:
      availability - Filter by offering availability. - `available` - accepting new orders. - `not_available` - not yet open for orders. - `closed` - no longer accepting orders. (optional)
      ticker - Filter by ticker symbol (case-insensitive exact match). (optional)
      limit - Maximum number of offerings to return per page. Capped at `200`. (optional, default to 50)
      pageToken - Opaque cursor returned in the previous response's `next_page_token` field. Pass it back to fetch the next page. (optional)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object
      HTTP Response Details:
      Response Details
      Status Code Description Response Headers
      200 A page of IPO offerings. -

    • listIPOOfferings

      public IPOOfferingListResponse listIPOOfferings(@Nullable String availability, @Nullable String ticker, @Nullable Integer limit, @Nullable String pageToken) throws ApiException
      List IPO Offerings Returns a paginated list of IPO offerings currently known to Alpaca. Use this endpoint to power IPO discovery surfaces (e.g. an \"Upcoming IPOs\" list). Real-time lifecycle changes (availability, prospectus, 60-minute mail, allocations, cancellations) are pushed over the [IPO Events Stream](#operation/subscribeToIPOEventsSSE).
      Parameters:
      availability - Filter by offering availability. - `available` - accepting new orders. - `not_available` - not yet open for orders. - `closed` - no longer accepting orders. (optional)
      ticker - Filter by ticker symbol (case-insensitive exact match). (optional)
      limit - Maximum number of offerings to return per page. Capped at `200`. (optional, default to 50)
      pageToken - Opaque cursor returned in the previous response's `next_page_token` field. Pass it back to fetch the next page. (optional)
      Returns:
      IPOOfferingListResponse
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      HTTP Response Details:
      Response Details
      Status Code Description Response Headers
      200 A page of IPO offerings. -

    • listIPOOfferingsWithHttpInfo

      public ApiResponse<IPOOfferingListResponse> listIPOOfferingsWithHttpInfo(@Nullable String availability, @Nullable String ticker, @Nullable Integer limit, @Nullable String pageToken) throws ApiException
      List IPO Offerings Returns a paginated list of IPO offerings currently known to Alpaca. Use this endpoint to power IPO discovery surfaces (e.g. an \"Upcoming IPOs\" list). Real-time lifecycle changes (availability, prospectus, 60-minute mail, allocations, cancellations) are pushed over the [IPO Events Stream](#operation/subscribeToIPOEventsSSE).
      Parameters:
      availability - Filter by offering availability. - `available` - accepting new orders. - `not_available` - not yet open for orders. - `closed` - no longer accepting orders. (optional)
      ticker - Filter by ticker symbol (case-insensitive exact match). (optional)
      limit - Maximum number of offerings to return per page. Capped at `200`. (optional, default to 50)
      pageToken - Opaque cursor returned in the previous response's `next_page_token` field. Pass it back to fetch the next page. (optional)
      Returns:
      ApiResponse<IPOOfferingListResponse>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      HTTP Response Details:
      Response Details
      Status Code Description Response Headers
      200 A page of IPO offerings. -

    • listIPOOfferingsAsync

      public okhttp3.Call listIPOOfferingsAsync(@Nullable String availability, @Nullable String ticker, @Nullable Integer limit, @Nullable String pageToken, ApiCallback<IPOOfferingListResponse> _callback) throws ApiException
      List IPO Offerings (asynchronously) Returns a paginated list of IPO offerings currently known to Alpaca. Use this endpoint to power IPO discovery surfaces (e.g. an \"Upcoming IPOs\" list). Real-time lifecycle changes (availability, prospectus, 60-minute mail, allocations, cancellations) are pushed over the [IPO Events Stream](#operation/subscribeToIPOEventsSSE).
      Parameters:
      availability - Filter by offering availability. - `available` - accepting new orders. - `not_available` - not yet open for orders. - `closed` - no longer accepting orders. (optional)
      ticker - Filter by ticker symbol (case-insensitive exact match). (optional)
      limit - Maximum number of offerings to return per page. Capped at `200`. (optional, default to 50)
      pageToken - Opaque cursor returned in the previous response's `next_page_token` field. Pass it back to fetch the next page. (optional)
      _callback - The callback to be executed when the API call finishes
      Returns:
      The request call
      Throws:
      ApiException - If fail to process the API call, e.g. serializing the request body object
      HTTP Response Details:
      Response Details
      Status Code Description Response Headers
      200 A page of IPO offerings. -