Package markets.alpaca.client.ws

Class AlpacaStockStream

java.lang.Object

markets.alpaca.client.ws.internal.AbstractAlpacaStream

markets.alpaca.client.ws.internal.AbstractMarketDataStream

markets.alpaca.client.ws.AlpacaStockStream

All Implemented Interfaces:

AutoCloseable

public final class AlpacaStockStream
extends AbstractMarketDataStream

WebSocket client for the Alpaca real-time stock pricing stream (/v2/{source}).

Usage

 var creds  = new AlpacaCredentials(keyId, secretKey);
 var stream = AlpacaClientFactory.stockStream(
     creds,
     StockSource.IEX,
     AlpacaStreamEnvironment.PRODUCTION,
     new StockStreamListener() {
         @Override public void onTrade(StockTrade t) { System.out.println(t); }
     });

 stream.connect(StockSubscription.builder().trades("AAPL").quotes("AAPL").build());

 // Later:
 stream.close();
 

The client automatically reconnects with jittered exponential backoff on unexpected disconnects and re-subscribes to the previously confirmed symbol set after re-authentication.

Callbacks are dispatched on OkHttp's reader thread by default. Use the overloads that accept an Executor to offload listener work.

Field Summary

Fields inherited from class markets.alpaca.client.ws.internal.AbstractMarketDataStream

GSON

Constructor Summary

Constructors

Constructor	Description
AlpacaStockStream(okhttp3.OkHttpClient httpClient, AlpacaCredentials credentials, String url, StockStreamListener listener)	Creates a new stock stream client for a custom WebSocket URL.
AlpacaStockStream(okhttp3.OkHttpClient httpClient, AlpacaCredentials credentials, StockSource source, AlpacaStreamEnvironment environment, StockStreamListener listener)	Creates a new stock stream client.
AlpacaStockStream(okhttp3.OkHttpClient httpClient, AlpacaCredentials credentials, StockSource source, AlpacaStreamEnvironment environment, StockStreamListener listener, AlpacaStreamReconnectPolicy reconnectPolicy)	Creates a new stock stream client with a custom reconnect policy.
AlpacaStockStream(okhttp3.OkHttpClient httpClient, AlpacaCredentials credentials, StockSource source, AlpacaStreamEnvironment environment, StockStreamListener listener, AlpacaStreamReconnectPolicy reconnectPolicy, Executor callbackExecutor)	Creates a new stock stream client with a custom reconnect policy and listener executor.

Method Summary

Modifier and Type	Method	Description
protected okhttp3.Request	buildRequest()	Builds the WebSocket upgrade request (URL + any auth headers).
void	connect(StockSubscription sub)	Opens the stream and subscribes after authentication completes.
protected void	dispatchDataMessage(com.google.gson.JsonObject msg, String type)	Called for each data message element with a non-control T value.
protected void	handleMarketDataClose(int code, String reason, boolean willReconnect)
protected void	notifyAuthenticated()
protected void	notifyConnected()
protected void	notifyError(int code, String message)
protected void	notifyReconnected()	Called after a reconnect attempt succeeds and the stream is fully re-authenticated (and re-subscribed, if applicable).
protected void	notifyReconnecting(int attempt)	Called just before a reconnect attempt is initiated.
protected void	notifySubscriptionConfirmed(Map<String,List<String>> subscriptions)
void	subscribe(StockSubscription sub)	Subscribes to the given stock channels and symbols.
void	unsubscribe(StockSubscription sub)	Unsubscribes from the given stock channels and symbols.

Methods inherited from class markets.alpaca.client.ws.internal.AbstractMarketDataStream

getConfirmedSubscriptions, handleClose, handleOpen, handleText, resubscribeAfterAuth, sendSubscriptionMessage

Methods inherited from class markets.alpaca.client.ws.internal.AbstractAlpacaStream

authenticationFuture, authenticationResultFuture, close, closeTerminal, closeTerminal, completeAuthentication, completeAuthentication, connect, handleBytes, invokeCallback, isClosed, isReconnecting, requireOpenForCommand, resetReconnectAttempts, send, waitForAuthentication, waitForAuthenticationResult

Methods inherited from class java.lang.Object

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

Constructor Details

AlpacaStockStream

public AlpacaStockStream(okhttp3.OkHttpClient httpClient,
 AlpacaCredentials credentials,
 StockSource source,
 AlpacaStreamEnvironment environment,
 StockStreamListener listener)

Creates a new stock stream client. Use AlpacaClientFactory.stockStream(markets.alpaca.client.AlpacaCredentials, markets.alpaca.client.ws.StockSource, markets.alpaca.client.ws.AlpacaStreamEnvironment, markets.alpaca.client.ws.StockStreamListener) rather than calling this constructor directly.

AlpacaStockStream

public AlpacaStockStream(okhttp3.OkHttpClient httpClient,
 AlpacaCredentials credentials,
 StockSource source,
 AlpacaStreamEnvironment environment,
 StockStreamListener listener,
 AlpacaStreamReconnectPolicy reconnectPolicy)

Creates a new stock stream client with a custom reconnect policy. Use AlpacaClientFactory.stockStream(markets.alpaca.client.AlpacaCredentials, markets.alpaca.client.ws.StockSource, markets.alpaca.client.ws.AlpacaStreamEnvironment, markets.alpaca.client.ws.StockStreamListener) rather than calling this constructor directly.

AlpacaStockStream

public AlpacaStockStream(okhttp3.OkHttpClient httpClient,
 AlpacaCredentials credentials,
 StockSource source,
 AlpacaStreamEnvironment environment,
 StockStreamListener listener,
 AlpacaStreamReconnectPolicy reconnectPolicy,
 Executor callbackExecutor)

Creates a new stock stream client with a custom reconnect policy and listener executor. Use AlpacaClientFactory.stockStream(markets.alpaca.client.AlpacaCredentials, markets.alpaca.client.ws.StockSource, markets.alpaca.client.ws.AlpacaStreamEnvironment, markets.alpaca.client.ws.StockStreamListener) rather than calling this constructor directly.

AlpacaStockStream

public AlpacaStockStream(okhttp3.OkHttpClient httpClient,
 AlpacaCredentials credentials,
 String url,
 StockStreamListener listener)

Creates a new stock stream client for a custom WebSocket URL.

Method Details

buildRequest

protected okhttp3.Request buildRequest()

Description copied from class: AbstractAlpacaStream

Builds the WebSocket upgrade request (URL + any auth headers).

Specified by:

buildRequest in class AbstractAlpacaStream

handleMarketDataClose

protected void handleMarketDataClose(int code,
 String reason,
 boolean willReconnect)

Specified by:

handleMarketDataClose in class AbstractMarketDataStream

notifyReconnecting

protected void notifyReconnecting(int attempt)

Description copied from class: AbstractAlpacaStream

Called just before a reconnect attempt is initiated.

Overrides:

notifyReconnecting in class AbstractAlpacaStream

Parameters:

attempt - 1-based attempt counter

notifyConnected

protected void notifyConnected()

Specified by:

notifyConnected in class AbstractMarketDataStream

notifyAuthenticated

protected void notifyAuthenticated()

Specified by:

notifyAuthenticated in class AbstractMarketDataStream

notifySubscriptionConfirmed

protected void notifySubscriptionConfirmed(Map<String,List<String>> subscriptions)

Specified by:

notifySubscriptionConfirmed in class AbstractMarketDataStream

notifyError

protected void notifyError(int code,
 String message)

Specified by:

notifyError in class AbstractMarketDataStream

notifyReconnected

protected void notifyReconnected()

Description copied from class: AbstractAlpacaStream

Called after a reconnect attempt succeeds and the stream is fully re-authenticated (and re-subscribed, if applicable). Default implementation is a no-op.

Overrides:

notifyReconnected in class AbstractAlpacaStream

dispatchDataMessage

protected void dispatchDataMessage(com.google.gson.JsonObject msg,
 String type)

Description copied from class: AbstractMarketDataStream

Called for each data message element with a non-control T value.

Specified by:

dispatchDataMessage in class AbstractMarketDataStream

Parameters:

msg - the JSON object for this message

type - the T field value (e.g. "t", "q", "b")

subscribe

public void subscribe(StockSubscription sub)

Subscribes to the given stock channels and symbols. Additive — existing subscriptions for channels not mentioned here are preserved. The server will reply with a subscription confirmation; the listener's StockStreamListener.onSubscriptionConfirmed(java.util.Map<java.lang.String, java.util.List<java.lang.String>>) will fire.

Can be called at any time after AbstractAlpacaStream.connect() — if not yet authenticated, the request will be buffered and sent after authentication completes.

connect

public void connect(StockSubscription sub)

Opens the stream and subscribes after authentication completes.

This is equivalent to calling subscribe(StockSubscription) before AbstractAlpacaStream.connect(); the subscription is buffered until the server accepts the credentials.

unsubscribe

public void unsubscribe(StockSubscription sub)

Unsubscribes from the given stock channels and symbols. Subtractive — only the specified symbols are removed from the respective channels.