Package markets.alpaca.client.broker.sse

Class BrokerEventsSseClient

java.lang.Object

markets.alpaca.client.broker.sse.BrokerEventsSseClient

public final class BrokerEventsSseClient
extends Object

Streaming wrapper for Broker Events SSE endpoints.

The generated EventsApi exposes SSE endpoints as ordinary blocking REST calls, which can hang indefinitely for live streams. This wrapper reuses the generated request builders for path, query parameters, and authentication, then opens them through OkHttp's SSE client.

Constructor Summary

Constructors

Constructor	Description
BrokerEventsSseClient(EventsApi eventsApi)	Creates an SSE wrapper around a generated Broker EventsApi.
BrokerEventsSseClient(EventsApi eventsApi, Executor callbackExecutor)	Creates an SSE wrapper around a generated Broker EventsApi.
BrokerEventsSseClient(ApiClient apiClient)	Creates an SSE wrapper from a generated Broker ApiClient.
BrokerEventsSseClient(ApiClient apiClient, Executor callbackExecutor)	Creates an SSE wrapper from a generated Broker ApiClient.

Method Summary

Modifier and Type	Method	Description
BrokerSseSubscription	subscribeToAccountStatus(LocalDate since, LocalDate until, Integer sinceId, Integer untilId, String sinceUlid, String untilUlid, String id, BrokerSseEventListener<AccountStatusEvent> listener)	Opens the Broker account status SSE stream with explicit legacy cursor filters.
BrokerSseSubscription	subscribeToAccountStatus(BrokerSseIdentifiedLegacyDateOptions options, BrokerSseEventListener<AccountStatusEvent> listener)	Opens the Broker account status SSE stream.
BrokerSseSubscription	subscribeToActivities(OffsetDateTime since, OffsetDateTime until, String sinceId, String untilId, BrokerSseEventListener<ActivityEventV2> listener)	Opens the Broker activities SSE stream with explicit date/time cursor filters.
BrokerSseSubscription	subscribeToActivities(BrokerSseDateTimeOptions options, BrokerSseEventListener<ActivityEventV2> listener)	Opens the Broker activities SSE stream.
BrokerSseSubscription	subscribeToAdminActions(OffsetDateTime since, OffsetDateTime until, String sinceId, String untilId, BrokerSseEventListener<SubscribeToAdminActionSSE200ResponseInner> listener)	Opens the Broker admin actions SSE stream with explicit date/time cursor filters.
BrokerSseSubscription	subscribeToAdminActions(BrokerSseDateTimeOptions options, BrokerSseEventListener<SubscribeToAdminActionSSE200ResponseInner> listener)	Opens the Broker admin actions SSE stream.
BrokerSseSubscription	subscribeToFundingStatus(LocalDate since, LocalDate until, String sinceId, String untilId, BrokerSseEventListener<SubscribeToFundingStatusSSE200ResponseInner> listener)	Opens the Broker funding status SSE stream with explicit date cursor filters.
BrokerSseSubscription	subscribeToFundingStatus(BrokerSseDateOptions options, BrokerSseEventListener<SubscribeToFundingStatusSSE200ResponseInner> listener)	Opens the Broker funding status SSE stream.
BrokerSseSubscription	subscribeToIpoEvents(OffsetDateTime since, OffsetDateTime until, String sinceId, String untilId, BrokerSseEventListener<IPOEvent> listener)	Opens the Broker IPO events SSE stream with explicit date/time cursor filters.
BrokerSseSubscription	subscribeToIpoEvents(BrokerSseDateTimeOptions options, BrokerSseEventListener<IPOEvent> listener)	Opens the Broker IPO events SSE stream.
BrokerSseSubscription	subscribeToJournalStatus(OffsetDateTime since, OffsetDateTime until, String sinceId, String untilId, String id, BrokerSseEventListener<JournalStatusEventV2> listener)	Opens the current Broker journal status SSE stream with explicit date/time cursor filters.
BrokerSseSubscription	subscribeToJournalStatus(BrokerSseIdentifiedDateTimeOptions options, BrokerSseEventListener<JournalStatusEventV2> listener)	Opens the current Broker journal status SSE stream.
BrokerSseSubscription	subscribeToJournalStatusLegacy(LocalDate since, LocalDate until, Integer sinceId, Integer untilId, String sinceUlid, String untilUlid, String id, BrokerSseEventListener<JournalStatusEvent> listener)	Opens the legacy Broker journal status SSE stream with explicit legacy cursor filters.
BrokerSseSubscription	subscribeToJournalStatusLegacy(BrokerSseIdentifiedLegacyDateOptions options, BrokerSseEventListener<JournalStatusEvent> listener)	Opens the legacy Broker journal status SSE stream.
BrokerSseSubscription	subscribeToNonTradingActivities(String id, LocalDate since, LocalDate until, Integer sinceId, Integer untilId, String sinceUlid, String untilUlid, Boolean includePreprocessing, UUID groupId, BrokerSseEventListener<NonTradeActivityEvent> listener)	Opens the Broker non-trading activities SSE stream with explicit filter parameters.
BrokerSseSubscription	subscribeToNonTradingActivities(BrokerSseNonTradingActivitiesOptions options, BrokerSseEventListener<NonTradeActivityEvent> listener)	Opens the Broker non-trading activities SSE stream.
BrokerSseSubscription	subscribeToSystemEvents(OffsetDateTime since, OffsetDateTime until, String sinceId, String untilId, BrokerSseEventListener<SystemEventV2> listener)	Opens the Broker system events SSE stream with explicit date/time cursor filters.
BrokerSseSubscription	subscribeToSystemEvents(BrokerSseDateTimeOptions options, BrokerSseEventListener<SystemEventV2> listener)	Opens the Broker system events SSE stream.
BrokerSseSubscription	subscribeToTradeEvents(LocalDate since, LocalDate until, String sinceId, String untilId, BrokerSseEventListener<TradeUpdateEventV2> listener)	Opens the Broker trade events SSE stream with explicit date cursor filters.
BrokerSseSubscription	subscribeToTradeEvents(BrokerSseDateOptions options, BrokerSseEventListener<TradeUpdateEventV2> listener)	Opens the Broker trade events SSE stream.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

BrokerEventsSseClient

public BrokerEventsSseClient(EventsApi eventsApi)

Creates an SSE wrapper around a generated Broker EventsApi.

BrokerEventsSseClient

public BrokerEventsSseClient(EventsApi eventsApi,
 Executor callbackExecutor)

Creates an SSE wrapper around a generated Broker EventsApi.

BrokerEventsSseClient

public BrokerEventsSseClient(ApiClient apiClient)

Creates an SSE wrapper from a generated Broker ApiClient.

BrokerEventsSseClient

public BrokerEventsSseClient(ApiClient apiClient,
 Executor callbackExecutor)

Creates an SSE wrapper from a generated Broker ApiClient.

Method Details

subscribeToNonTradingActivities

public BrokerSseSubscription subscribeToNonTradingActivities(BrokerSseNonTradingActivitiesOptions options,
 BrokerSseEventListener<NonTradeActivityEvent> listener)
                                                      throws ApiException

Opens the Broker non-trading activities SSE stream.

The generated OpenAPI operation is getV1EventsNta. Use the options object for the date/id cursor filters documented in the Broker OpenAPI spec.

Throws:

ApiException

subscribeToNonTradingActivities

public BrokerSseSubscription subscribeToNonTradingActivities(String id,
 LocalDate since,
 LocalDate until,
 Integer sinceId,
 Integer untilId,
 String sinceUlid,
 String untilUlid,
 Boolean includePreprocessing,
 UUID groupId,
 BrokerSseEventListener<NonTradeActivityEvent> listener)
                                                      throws ApiException

Opens the Broker non-trading activities SSE stream with explicit filter parameters.

Throws:

ApiException

subscribeToActivities

public BrokerSseSubscription subscribeToActivities(BrokerSseDateTimeOptions options,
 BrokerSseEventListener<ActivityEventV2> listener)
                                            throws ApiException

Opens the Broker activities SSE stream.

Throws:

ApiException

subscribeToActivities

public BrokerSseSubscription subscribeToActivities(OffsetDateTime since,
 OffsetDateTime until,
 String sinceId,
 String untilId,
 BrokerSseEventListener<ActivityEventV2> listener)
                                            throws ApiException

Opens the Broker activities SSE stream with explicit date/time cursor filters.

Throws:

ApiException

subscribeToAdminActions

public BrokerSseSubscription subscribeToAdminActions(BrokerSseDateTimeOptions options,
 BrokerSseEventListener<SubscribeToAdminActionSSE200ResponseInner> listener)
                                              throws ApiException

Opens the Broker admin actions SSE stream.

Throws:

ApiException

subscribeToAdminActions

public BrokerSseSubscription subscribeToAdminActions(OffsetDateTime since,
 OffsetDateTime until,
 String sinceId,
 String untilId,
 BrokerSseEventListener<SubscribeToAdminActionSSE200ResponseInner> listener)
                                              throws ApiException

Opens the Broker admin actions SSE stream with explicit date/time cursor filters.

Throws:

ApiException

subscribeToFundingStatus

public BrokerSseSubscription subscribeToFundingStatus(BrokerSseDateOptions options,
 BrokerSseEventListener<SubscribeToFundingStatusSSE200ResponseInner> listener)
                                               throws ApiException

Opens the Broker funding status SSE stream.

Throws:

ApiException

subscribeToFundingStatus

public BrokerSseSubscription subscribeToFundingStatus(LocalDate since,
 LocalDate until,
 String sinceId,
 String untilId,
 BrokerSseEventListener<SubscribeToFundingStatusSSE200ResponseInner> listener)
                                               throws ApiException

Opens the Broker funding status SSE stream with explicit date cursor filters.

Throws:

ApiException

subscribeToIpoEvents

public BrokerSseSubscription subscribeToIpoEvents(BrokerSseDateTimeOptions options,
 BrokerSseEventListener<IPOEvent> listener)
                                           throws ApiException

Opens the Broker IPO events SSE stream.

Throws:

ApiException

subscribeToIpoEvents

public BrokerSseSubscription subscribeToIpoEvents(OffsetDateTime since,
 OffsetDateTime until,
 String sinceId,
 String untilId,
 BrokerSseEventListener<IPOEvent> listener)
                                           throws ApiException

Opens the Broker IPO events SSE stream with explicit date/time cursor filters.

Throws:

ApiException

subscribeToJournalStatusLegacy

public BrokerSseSubscription subscribeToJournalStatusLegacy(BrokerSseIdentifiedLegacyDateOptions options,
 BrokerSseEventListener<JournalStatusEvent> listener)
                                                     throws ApiException

Opens the legacy Broker journal status SSE stream.

Throws:

ApiException

subscribeToJournalStatusLegacy

public BrokerSseSubscription subscribeToJournalStatusLegacy(LocalDate since,
 LocalDate until,
 Integer sinceId,
 Integer untilId,
 String sinceUlid,
 String untilUlid,
 String id,
 BrokerSseEventListener<JournalStatusEvent> listener)
                                                     throws ApiException

Opens the legacy Broker journal status SSE stream with explicit legacy cursor filters.

Throws:

ApiException

subscribeToJournalStatus

public BrokerSseSubscription subscribeToJournalStatus(BrokerSseIdentifiedDateTimeOptions options,
 BrokerSseEventListener<JournalStatusEventV2> listener)
                                               throws ApiException

Opens the current Broker journal status SSE stream.

Throws:

ApiException

subscribeToJournalStatus

public BrokerSseSubscription subscribeToJournalStatus(OffsetDateTime since,
 OffsetDateTime until,
 String sinceId,
 String untilId,
 String id,
 BrokerSseEventListener<JournalStatusEventV2> listener)
                                               throws ApiException

Opens the current Broker journal status SSE stream with explicit date/time cursor filters.

Throws:

ApiException

subscribeToSystemEvents

public BrokerSseSubscription subscribeToSystemEvents(BrokerSseDateTimeOptions options,
 BrokerSseEventListener<SystemEventV2> listener)
                                              throws ApiException

Opens the Broker system events SSE stream.

Throws:

ApiException

subscribeToSystemEvents

public BrokerSseSubscription subscribeToSystemEvents(OffsetDateTime since,
 OffsetDateTime until,
 String sinceId,
 String untilId,
 BrokerSseEventListener<SystemEventV2> listener)
                                              throws ApiException

Opens the Broker system events SSE stream with explicit date/time cursor filters.

Throws:

ApiException

subscribeToTradeEvents

public BrokerSseSubscription subscribeToTradeEvents(BrokerSseDateOptions options,
 BrokerSseEventListener<TradeUpdateEventV2> listener)
                                             throws ApiException

Opens the Broker trade events SSE stream.

Throws:

ApiException

subscribeToTradeEvents

public BrokerSseSubscription subscribeToTradeEvents(LocalDate since,
 LocalDate until,
 String sinceId,
 String untilId,
 BrokerSseEventListener<TradeUpdateEventV2> listener)
                                             throws ApiException

Opens the Broker trade events SSE stream with explicit date cursor filters.

Throws:

ApiException

subscribeToAccountStatus

public BrokerSseSubscription subscribeToAccountStatus(BrokerSseIdentifiedLegacyDateOptions options,
 BrokerSseEventListener<AccountStatusEvent> listener)
                                               throws ApiException

Opens the Broker account status SSE stream.

Throws:

ApiException

subscribeToAccountStatus

public BrokerSseSubscription subscribeToAccountStatus(LocalDate since,
 LocalDate until,
 Integer sinceId,
 Integer untilId,
 String sinceUlid,
 String untilUlid,
 String id,
 BrokerSseEventListener<AccountStatusEvent> listener)
                                               throws ApiException

Opens the Broker account status SSE stream with explicit legacy cursor filters.

Throws:

ApiException