Package net.jacobpeterson.alpaca

Class AlpacaAPI

java.lang.Object

net.jacobpeterson.alpaca.AlpacaAPI

public class AlpacaAPI
extends Object

AlpacaAPI is the main class used to interface with the various Alpaca API endpoints. If you are using the Trading or Market Data APIs for a single Alpaca account or if you are using the Broker API, you will generally only need one instance of this class. However, if you are using the Trading API with OAuth to act on behalf of an Alpaca account, this class is optimized so that it can be instantiated quickly, especially when an existing OkHttpClient is given in the constructor. Additionally, all API endpoint instances are instantiated lazily. This class is thread-safe.

See Also:

• Alpaca Docs

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	AlpacaAPI.Builder	A builder for AlpacaAPI

Constructor Summary

Constructors

Constructor	Description
AlpacaAPI(String traderKeyID, String traderSecretKey, String traderOAuthToken, TraderAPIEndpointType traderAPIEndpointType, MarketDataWebsocketSourceType marketDataWebsocketSourceType, String brokerAPIKey, String brokerAPISecret, BrokerAPIEndpointType brokerAPIEndpointType, okhttp3.OkHttpClient okHttpClient)	Instantiates a new AlpacaAPI.
AlpacaAPI(String brokerAPIKey, String brokerAPISecret, BrokerAPIEndpointType brokerAPIEndpointType)	Instantiates a new AlpacaAPI.
AlpacaAPI(String brokerAPIKey, String brokerAPISecret, BrokerAPIEndpointType brokerAPIEndpointType, okhttp3.OkHttpClient okHttpClient)	Instantiates a new AlpacaAPI.
AlpacaAPI(String traderKeyID, String traderSecretKey, TraderAPIEndpointType traderAPIEndpointType, MarketDataWebsocketSourceType marketDataWebsocketSourceType)	Instantiates a new AlpacaAPI.
AlpacaAPI(String traderKeyID, String traderSecretKey, TraderAPIEndpointType traderAPIEndpointType, MarketDataWebsocketSourceType marketDataWebsocketSourceType, okhttp3.OkHttpClient okHttpClient)	Instantiates a new AlpacaAPI.
AlpacaAPI(String traderOAuthToken, TraderAPIEndpointType traderAPIEndpointType)	Instantiates a new AlpacaAPI.
AlpacaAPI(String traderOAuthToken, TraderAPIEndpointType traderAPIEndpointType, okhttp3.OkHttpClient okHttpClient)	Instantiates a new AlpacaAPI.

Method Summary

Modifier and Type	Method	Description
AlpacaBrokerAPI	broker()	Gets the AlpacaBrokerAPI.
static AlpacaAPI.Builder	builder()	Creates a AlpacaAPI.Builder for AlpacaAPI.
void	closeOkHttpClient()	Closes the OkHttpClient.
CryptoMarketDataWebsocketInterface	cryptoMarketDataStream()	Gets the CryptoMarketDataWebsocketInterface.
okhttp3.OkHttpClient	getOkHttpClient()	Gets the OkHttpClient.
AlpacaMarketDataAPI	marketData()	Gets the AlpacaMarketDataAPI.
NewsMarketDataWebsocketInterface	newsMarketDataStream()	Gets the NewsMarketDataWebsocketInterface.
StockMarketDataWebsocketInterface	stockMarketDataStream()	Gets the StockMarketDataWebsocketInterface.
AlpacaTraderAPI	trader()	Gets the AlpacaTraderAPI.
UpdatesWebsocketInterface	updatesStream()	Gets the UpdatesWebsocketInterface.

Methods inherited from class java.lang.Object

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

Constructor Details

AlpacaAPI

public AlpacaAPI(String traderKeyID,
 String traderSecretKey,
 TraderAPIEndpointType traderAPIEndpointType,
 MarketDataWebsocketSourceType marketDataWebsocketSourceType)

Instantiates a new AlpacaAPI. Use this constructor if you are using the Trading or Market Data APIs for a single Alpaca account.

Parameters:

traderKeyID - the Trader key ID

traderSecretKey - the Trader secret key

traderAPIEndpointType - the TraderAPIEndpointType

marketDataWebsocketSourceType - the MarketDataWebsocketSourceType

AlpacaAPI

public AlpacaAPI(String traderKeyID,
 String traderSecretKey,
 TraderAPIEndpointType traderAPIEndpointType,
 MarketDataWebsocketSourceType marketDataWebsocketSourceType,
 okhttp3.OkHttpClient okHttpClient)

Instantiates a new AlpacaAPI. Use this constructor if you are using the Trading or Market Data APIs for a single Alpaca account and a custom OkHttpClient instance.

Parameters:

traderKeyID - the Trader key ID

traderSecretKey - the Trader secret key

traderAPIEndpointType - the TraderAPIEndpointType

marketDataWebsocketSourceType - the MarketDataWebsocketSourceType

okHttpClient - an existing OkHttpClient or null to create a new default instance

AlpacaAPI

public AlpacaAPI(String traderOAuthToken,
 TraderAPIEndpointType traderAPIEndpointType)

Instantiates a new AlpacaAPI. Use this constructor if you are using the Trading API with OAuth to act on behalf of an Alpaca account.

Parameters:

traderOAuthToken - the Trader OAuth token

traderAPIEndpointType - the TraderAPIEndpointType

AlpacaAPI

public AlpacaAPI(String traderOAuthToken,
 TraderAPIEndpointType traderAPIEndpointType,
 okhttp3.OkHttpClient okHttpClient)

Instantiates a new AlpacaAPI. Use this constructor if you are using the Trading API with OAuth to act on behalf of an Alpaca account and a custom OkHttpClient instance.

Parameters:

traderOAuthToken - the Trader OAuth token

traderAPIEndpointType - the TraderAPIEndpointType

okHttpClient - an existing OkHttpClient or null to create a new default instance

AlpacaAPI

public AlpacaAPI(String brokerAPIKey,
 String brokerAPISecret,
 BrokerAPIEndpointType brokerAPIEndpointType)

Instantiates a new AlpacaAPI. Use this constructor if you are using the Broker API.

Parameters:

brokerAPIKey - the Broker API key

brokerAPISecret - the Broker API secret

brokerAPIEndpointType - the BrokerAPIEndpointType

AlpacaAPI

public AlpacaAPI(String brokerAPIKey,
 String brokerAPISecret,
 BrokerAPIEndpointType brokerAPIEndpointType,
 okhttp3.OkHttpClient okHttpClient)

Instantiates a new AlpacaAPI. Use this constructor if you are using the Broker API and a custom OkHttpClient instance.

Parameters:

brokerAPIKey - the Broker API key

brokerAPISecret - the Broker API secret

brokerAPIEndpointType - the BrokerAPIEndpointType

okHttpClient - an existing OkHttpClient or null to create a new default instance

AlpacaAPI

public AlpacaAPI(String traderKeyID,
 String traderSecretKey,
 String traderOAuthToken,
 TraderAPIEndpointType traderAPIEndpointType,
 MarketDataWebsocketSourceType marketDataWebsocketSourceType,
 String brokerAPIKey,
 String brokerAPISecret,
 BrokerAPIEndpointType brokerAPIEndpointType,
 okhttp3.OkHttpClient okHttpClient)

Instantiates a new AlpacaAPI.

Parameters:

traderKeyID - the Trader key ID

traderSecretKey - the Trader secret key

traderOAuthToken - the Trader OAuth token

traderAPIEndpointType - the TraderAPIEndpointType

marketDataWebsocketSourceType - the MarketDataWebsocketSourceType

brokerAPIKey - the Broker API key

brokerAPISecret - the Broker API secret

brokerAPIEndpointType - the BrokerAPIEndpointType

okHttpClient - an existing OkHttpClient or null to create a new default instance

Method Details

closeOkHttpClient

public void closeOkHttpClient()

Closes the OkHttpClient.

getOkHttpClient

public okhttp3.OkHttpClient getOkHttpClient()

Gets the OkHttpClient.

Returns:

the OkHttpClient

trader

public AlpacaTraderAPI trader()

Gets the AlpacaTraderAPI. Lazily instantiated.

Returns:

the AlpacaTraderAPI

marketData

public AlpacaMarketDataAPI marketData()

Gets the AlpacaMarketDataAPI. Lazily instantiated.

Returns:

the AlpacaMarketDataAPI

broker

public AlpacaBrokerAPI broker()

Gets the AlpacaBrokerAPI. Lazily instantiated.

Returns:

the AlpacaBrokerAPI

updatesStream

public UpdatesWebsocketInterface updatesStream()

Gets the UpdatesWebsocketInterface. Lazily instantiated.

Returns:

the UpdatesWebsocketInterface

stockMarketDataStream

public StockMarketDataWebsocketInterface stockMarketDataStream()

Gets the StockMarketDataWebsocketInterface. Lazily instantiated.

Returns:

the StockMarketDataWebsocketInterface

cryptoMarketDataStream

public CryptoMarketDataWebsocketInterface cryptoMarketDataStream()

Gets the CryptoMarketDataWebsocketInterface. Lazily instantiated.

Returns:

the CryptoMarketDataWebsocketInterface

newsMarketDataStream

public NewsMarketDataWebsocketInterface newsMarketDataStream()

Gets the NewsMarketDataWebsocketInterface. Lazily instantiated.

Returns:

the NewsMarketDataWebsocketInterface

builder

public static AlpacaAPI.Builder builder()

Creates a AlpacaAPI.Builder for AlpacaAPI.

Returns:

the AlpacaAPI.Builder