net.jacobpeterson.alpaca

Class AlpacaAPI

java.lang.Object

net.jacobpeterson.alpaca.AlpacaAPI

public class AlpacaAPI
extends Object

The AlpacaAPI class contains several instances of various AlpacaEndpoints and AlpacaWebsockets to interface with Alpaca. You will generally only need one instance of this class in your application. Note that many methods inside the various AlpacaEndpoints allow null to be passed in as a parameter if it is optional.

See Also:

Alpaca API Documentation

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor and Description
AlpacaAPI() Instantiates a new AlpacaAPI using properties specified in alpaca.properties file (or their associated defaults).
AlpacaAPI(okhttp3.OkHttpClient okHttpClient, String keyID, String secretKey, String oAuthToken, EndpointAPIType endpointAPIType, DataAPIType dataAPIType) Instantiates a new AlpacaAPI.
AlpacaAPI(String oAuthToken) Instantiates a new AlpacaAPI.
AlpacaAPI(String keyID, String secretKey) Instantiates a new AlpacaAPI.
AlpacaAPI(String keyID, String secretKey, EndpointAPIType endpointAPIType, DataAPIType dataAPIType) Instantiates a new AlpacaAPI.

Method Summary

Modifier and Type	Method and Description
AccountEndpoint	account()
AccountActivitiesEndpoint	accountActivities()
AccountConfigurationEndpoint	accountConfiguration()
AssetsEndpoint	assets()
static AlpacaAPI.Builder	builder() Creates a AlpacaAPI.Builder for AlpacaAPI.
CalendarEndpoint	calendar()
ClockEndpoint	clock()
CryptoMarketDataEndpoint	cryptoMarketData()
MarketDataWebsocketInterface	cryptoMarketDataStreaming()
AlpacaClient	getBrokerClient()
AlpacaClient	getCryptoDataClient()
okhttp3.OkHttpClient	getOkHttpClient()
AlpacaClient	getStockDataClient()
OrdersEndpoint	orders()
PortfolioHistoryEndpoint	portfolioHistory()
PositionsEndpoint	positions()
StockMarketDataEndpoint	stockMarketData()
MarketDataWebsocketInterface	stockMarketDataStreaming()
StreamingWebsocketInterface	streaming()
WatchlistEndpoint	watchlist()

Methods inherited from class java.lang.Object

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

Constructor Detail

AlpacaAPI

public AlpacaAPI()

Instantiates a new AlpacaAPI using properties specified in alpaca.properties file (or their associated defaults).

AlpacaAPI

public AlpacaAPI(String keyID,
                 String secretKey)

Instantiates a new AlpacaAPI.

Parameters:

keyID - the key ID

secretKey - the secret key

AlpacaAPI

public AlpacaAPI(String keyID,
                 String secretKey,
                 EndpointAPIType endpointAPIType,
                 DataAPIType dataAPIType)

Instantiates a new AlpacaAPI.

Parameters:

keyID - the key ID

secretKey - the secret key

endpointAPIType - the EndpointAPIType

dataAPIType - the DataAPIType

AlpacaAPI

public AlpacaAPI(String oAuthToken)

Instantiates a new AlpacaAPI.

Parameters:

oAuthToken - the OAuth token. Note that the Data API v2 does not work with OAuth tokens.

AlpacaAPI

public AlpacaAPI(okhttp3.OkHttpClient okHttpClient,
                 String keyID,
                 String secretKey,
                 String oAuthToken,
                 EndpointAPIType endpointAPIType,
                 DataAPIType dataAPIType)

Instantiates a new AlpacaAPI.

Parameters:

okHttpClient - the OkHttpClient or null to create a default instance

keyID - the key ID

secretKey - the secret key

oAuthToken - the OAuth token

endpointAPIType - the EndpointAPIType

dataAPIType - the DataAPIType

Method Detail

account

public AccountEndpoint account()

Returns:

the AccountEndpoint

cryptoMarketData

public CryptoMarketDataEndpoint cryptoMarketData()

Returns:

the CryptoMarketDataEndpoint

stockMarketData

public StockMarketDataEndpoint stockMarketData()

Returns:

the StockMarketDataEndpoint

orders

public OrdersEndpoint orders()

Returns:

the OrdersEndpoint

positions

public PositionsEndpoint positions()

Returns:

the PositionsEndpoint

assets

public AssetsEndpoint assets()

Returns:

the AssetsEndpoint

watchlist

public WatchlistEndpoint watchlist()

Returns:

the WatchlistEndpoint

calendar

public CalendarEndpoint calendar()

Returns:

the CalendarEndpoint

clock

public ClockEndpoint clock()

Returns:

the ClockEndpoint

accountConfiguration

public AccountConfigurationEndpoint accountConfiguration()

Returns:

the AccountConfigurationEndpoint

accountActivities

public AccountActivitiesEndpoint accountActivities()

Returns:

the AccountActivitiesEndpoint

portfolioHistory

public PortfolioHistoryEndpoint portfolioHistory()

Returns:

the PortfolioHistoryEndpoint

streaming

public StreamingWebsocketInterface streaming()

Returns:

the StreamingWebsocketInterface

cryptoMarketDataStreaming

public MarketDataWebsocketInterface cryptoMarketDataStreaming()

Returns:

the Crypto MarketDataWebsocketInterface

stockMarketDataStreaming

public MarketDataWebsocketInterface stockMarketDataStreaming()

Returns:

the Stock MarketDataWebsocketInterface

getOkHttpClient

public okhttp3.OkHttpClient getOkHttpClient()

getBrokerClient

public AlpacaClient getBrokerClient()

getCryptoDataClient

public AlpacaClient getCryptoDataClient()

getStockDataClient

public AlpacaClient getStockDataClient()

builder

public static AlpacaAPI.Builder builder()

Creates a AlpacaAPI.Builder for AlpacaAPI.

Returns:

a AlpacaAPI.Builder