Package net.jacobpeterson.alpaca.rest.trader

Class AlpacaTraderAPI

java.lang.Object

net.jacobpeterson.alpaca.rest.trader.AlpacaTraderAPI

public class AlpacaTraderAPI
extends Object

AlpacaTraderAPI is the class used to interface with the Alpaca Trader API endpoints. This class is thread-safe.

Constructor Summary

Constructors

Constructor	Description
AlpacaTraderAPI(String traderKeyID, String traderSecretKey, String traderOAuthToken, TraderAPIEndpointType traderAPIEndpointType, okhttp3.OkHttpClient okHttpClient)	Instantiates a new AlpacaTraderAPI.

Method Summary

Modifier and Type	Method	Description
AccountActivitiesApi	accountActivities()	Gets the AccountActivitiesApi.
AccountConfigurationsApi	accountConfigurations()	Gets the AccountConfigurationsApi.
AccountsApi	accounts()	Gets the AccountsApi.
AssetsApi	assets()	Gets the AssetsApi.
CalendarApi	calendar()	Gets the CalendarApi.
ClockApi	clock()	Gets the ClockApi.
ApiClient	getInternalAPIClient()	Gets the internal ApiClient.
OrdersApi	orders()	Gets the OrdersApi.
PortfolioHistoryApi	portfolioHistory()	Gets the PortfolioHistoryApi.
PositionsApi	positions()	Gets the PositionsApi.
CorporateActionsApi	traderCorporateActions()	Gets the CorporateActionsApi.
WatchlistsApi	watchlists()	Gets the WatchlistsApi.

Methods inherited from class java.lang.Object

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

Constructor Details

AlpacaTraderAPI

public AlpacaTraderAPI(String traderKeyID,
 String traderSecretKey,
 String traderOAuthToken,
 TraderAPIEndpointType traderAPIEndpointType,
 okhttp3.OkHttpClient okHttpClient)

Instantiates a new AlpacaTraderAPI.

Parameters:

traderKeyID - the Trader key ID

traderSecretKey - the Trader secret key

traderOAuthToken - the Trader OAuth token

traderAPIEndpointType - the TraderAPIEndpointType

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

Method Details

getInternalAPIClient

public ApiClient getInternalAPIClient()

Gets the internal ApiClient.

Returns:

the ApiClient

accountActivities

public AccountActivitiesApi accountActivities()

Gets the AccountActivitiesApi. Lazily instantiated.

Returns:

the AccountActivitiesApi

accountConfigurations

public AccountConfigurationsApi accountConfigurations()

Gets the AccountConfigurationsApi. Lazily instantiated.

Returns:

the AccountConfigurationsApi

accounts

public AccountsApi accounts()

Gets the AccountsApi. Lazily instantiated.

Returns:

AccountsApi

assets

public AssetsApi assets()

Gets the AssetsApi. Lazily instantiated.

Returns:

AssetsApi

calendar

public CalendarApi calendar()

Gets the CalendarApi. Lazily instantiated.

Returns:

CalendarApi

clock

public ClockApi clock()

Gets the ClockApi. Lazily instantiated.

Returns:

ClockApi

traderCorporateActions

public CorporateActionsApi traderCorporateActions()

Gets the CorporateActionsApi. Lazily instantiated.

Returns:

the CorporateActionsApi

orders

public OrdersApi orders()

Gets the OrdersApi. Lazily instantiated.

Returns:

OrdersApi

portfolioHistory

public PortfolioHistoryApi portfolioHistory()

Gets the PortfolioHistoryApi. Lazily instantiated.

Returns:

PortfolioHistoryApi

positions

public PositionsApi positions()

Gets the PositionsApi. Lazily instantiated.

Returns:

PositionsApi

watchlists

public WatchlistsApi watchlists()

Gets the WatchlistsApi. Lazily instantiated.

Returns:

WatchlistsApi