Package markets.alpaca.client

Class AlpacaClientFactory

java.lang.Object

markets.alpaca.client.AlpacaClientFactory

public final class AlpacaClientFactory
extends Object

Entry point for creating pre-configured Alpaca API clients (REST and WebSocket).

For most applications, prefer client(AlpacaCredentials) or AlpacaClient.builder(AlpacaCredentials). AlpacaClient is an immutable facade that owns configured generated REST clients internally and exposes narrower workflow helpers. Use the builder when Trading, Market Data, and Broker credentials differ.

The *Client(...) methods return the generated ApiClient for the corresponding REST API, wired with the correct authentication scheme and a shared OkHttp client. Each REST API has its own ApiClient class with a different default base URL and server configuration. Overloads that accept OkHttpClient let applications use distinct transport settings for Broker, Market Data, Trading, WebSocket, or SSE workloads.

Thread safety: the shared OkHttpClient is safe to use concurrently, but the generated REST ApiClient instances are mutable. Configure base paths, default headers, JSON settings, and custom HTTP clients before sharing an ApiClient across threads. Prefer one fully configured ApiClient per API/environment/credential set, then share that instance read-only.

Resiliency: configure HTTP timeouts, logging, retry/backoff interceptors, proxies, and connection-pool settings on the supplied OkHttpClient. Keep application-level retries conservative around non-idempotent operations such as order placement, account creation, and transfers.

Example — Trading REST API

 var creds   = AlpacaCredentials.fromTradingApiEnvironmentVariables();
 var client = AlpacaClientFactory.client(creds);
 // default environment: TradingApiEnvironment.PAPER
 var liveClient = AlpacaClientFactory.client(creds, TradingApiEnvironment.PRODUCTION);

 var openOrders = client.orders().list(ListOrdersRequest.builder()
     .status(ListOrdersRequest.Status.OPEN)
     .symbols("AAPL")
     .limit(50)
     .build());

 // Escape hatch: create a fresh mutable generated client.
 var trading = client.newTradingClient();
 var ordersApi = new markets.alpaca.client.openapi.trading.api.OrdersApi(trading);
 

Example — Broker REST API

 var creds  = AlpacaCredentials.fromBrokerApiEnvironmentVariables();
 var broker = AlpacaClientFactory.brokerClient(creds);
 // default environment: BrokerApiEnvironment.SANDBOX
 var prodBroker = AlpacaClientFactory.brokerClient(creds, BrokerApiEnvironment.PRODUCTION);

 var accountsApi = new markets.alpaca.client.openapi.broker.api.AccountsApi(broker);
 

Example — Stock WebSocket stream

 var stream = AlpacaClientFactory.stockStream(
     creds, StockSource.IEX, AlpacaStreamEnvironment.PRODUCTION,
     new StockStreamListener() {
         public void onTrade(StockTrade t) { System.out.println(t); }
     });
 stream.connect(StockSubscription.builder().trades("AAPL").build());
 // later:
 stream.close();
 

NOTE: This file references classes generated by ./gradlew generateApis. Run that task at least once before opening the project in your IDE.

Method Summary

Modifier and Type	Method	Description
static ApiClient	brokerClient(AlpacaCredentials credentials)	Creates a Broker ApiClient for the sandbox environment with HTTP Basic authentication and default timeouts.
static ApiClient	brokerClient(AlpacaCredentials credentials, String baseUrl)	Creates a Broker ApiClient for a custom base URL with default timeouts.
static ApiClient	brokerClient(AlpacaCredentials credentials, String baseUrl, okhttp3.OkHttpClient httpClient)	Creates a Broker ApiClient for a custom base URL and HTTP client.
static ApiClient	brokerClient(AlpacaCredentials credentials, BrokerApiEnvironment environment)	Creates a Broker ApiClient for the requested environment with HTTP Basic authentication and default timeouts.
static ApiClient	brokerClient(AlpacaCredentials credentials, BrokerApiEnvironment environment, okhttp3.OkHttpClient httpClient)	Creates a Broker ApiClient for the requested environment and HTTP client.
static ApiClient	brokerClient(AlpacaCredentials credentials, okhttp3.OkHttpClient httpClient)	Creates a sandbox Broker ApiClient with HTTP Basic authentication and a custom OkHttpClient (e.g.
static BrokerEventsSseClient	brokerEventsSseClient(AlpacaCredentials credentials)	Creates a Broker Events SSE client with HTTP Basic authentication and default timeouts.
static BrokerEventsSseClient	brokerEventsSseClient(AlpacaCredentials credentials, Executor callbackExecutor)	Creates a Broker Events SSE client with HTTP Basic authentication and a custom listener executor.
static BrokerEventsSseClient	brokerEventsSseClient(ApiClient brokerClient)	Creates a Broker Events SSE client from an existing generated Broker ApiClient.
static BrokerEventsSseClient	brokerEventsSseClient(ApiClient brokerClient, Executor callbackExecutor)	Creates a Broker Events SSE client from an existing Broker client and callback executor.
static AlpacaClient	client(AlpacaCredentials credentials)	Creates an immutable client facade using default REST settings.
static AlpacaClient	client(AlpacaCredentials credentials, TradingApiEnvironment tradingEnvironment)	Creates an immutable client facade in the requested Trading environment.
static AlpacaClient	client(AlpacaCredentials credentials, TradingApiEnvironment tradingEnvironment, okhttp3.OkHttpClient httpClient)	Creates an immutable client facade using the requested Trading environment and one shared HTTP client.
static AlpacaClient	client(AlpacaCredentials credentials, okhttp3.OkHttpClient httpClient)	Creates an immutable client facade using one shared HTTP client.
static AlpacaCryptoStream	cryptoStream(AlpacaCredentials credentials, String baseUrl, CryptoStreamListener listener)	Creates a crypto pricing WebSocket stream client for a custom stream base URL.
static AlpacaCryptoStream	cryptoStream(AlpacaCredentials credentials, String baseUrl, CryptoStreamListener listener, okhttp3.OkHttpClient httpClient)	Creates a crypto pricing WebSocket stream client for a custom stream base URL and HTTP client.
static AlpacaCryptoStream	cryptoStream(AlpacaCredentials credentials, AlpacaStreamEnvironment environment, CryptoStreamListener listener)	Creates a crypto pricing WebSocket stream client.
static AlpacaCryptoStream	cryptoStream(AlpacaCredentials credentials, AlpacaStreamEnvironment environment, CryptoStreamListener listener, Executor callbackExecutor)	Creates a crypto pricing WebSocket stream client with a custom listener executor.
static AlpacaCryptoStream	cryptoStream(AlpacaCredentials credentials, AlpacaStreamEnvironment environment, CryptoStreamListener listener, AlpacaStreamReconnectPolicy reconnectPolicy)	Creates a crypto pricing WebSocket stream client with a custom reconnect policy.
static AlpacaCryptoStream	cryptoStream(AlpacaCredentials credentials, AlpacaStreamEnvironment environment, CryptoStreamListener listener, okhttp3.OkHttpClient httpClient)	Creates a crypto pricing WebSocket stream client with a custom OkHttpClient.
static AlpacaCryptoStream	cryptoStream(AlpacaCredentials credentials, AlpacaStreamEnvironment environment, CryptoStreamListener listener, okhttp3.OkHttpClient httpClient, Executor callbackExecutor)	Creates a crypto pricing WebSocket stream client with a custom OkHttpClient and listener executor.
static AlpacaCryptoStream	cryptoStream(AlpacaCredentials credentials, AlpacaStreamEnvironment environment, CryptoStreamListener listener, okhttp3.OkHttpClient httpClient, AlpacaStreamReconnectPolicy reconnectPolicy)	Creates a crypto pricing WebSocket stream client with a custom OkHttpClient and reconnect policy.
static AlpacaCryptoStream	cryptoStream(AlpacaCredentials credentials, AlpacaStreamEnvironment environment, CryptoStreamListener listener, okhttp3.OkHttpClient httpClient, AlpacaStreamReconnectPolicy reconnectPolicy, Executor callbackExecutor)	Creates a crypto pricing WebSocket stream client with a custom OkHttpClient, reconnect policy, and listener executor.
static ApiClient	dataClient(AlpacaCredentials credentials)	Creates a Data ApiClient with API-key header authentication and default timeouts.
static ApiClient	dataClient(AlpacaCredentials credentials, String baseUrl)	Creates a Data ApiClient for a custom base URL with default timeouts.
static ApiClient	dataClient(AlpacaCredentials credentials, String baseUrl, okhttp3.OkHttpClient httpClient)	Creates a Data ApiClient for a custom base URL and HTTP client.
static ApiClient	dataClient(AlpacaCredentials credentials, okhttp3.OkHttpClient httpClient)	Creates a Data ApiClient with a custom OkHttpClient.
static AlpacaNewsStream	newsStream(AlpacaCredentials credentials, String baseUrl, NewsStreamListener listener)	Creates a real-time news WebSocket stream client for a custom stream base URL.
static AlpacaNewsStream	newsStream(AlpacaCredentials credentials, String baseUrl, NewsStreamListener listener, okhttp3.OkHttpClient httpClient)	Creates a real-time news WebSocket stream client for a custom stream base URL and HTTP client.
static AlpacaNewsStream	newsStream(AlpacaCredentials credentials, AlpacaStreamEnvironment environment, NewsStreamListener listener)	Creates a real-time news WebSocket stream client.
static AlpacaNewsStream	newsStream(AlpacaCredentials credentials, AlpacaStreamEnvironment environment, NewsStreamListener listener, Executor callbackExecutor)	Creates a real-time news WebSocket stream client with a custom listener executor.
static AlpacaNewsStream	newsStream(AlpacaCredentials credentials, AlpacaStreamEnvironment environment, NewsStreamListener listener, AlpacaStreamReconnectPolicy reconnectPolicy)	Creates a real-time news WebSocket stream client with a custom reconnect policy.
static AlpacaNewsStream	newsStream(AlpacaCredentials credentials, AlpacaStreamEnvironment environment, NewsStreamListener listener, okhttp3.OkHttpClient httpClient)	Creates a real-time news WebSocket stream client with a custom OkHttpClient.
static AlpacaNewsStream	newsStream(AlpacaCredentials credentials, AlpacaStreamEnvironment environment, NewsStreamListener listener, okhttp3.OkHttpClient httpClient, Executor callbackExecutor)	Creates a real-time news WebSocket stream client with a custom OkHttpClient and listener executor.
static AlpacaNewsStream	newsStream(AlpacaCredentials credentials, AlpacaStreamEnvironment environment, NewsStreamListener listener, okhttp3.OkHttpClient httpClient, AlpacaStreamReconnectPolicy reconnectPolicy)	Creates a real-time news WebSocket stream client with a custom OkHttpClient and reconnect policy.
static AlpacaNewsStream	newsStream(AlpacaCredentials credentials, AlpacaStreamEnvironment environment, NewsStreamListener listener, okhttp3.OkHttpClient httpClient, AlpacaStreamReconnectPolicy reconnectPolicy, Executor callbackExecutor)	Creates a real-time news WebSocket stream client with a custom OkHttpClient, reconnect policy, and listener executor.
static AlpacaOrders	orders(ApiClient tradingClient)	Creates a handwritten convenience facade for common Trading order workflows.
static AlpacaStocks	stocks(ApiClient dataClient)	Creates a handwritten convenience facade for common Market Data stock workflows.
static AlpacaStockStream	stockStream(AlpacaCredentials credentials, StockSource source, String baseUrl, StockStreamListener listener)	Creates a stock pricing WebSocket stream client for a custom stream base URL.
static AlpacaStockStream	stockStream(AlpacaCredentials credentials, StockSource source, String baseUrl, StockStreamListener listener, okhttp3.OkHttpClient httpClient)	Creates a stock pricing WebSocket stream client for a custom stream base URL and HTTP client.
static AlpacaStockStream	stockStream(AlpacaCredentials credentials, StockSource source, AlpacaStreamEnvironment environment, StockStreamListener listener)	Creates a stock pricing WebSocket stream client.
static AlpacaStockStream	stockStream(AlpacaCredentials credentials, StockSource source, AlpacaStreamEnvironment environment, StockStreamListener listener, Executor callbackExecutor)	Creates a stock pricing WebSocket stream client with a custom listener executor.
static AlpacaStockStream	stockStream(AlpacaCredentials credentials, StockSource source, AlpacaStreamEnvironment environment, StockStreamListener listener, AlpacaStreamReconnectPolicy reconnectPolicy)	Creates a stock pricing WebSocket stream client with a custom reconnect policy.
static AlpacaStockStream	stockStream(AlpacaCredentials credentials, StockSource source, AlpacaStreamEnvironment environment, StockStreamListener listener, okhttp3.OkHttpClient httpClient)	Creates a stock pricing WebSocket stream client with a custom OkHttpClient.
static AlpacaStockStream	stockStream(AlpacaCredentials credentials, StockSource source, AlpacaStreamEnvironment environment, StockStreamListener listener, okhttp3.OkHttpClient httpClient, Executor callbackExecutor)	Creates a stock pricing WebSocket stream client with a custom OkHttpClient and listener executor.
static AlpacaStockStream	stockStream(AlpacaCredentials credentials, StockSource source, AlpacaStreamEnvironment environment, StockStreamListener listener, okhttp3.OkHttpClient httpClient, AlpacaStreamReconnectPolicy reconnectPolicy)	Creates a stock pricing WebSocket stream client with a custom OkHttpClient and reconnect policy.
static AlpacaStockStream	stockStream(AlpacaCredentials credentials, StockSource source, AlpacaStreamEnvironment environment, StockStreamListener listener, okhttp3.OkHttpClient httpClient, AlpacaStreamReconnectPolicy reconnectPolicy, Executor callbackExecutor)	Creates a stock pricing WebSocket stream client with a custom OkHttpClient, reconnect policy, and listener executor.
static ApiClient	tradingClient(AlpacaCredentials credentials)	Creates a Trading ApiClient for the paper environment with API-key header authentication and default timeouts.
static ApiClient	tradingClient(AlpacaCredentials credentials, String baseUrl)	Creates a Trading ApiClient for a custom base URL with default timeouts.
static ApiClient	tradingClient(AlpacaCredentials credentials, String baseUrl, okhttp3.OkHttpClient httpClient)	Creates a Trading ApiClient for a custom base URL and HTTP client.
static ApiClient	tradingClient(AlpacaCredentials credentials, TradingApiEnvironment environment)	Creates a Trading ApiClient for the requested environment with API-key header authentication and default timeouts.
static ApiClient	tradingClient(AlpacaCredentials credentials, TradingApiEnvironment environment, okhttp3.OkHttpClient httpClient)	Creates a Trading ApiClient for the requested environment and HTTP client.
static ApiClient	tradingClient(AlpacaCredentials credentials, okhttp3.OkHttpClient httpClient)	Creates a paper Trading ApiClient with a custom OkHttpClient.
static AlpacaTradingStream	tradingStream(AlpacaCredentials credentials, String baseUrl, TradingStreamListener listener)	Creates a real-time trading WebSocket stream client for a custom stream base URL.
static AlpacaTradingStream	tradingStream(AlpacaCredentials credentials, String baseUrl, TradingStreamListener listener, okhttp3.OkHttpClient httpClient)	Creates a real-time trading WebSocket stream client for a custom stream base URL and HTTP client.
static AlpacaTradingStream	tradingStream(AlpacaCredentials credentials, TradingEnvironment environment, TradingStreamListener listener)	Creates a real-time trading WebSocket stream client.
static AlpacaTradingStream	tradingStream(AlpacaCredentials credentials, TradingEnvironment environment, TradingStreamListener listener, Executor callbackExecutor)	Creates a real-time trading WebSocket stream client with a custom listener executor.
static AlpacaTradingStream	tradingStream(AlpacaCredentials credentials, TradingEnvironment environment, TradingStreamListener listener, AlpacaStreamReconnectPolicy reconnectPolicy)	Creates a real-time trading WebSocket stream client with a custom reconnect policy.
static AlpacaTradingStream	tradingStream(AlpacaCredentials credentials, TradingEnvironment environment, TradingStreamListener listener, okhttp3.OkHttpClient httpClient)	Creates a real-time trading WebSocket stream client with a custom OkHttpClient.
static AlpacaTradingStream	tradingStream(AlpacaCredentials credentials, TradingEnvironment environment, TradingStreamListener listener, okhttp3.OkHttpClient httpClient, Executor callbackExecutor)	Creates a real-time trading WebSocket stream client with a custom OkHttpClient and listener executor.
static AlpacaTradingStream	tradingStream(AlpacaCredentials credentials, TradingEnvironment environment, TradingStreamListener listener, okhttp3.OkHttpClient httpClient, AlpacaStreamReconnectPolicy reconnectPolicy)	Creates a real-time trading WebSocket stream client with a custom OkHttpClient and reconnect policy.
static AlpacaTradingStream	tradingStream(AlpacaCredentials credentials, TradingEnvironment environment, TradingStreamListener listener, okhttp3.OkHttpClient httpClient, AlpacaStreamReconnectPolicy reconnectPolicy, Executor callbackExecutor)	Creates a real-time trading WebSocket stream client with a custom OkHttpClient, reconnect policy, and listener executor.

Methods inherited from class java.lang.Object

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

Method Details

client

public static AlpacaClient client(AlpacaCredentials credentials)

Creates an immutable client facade using default REST settings.

client

public static AlpacaClient client(AlpacaCredentials credentials,
 TradingApiEnvironment tradingEnvironment)

Creates an immutable client facade in the requested Trading environment.

client

public static AlpacaClient client(AlpacaCredentials credentials,
 okhttp3.OkHttpClient httpClient)

Creates an immutable client facade using one shared HTTP client.

client

public static AlpacaClient client(AlpacaCredentials credentials,
 TradingApiEnvironment tradingEnvironment,
 okhttp3.OkHttpClient httpClient)

Creates an immutable client facade using the requested Trading environment and one shared HTTP client.

brokerClient

public static ApiClient brokerClient(AlpacaCredentials credentials)

Creates a Broker ApiClient for the sandbox environment with HTTP Basic authentication and default timeouts.

brokerClient

public static ApiClient brokerClient(AlpacaCredentials credentials,
 BrokerApiEnvironment environment)

Creates a Broker ApiClient for the requested environment with HTTP Basic authentication and default timeouts.

brokerClient

public static ApiClient brokerClient(AlpacaCredentials credentials,
 okhttp3.OkHttpClient httpClient)

Creates a sandbox Broker ApiClient with HTTP Basic authentication and a custom OkHttpClient (e.g. one with logging — see AlpacaHttpConfig.loggingClient(okhttp3.logging.HttpLoggingInterceptor.Level)).

brokerClient

public static ApiClient brokerClient(AlpacaCredentials credentials,
 BrokerApiEnvironment environment,
 okhttp3.OkHttpClient httpClient)

Creates a Broker ApiClient for the requested environment and HTTP client.

brokerClient

public static ApiClient brokerClient(AlpacaCredentials credentials,
 String baseUrl)

Creates a Broker ApiClient for a custom base URL with default timeouts.

brokerClient

public static ApiClient brokerClient(AlpacaCredentials credentials,
 String baseUrl,
 okhttp3.OkHttpClient httpClient)

Creates a Broker ApiClient for a custom base URL and HTTP client.

brokerEventsSseClient

public static BrokerEventsSseClient brokerEventsSseClient(AlpacaCredentials credentials)

Creates a Broker Events SSE client with HTTP Basic authentication and default timeouts.

brokerEventsSseClient

public static BrokerEventsSseClient brokerEventsSseClient(AlpacaCredentials credentials,
 Executor callbackExecutor)

Creates a Broker Events SSE client with HTTP Basic authentication and a custom listener executor.

brokerEventsSseClient

public static BrokerEventsSseClient brokerEventsSseClient(ApiClient brokerClient)

Creates a Broker Events SSE client from an existing generated Broker ApiClient.

brokerEventsSseClient

public static BrokerEventsSseClient brokerEventsSseClient(ApiClient brokerClient,
 Executor callbackExecutor)

Creates a Broker Events SSE client from an existing Broker client and callback executor.

tradingClient

public static ApiClient tradingClient(AlpacaCredentials credentials)

Creates a Trading ApiClient for the paper environment with API-key header authentication and default timeouts.

tradingClient

public static ApiClient tradingClient(AlpacaCredentials credentials,
 TradingApiEnvironment environment)

Creates a Trading ApiClient for the requested environment with API-key header authentication and default timeouts.

tradingClient

public static ApiClient tradingClient(AlpacaCredentials credentials,
 okhttp3.OkHttpClient httpClient)

Creates a paper Trading ApiClient with a custom OkHttpClient.

tradingClient

public static ApiClient tradingClient(AlpacaCredentials credentials,
 TradingApiEnvironment environment,
 okhttp3.OkHttpClient httpClient)

Creates a Trading ApiClient for the requested environment and HTTP client.

tradingClient

public static ApiClient tradingClient(AlpacaCredentials credentials,
 String baseUrl)

Creates a Trading ApiClient for a custom base URL with default timeouts.

tradingClient

public static ApiClient tradingClient(AlpacaCredentials credentials,
 String baseUrl,
 okhttp3.OkHttpClient httpClient)

Creates a Trading ApiClient for a custom base URL and HTTP client.

orders

public static AlpacaOrders orders(ApiClient tradingClient)

Creates a handwritten convenience facade for common Trading order workflows.

dataClient

public static ApiClient dataClient(AlpacaCredentials credentials)

Creates a Data ApiClient with API-key header authentication and default timeouts.

dataClient

public static ApiClient dataClient(AlpacaCredentials credentials,
 okhttp3.OkHttpClient httpClient)

Creates a Data ApiClient with a custom OkHttpClient.

dataClient

public static ApiClient dataClient(AlpacaCredentials credentials,
 String baseUrl)

Creates a Data ApiClient for a custom base URL with default timeouts.

dataClient

public static ApiClient dataClient(AlpacaCredentials credentials,
 String baseUrl,
 okhttp3.OkHttpClient httpClient)

Creates a Data ApiClient for a custom base URL and HTTP client.

stocks

public static AlpacaStocks stocks(ApiClient dataClient)

Creates a handwritten convenience facade for common Market Data stock workflows.

stockStream

public static AlpacaStockStream stockStream(AlpacaCredentials credentials,
 StockSource source,
 AlpacaStreamEnvironment environment,
 StockStreamListener listener)

Creates a stock pricing WebSocket stream client.

Call connect(subscription) to open the connection and subscribe after authentication completes.

Parameters:

credentials - API credentials

source - StockSource.IEX or StockSource.SIP

environment - AlpacaStreamEnvironment.PRODUCTION or SANDBOX

listener - event callbacks

stockStream

public static AlpacaStockStream stockStream(AlpacaCredentials credentials,
 StockSource source,
 AlpacaStreamEnvironment environment,
 StockStreamListener listener,
 AlpacaStreamReconnectPolicy reconnectPolicy)

Creates a stock pricing WebSocket stream client with a custom reconnect policy.

stockStream

public static AlpacaStockStream stockStream(AlpacaCredentials credentials,
 StockSource source,
 AlpacaStreamEnvironment environment,
 StockStreamListener listener,
 Executor callbackExecutor)

Creates a stock pricing WebSocket stream client with a custom listener executor.

stockStream

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

Creates a stock pricing WebSocket stream client with a custom OkHttpClient.

stockStream

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

Creates a stock pricing WebSocket stream client with a custom OkHttpClient and listener executor.

stockStream

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

Creates a stock pricing WebSocket stream client with a custom OkHttpClient and reconnect policy.

stockStream

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

Creates a stock pricing WebSocket stream client with a custom OkHttpClient, reconnect policy, and listener executor.

stockStream

public static AlpacaStockStream stockStream(AlpacaCredentials credentials,
 StockSource source,
 String baseUrl,
 StockStreamListener listener)

Creates a stock pricing WebSocket stream client for a custom stream base URL.

stockStream

public static AlpacaStockStream stockStream(AlpacaCredentials credentials,
 StockSource source,
 String baseUrl,
 StockStreamListener listener,
 okhttp3.OkHttpClient httpClient)

Creates a stock pricing WebSocket stream client for a custom stream base URL and HTTP client.

cryptoStream

public static AlpacaCryptoStream cryptoStream(AlpacaCredentials credentials,
 AlpacaStreamEnvironment environment,
 CryptoStreamListener listener)

Creates a crypto pricing WebSocket stream client.

Only available on AlpacaStreamEnvironment.PRODUCTION.

Parameters:

credentials - API credentials

environment - must be AlpacaStreamEnvironment.PRODUCTION

listener - event callbacks

cryptoStream

public static AlpacaCryptoStream cryptoStream(AlpacaCredentials credentials,
 AlpacaStreamEnvironment environment,
 CryptoStreamListener listener,
 AlpacaStreamReconnectPolicy reconnectPolicy)

Creates a crypto pricing WebSocket stream client with a custom reconnect policy.

cryptoStream

public static AlpacaCryptoStream cryptoStream(AlpacaCredentials credentials,
 AlpacaStreamEnvironment environment,
 CryptoStreamListener listener,
 Executor callbackExecutor)

Creates a crypto pricing WebSocket stream client with a custom listener executor.

cryptoStream

public static AlpacaCryptoStream cryptoStream(AlpacaCredentials credentials,
 AlpacaStreamEnvironment environment,
 CryptoStreamListener listener,
 okhttp3.OkHttpClient httpClient)

Creates a crypto pricing WebSocket stream client with a custom OkHttpClient.

cryptoStream

public static AlpacaCryptoStream cryptoStream(AlpacaCredentials credentials,
 AlpacaStreamEnvironment environment,
 CryptoStreamListener listener,
 okhttp3.OkHttpClient httpClient,
 Executor callbackExecutor)

Creates a crypto pricing WebSocket stream client with a custom OkHttpClient and listener executor.

cryptoStream

public static AlpacaCryptoStream cryptoStream(AlpacaCredentials credentials,
 AlpacaStreamEnvironment environment,
 CryptoStreamListener listener,
 okhttp3.OkHttpClient httpClient,
 AlpacaStreamReconnectPolicy reconnectPolicy)

Creates a crypto pricing WebSocket stream client with a custom OkHttpClient and reconnect policy.

cryptoStream

public static AlpacaCryptoStream cryptoStream(AlpacaCredentials credentials,
 AlpacaStreamEnvironment environment,
 CryptoStreamListener listener,
 okhttp3.OkHttpClient httpClient,
 AlpacaStreamReconnectPolicy reconnectPolicy,
 Executor callbackExecutor)

Creates a crypto pricing WebSocket stream client with a custom OkHttpClient, reconnect policy, and listener executor.

cryptoStream

public static AlpacaCryptoStream cryptoStream(AlpacaCredentials credentials,
 String baseUrl,
 CryptoStreamListener listener)

Creates a crypto pricing WebSocket stream client for a custom stream base URL.

cryptoStream

public static AlpacaCryptoStream cryptoStream(AlpacaCredentials credentials,
 String baseUrl,
 CryptoStreamListener listener,
 okhttp3.OkHttpClient httpClient)

Creates a crypto pricing WebSocket stream client for a custom stream base URL and HTTP client.

newsStream

public static AlpacaNewsStream newsStream(AlpacaCredentials credentials,
 AlpacaStreamEnvironment environment,
 NewsStreamListener listener)

Creates a real-time news WebSocket stream client.

Only available on AlpacaStreamEnvironment.PRODUCTION.

Parameters:

credentials - API credentials

environment - must be AlpacaStreamEnvironment.PRODUCTION

listener - event callbacks

newsStream

public static AlpacaNewsStream newsStream(AlpacaCredentials credentials,
 AlpacaStreamEnvironment environment,
 NewsStreamListener listener,
 AlpacaStreamReconnectPolicy reconnectPolicy)

Creates a real-time news WebSocket stream client with a custom reconnect policy.

newsStream

public static AlpacaNewsStream newsStream(AlpacaCredentials credentials,
 AlpacaStreamEnvironment environment,
 NewsStreamListener listener,
 Executor callbackExecutor)

Creates a real-time news WebSocket stream client with a custom listener executor.

newsStream

public static AlpacaNewsStream newsStream(AlpacaCredentials credentials,
 AlpacaStreamEnvironment environment,
 NewsStreamListener listener,
 okhttp3.OkHttpClient httpClient)

Creates a real-time news WebSocket stream client with a custom OkHttpClient.

newsStream

public static AlpacaNewsStream newsStream(AlpacaCredentials credentials,
 AlpacaStreamEnvironment environment,
 NewsStreamListener listener,
 okhttp3.OkHttpClient httpClient,
 Executor callbackExecutor)

Creates a real-time news WebSocket stream client with a custom OkHttpClient and listener executor.

newsStream

public static AlpacaNewsStream newsStream(AlpacaCredentials credentials,
 AlpacaStreamEnvironment environment,
 NewsStreamListener listener,
 okhttp3.OkHttpClient httpClient,
 AlpacaStreamReconnectPolicy reconnectPolicy)

Creates a real-time news WebSocket stream client with a custom OkHttpClient and reconnect policy.

newsStream

public static AlpacaNewsStream newsStream(AlpacaCredentials credentials,
 AlpacaStreamEnvironment environment,
 NewsStreamListener listener,
 okhttp3.OkHttpClient httpClient,
 AlpacaStreamReconnectPolicy reconnectPolicy,
 Executor callbackExecutor)

Creates a real-time news WebSocket stream client with a custom OkHttpClient, reconnect policy, and listener executor.

newsStream

public static AlpacaNewsStream newsStream(AlpacaCredentials credentials,
 String baseUrl,
 NewsStreamListener listener)

Creates a real-time news WebSocket stream client for a custom stream base URL.

newsStream

public static AlpacaNewsStream newsStream(AlpacaCredentials credentials,
 String baseUrl,
 NewsStreamListener listener,
 okhttp3.OkHttpClient httpClient)

Creates a real-time news WebSocket stream client for a custom stream base URL and HTTP client.

tradingStream

public static AlpacaTradingStream tradingStream(AlpacaCredentials credentials,
 TradingEnvironment environment,
 TradingStreamListener listener)

Creates a real-time trading WebSocket stream client.

Provides order lifecycle events (trade_updates) for the authenticated account.

Parameters:

credentials - API credentials

environment - TradingEnvironment.PRODUCTION or TradingEnvironment.PAPER

listener - event callbacks

tradingStream

public static AlpacaTradingStream tradingStream(AlpacaCredentials credentials,
 TradingEnvironment environment,
 TradingStreamListener listener,
 AlpacaStreamReconnectPolicy reconnectPolicy)

Creates a real-time trading WebSocket stream client with a custom reconnect policy.

tradingStream

public static AlpacaTradingStream tradingStream(AlpacaCredentials credentials,
 TradingEnvironment environment,
 TradingStreamListener listener,
 Executor callbackExecutor)

Creates a real-time trading WebSocket stream client with a custom listener executor.

tradingStream

public static AlpacaTradingStream tradingStream(AlpacaCredentials credentials,
 TradingEnvironment environment,
 TradingStreamListener listener,
 okhttp3.OkHttpClient httpClient)

Creates a real-time trading WebSocket stream client with a custom OkHttpClient.

tradingStream

public static AlpacaTradingStream tradingStream(AlpacaCredentials credentials,
 TradingEnvironment environment,
 TradingStreamListener listener,
 okhttp3.OkHttpClient httpClient,
 Executor callbackExecutor)

Creates a real-time trading WebSocket stream client with a custom OkHttpClient and listener executor.

tradingStream

public static AlpacaTradingStream tradingStream(AlpacaCredentials credentials,
 TradingEnvironment environment,
 TradingStreamListener listener,
 okhttp3.OkHttpClient httpClient,
 AlpacaStreamReconnectPolicy reconnectPolicy)

Creates a real-time trading WebSocket stream client with a custom OkHttpClient and reconnect policy.

tradingStream

public static AlpacaTradingStream tradingStream(AlpacaCredentials credentials,
 TradingEnvironment environment,
 TradingStreamListener listener,
 okhttp3.OkHttpClient httpClient,
 AlpacaStreamReconnectPolicy reconnectPolicy,
 Executor callbackExecutor)

Creates a real-time trading WebSocket stream client with a custom OkHttpClient, reconnect policy, and listener executor.

tradingStream

public static AlpacaTradingStream tradingStream(AlpacaCredentials credentials,
 String baseUrl,
 TradingStreamListener listener)

Creates a real-time trading WebSocket stream client for a custom stream base URL.

tradingStream

public static AlpacaTradingStream tradingStream(AlpacaCredentials credentials,
 String baseUrl,
 TradingStreamListener listener,
 okhttp3.OkHttpClient httpClient)

Creates a real-time trading WebSocket stream client for a custom stream base URL and HTTP client.