AlpacaAPI (alpaca-java 7.1.1 API)

java.lang.Object
- net.jacobpeterson.alpaca.AlpacaAPI

```
public class AlpacaAPI
extends Object
```
AlpacaAPI contains several methods to interface with Alpaca. You will generally only need one instance of it in your application. Note that many methods allow null to be passed in as a parameter if it is optional. Note that most of these methods are blocking methods and this class in not thread-safe.
See Also: Alpaca API documentation










Constructor Summary

Constructors 

Constructor and Description


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



AlpacaAPI(String oAuthToken)
Instantiates a new AlpacaAPI.



AlpacaAPI(String keyID,
         String secret)
Instantiates a new AlpacaAPI.



AlpacaAPI(String keyID,
         String secret,
         EndpointAPIType endpointAPIType,
         DataAPIType dataAPIType)
Instantiates a new AlpacaAPI.



AlpacaAPI(String keyID,
         String secret,
         String oAuthToken,
         EndpointAPIType endpointAPIType,
         DataAPIType dataAPIType)
Instantiates a new AlpacaAPI.










Method Summary

All Methods Instance Methods Concrete Methods 

Modifier and Type
Method and Description


void
addAlpacaStreamListener(AlpacaStreamListener streamListener)
Adds the AlpacaStreamListener.



void
addMarketDataStreamListener(MarketDataListener streamListener)
Adds the MarketDataListener.



Watchlist
addWatchlistAsset(String watchlistID,
                 String symbol)
Append an asset for the symbol to the end of watchlist asset list



ArrayList<CancelledOrder>
cancelAllOrders()
Attempts to cancel all open orders.



boolean
cancelOrder(String orderId)
Attempts to cancel an open order.



ArrayList<ClosePositionOrder>
closeAllPositions()
Closes (liquidates) all of the account’s open long and short positions.



Order
closePosition(String symbol)
Closes (liquidates) the account’s open position for the given symbol.



Watchlist
createWatchlist(String name,
               String... symbols)
Create a new watchlist with initial set of assets.



boolean
deleteWatchlist(String watchlistID)
Delete a watchlist.



Account
getAccount()
Returns the Account associated with the API key.



List<AccountActivity>
getAccountActivities(ZonedDateTime date,
                    ZonedDateTime until,
                    ZonedDateTime after,
                    SortDirection sortDirection,
                    Integer pageSize,
                    String pageToken,
                    ActivityType... activityTypes)
Returns AccountActivity entries for many or for a specific type of activity.



AccountConfiguration
getAccountConfiguration()
Returns the current AccountConfiguration values.



Asset
getAssetBySymbol(String symbolOrAssetID)
Gets the asset by symbol or asset_id.



ArrayList<Asset>
getAssets(AssetStatus assetStatus,
         String assetClass)
Get a list of assets.



BarsResponse
getBars(String symbol,
       ZonedDateTime start,
       ZonedDateTime end,
       Integer limit,
       String pageToken,
       BarsTimeFrame timeFrame)
Gets Bar aggregate historical data for the requested security.



List<Calendar>
getCalendar()
Returns the market Calendar from 1970 to 2029.



List<Calendar>
getCalendar(LocalDate start,
           LocalDate end)
Returns the market Calendar.



Clock
getClock()
Returns the market Clock.



Position
getOpenPositionBySymbol(String symbol)
Gets the open position by symbol.



ArrayList<Position>
getOpenPositions()
Gets the open positions.



Order
getOrder(String orderID,
        Boolean nested)
Retrieves a single order for the given order_id.



Order
getOrderByClientID(String clientOrderId)
Retrieves a single order for the given client_order_id.



List<Order>
getOrders(OrderStatus status,
         Integer limit,
         ZonedDateTime after,
         ZonedDateTime until,
         SortDirection sortDirection,
         Boolean nested,
         List<String> symbols)
Retrieves a list of orders for the account, filtered by the supplied query parameters.



PortfolioHistory
getPortfolioHistory(Integer periodLength,
                   PortfolioPeriodUnit periodUnit,
                   PortfolioTimeFrame timeFrame,
                   LocalDate dateEnd,
                   Boolean extendedHours)
Returns timeseries data about equity and profit/loss (P/L) of the account in requested timespan.



QuotesResponse
getQuotes(String symbol,
         ZonedDateTime start,
         ZonedDateTime end,
         Integer limit,
         String pageToken)
Gets Quote (NBBO or National Best Bid and Offer) historical data for the requested security.



TradesResponse
getTrades(String symbol,
         ZonedDateTime start,
         ZonedDateTime end,
         Integer limit,
         String pageToken)
Gets Trade historical data for the requested security.



Watchlist
getWatchlist(String watchlistID)
Returns a watchlist identified by the ID.



ArrayList<Watchlist>
getWatchlists()
Returns the list of watchlists registered under the account.



void
removeAlpacaStreamListener(AlpacaStreamListener streamListener)
Removes the AlpacaStreamListener.



void
removeMarketDataStreamListener(MarketDataListener streamListener)
Removes the MarketDataListener.



Watchlist
removeSymbolFromWatchlist(String watchlistID,
                         String symbol)
Delete one entry for an asset by symbol name.



Order
replaceOrder(String orderID,
            Integer quantity,
            OrderTimeInForce timeInForce,
            Double limitPrice,
            Double stopPrice,
            Double trail,
            String clientOrderId)
Replaces a single order with updated parameters.



Order
requestNewFractionalMarketOrder(String symbol,
                               Double quantity,
                               OrderSide side)
A market order is a request to buy or sell a security at the currently available market price.



Order
requestNewLimitBracketOrder(String symbol,
                           Integer quantity,
                           OrderSide side,
                           OrderTimeInForce timeInForce,
                           Double limitPrice,
                           Boolean extendedHours,
                           Double takeProfitLimitPrice,
                           Double stopLossStopPrice,
                           Double stopLossLimitPrice)
A bracket order is a chain of three orders that can be used to manage your position entry and exit.



Order
requestNewLimitOrder(String symbol,
                    Integer quantity,
                    OrderSide side,
                    OrderTimeInForce timeInForce,
                    Double limitPrice,
                    Boolean extendedHours)
A limit order is an order to buy or sell at a specified price or better.



Order
requestNewMarketBracketOrder(String symbol,
                            Integer quantity,
                            OrderSide side,
                            OrderTimeInForce timeInForce,
                            Double takeProfitLimitPrice,
                            Double stopLossStopPrice,
                            Double stopLossLimitPrice)
A bracket order is a chain of three orders that can be used to manage your position entry and exit.



Order
requestNewMarketOrder(String symbol,
                     Integer quantity,
                     OrderSide side,
                     OrderTimeInForce timeInForce)
A market order is a request to buy or sell a security at the currently available market price.



Order
requestNewNotionalMarketOrder(String symbol,
                             Double notional,
                             OrderSide side)
A market order is a request to buy or sell a security at the currently available market price.



Order
requestNewOCOOrder(String symbol,
                  Integer quantity,
                  OrderSide side,
                  OrderTimeInForce timeInForce,
                  Boolean extendedHours,
                  Double takeProfitLimitPrice,
                  Double stopLossStopPrice,
                  Double stopLossLimitPrice)
OCO (One-Cancels-Other) is another type of advanced order type.



Order
requestNewOrder(String symbol,
               Double quantity,
               Double notional,
               OrderSide side,
               OrderType type,
               OrderTimeInForce timeInForce,
               Double limitPrice,
               Double stopPrice,
               Double trailPrice,
               Double trailPercent,
               Boolean extendedHours,
               String clientOrderId,
               OrderClass orderClass,
               Double takeProfitLimitPrice,
               Double stopLossStopPrice,
               Double stopLossLimitPrice)
Places a new order for the given account.



Order
requestNewOTOLimitOrder(String symbol,
                       Integer quantity,
                       OrderSide side,
                       OrderTimeInForce timeInForce,
                       Double limitPrice,
                       Boolean extendedHours,
                       Double takeProfitLimitPrice,
                       Double stopLossStopPrice,
                       Double stopLossLimitPrice)
OTO (One-Triggers-Other) is a variant of bracket order.



Order
requestNewOTOMarketOrder(String symbol,
                        Integer quantity,
                        OrderSide side,
                        OrderTimeInForce timeInForce,
                        Double takeProfitLimitPrice,
                        Double stopLossStopPrice,
                        Double stopLossLimitPrice)
OTO (One-Triggers-Other) is a variant of bracket order.



Order
requestNewOTOStopLimitOrder(String symbol,
                           Integer quantity,
                           OrderSide side,
                           OrderTimeInForce timeInForce,
                           Double limitPrice,
                           Double stopPrice,
                           Boolean extendedHours,
                           Double takeProfitLimitPrice,
                           Double stopLossStopPrice,
                           Double stopLossLimitPrice)
OTO (One-Triggers-Other) is a variant of bracket order.



Order
requestNewOTOStopOrder(String symbol,
                      Integer quantity,
                      OrderSide side,
                      OrderTimeInForce timeInForce,
                      Double stopPrice,
                      Boolean extendedHours,
                      Double takeProfitLimitPrice,
                      Double stopLossStopPrice,
                      Double stopLossLimitPrice)
OTO (One-Triggers-Other) is a variant of bracket order.



Order
requestNewStopLimitOrder(String symbol,
                        Integer quantity,
                        OrderSide side,
                        OrderTimeInForce timeInForce,
                        Double limitPrice,
                        Double stopPrice,
                        Boolean extendedHours)
A stop-limit order is a conditional trade over a set time frame that combines the features of a stop order with
 those of a limit order and is used to mitigate risk.



Order
requestNewStopOrder(String symbol,
                   Integer quantity,
                   OrderSide side,
                   OrderTimeInForce timeInForce,
                   Double stopPrice,
                   Boolean extendedHours)
A stop (market) order is an order to buy or sell a security when its price moves past a particular point,
 ensuring a higher probability of achieving a predetermined entry or exit price.



Order
requestNewTrailingStopPercentOrder(String symbol,
                                  Integer quantity,
                                  OrderSide side,
                                  OrderTimeInForce timeInForce,
                                  Double trailPercent,
                                  Boolean extendedHours)
Trailing stop orders allow you to continuously and automatically keep updating the stop price threshold based on
 the stock price movement.



Order
requestNewTrailingStopPriceOrder(String symbol,
                                Integer quantity,
                                OrderSide side,
                                OrderTimeInForce timeInForce,
                                Double trailPrice,
                                Boolean extendedHours)
Trailing stop orders allow you to continuously and automatically keep updating the stop price threshold based on
 the stock price movement.



AccountConfiguration
setAccountConfiguration(AccountConfiguration accountConfiguration)
Sets AccountConfiguration.



String
toString() 


Watchlist
updateWatchlist(String watchlistID,
               String name,
               String... symbols)
Update the name and/or content of watchlist.







Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, 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 secret)
Instantiates a new AlpacaAPI.

Parameters:
keyID - the key ID
secret - the secret








AlpacaAPI
public AlpacaAPI(String keyID,
                 String secret,
                 EndpointAPIType endpointAPIType,
                 DataAPIType dataAPIType)
Instantiates a new AlpacaAPI.

Parameters:
keyID - the key ID
secret - the secret
endpointAPIType - the EndpointAPIType
dataAPIType - the DataAPIType








AlpacaAPI
public AlpacaAPI(String oAuthToken)
Instantiates a new AlpacaAPI.

Parameters:
oAuthToken - the OAuth token








AlpacaAPI
public AlpacaAPI(String keyID,
                 String secret,
                 String oAuthToken,
                 EndpointAPIType endpointAPIType,
                 DataAPIType dataAPIType)
Instantiates a new AlpacaAPI.

Parameters:
keyID - the key ID
secret - the secret
oAuthToken - the OAuth token
endpointAPIType - the EndpointAPIType
dataAPIType - the DataAPIType










Method Detail





getAccount
public Account getAccount()
                   throws AlpacaAPIRequestException
Returns the Account associated with the API key.

Returns:
the Account
Throws:
AlpacaAPIRequestException - thrown for AlpacaAPIRequestExceptions
See Also:
Get the Account








getAccountActivities
public List<AccountActivity> getAccountActivities(ZonedDateTime date,
                                                  ZonedDateTime until,
                                                  ZonedDateTime after,
                                                  SortDirection sortDirection,
                                                  Integer pageSize,
                                                  String pageToken,
                                                  ActivityType... activityTypes)
                                           throws AlpacaAPIRequestException
Returns AccountActivity entries for many or for a specific type of activity.

Parameters:
date - The date for which you want to see activities.
until - The response will contain only activities submitted before this date. (Cannot be used with
                      date.)
after - The response will contain only activities submitted after this date. (Cannot be used with
                      date.)
sortDirection - asc or desc (default desc if unspecified.)
pageSize - The maximum number of entries to return in the response. (See the section on paging.)
pageToken - The ID of the end of your current page of results. (See the section on paging.)
activityTypes - the activity types (null for all activities)
Returns:
the AccountActivity List
Throws:
AlpacaAPIRequestException - thrown for AlpacaAPIRequestExceptions
See Also:
Gets the Account
 Activities








getAccountConfiguration
public AccountConfiguration getAccountConfiguration()
                                             throws AlpacaAPIRequestException
Returns the current AccountConfiguration values.

Returns:
the AccountConfiguration
Throws:
AlpacaAPIRequestException - thrown for AlpacaAPIRequestExceptions
See Also:
Account
 Configuration








setAccountConfiguration
public AccountConfiguration setAccountConfiguration(AccountConfiguration accountConfiguration)
                                             throws AlpacaAPIRequestException
Sets AccountConfiguration.

Parameters:
accountConfiguration - the account configuration
Returns:
the updated AccountConfiguration
Throws:
AlpacaAPIRequestException - thrown for AlpacaAPIRequestExceptions
See Also:
Account
 Configuration








getOrders
public List<Order> getOrders(OrderStatus status,
                             Integer limit,
                             ZonedDateTime after,
                             ZonedDateTime until,
                             SortDirection sortDirection,
                             Boolean nested,
                             List<String> symbols)
                      throws AlpacaAPIRequestException
Retrieves a list of orders for the account, filtered by the supplied query parameters.

Parameters:
status - Order status to be queried. open, closed or all. Defaults to open.
limit - The maximum number of orders in response. Defaults to 50 and max is 500.
after - The response will include only ones submitted after this timestamp (exclusive)
until - The response will include only ones submitted until this timestamp (exclusive)
sortDirection - The chronological order of response based on the submission time. asc or desc. Defaults to
                      desc.
nested - If true, the result will roll up multi-leg orders under the legs field of primary order.
symbols - A list of symbols to filter the result by (null for no filter).
Returns:
the orders
Throws:
AlpacaAPIRequestException - thrown for AlpacaAPIRequestExceptions
See Also:
Orders








requestNewOrder
public Order requestNewOrder(String symbol,
                             Double quantity,
                             Double notional,
                             OrderSide side,
                             OrderType type,
                             OrderTimeInForce timeInForce,
                             Double limitPrice,
                             Double stopPrice,
                             Double trailPrice,
                             Double trailPercent,
                             Boolean extendedHours,
                             String clientOrderId,
                             OrderClass orderClass,
                             Double takeProfitLimitPrice,
                             Double stopLossStopPrice,
                             Double stopLossLimitPrice)
                      throws AlpacaAPIRequestException
Places a new order for the given account. An order request may be rejected if the account is not authorized for
 trading, or if the tradable balance is insufficient to fill the order. Note: many of the parameters for this
 method can be set to null if they aren't required for your order type.

Parameters:
symbol - symbol or asset ID to identify the asset to trade
quantity - number of shares to trade. Can be fractional.
notional - dollar amount to trade. Cannot work with qty. Can only work for market order types
                             and day for time in force.
side - buy or sell
type - market, limit, stop, or stop_limit
timeInForce - day, gtc, opg, cls, ioc, fok. Please see Understand Orders for more info.
limitPrice - required if type is limit or stop_limit
stopPrice - required if type is stop or stop_limit
trailPrice - this or trail_percent is required if type is trailing_stop
trailPercent - this or trail_price is required if type is trailing_stop
extendedHours - (default) false. If true, order will be eligible to execute in premarket/afterhours.
                             Only works with type limit and time_in_force day.
clientOrderId - A unique identifier for the order. Automatically generated if not sent.
orderClass - Simple, bracket, oco, or oto. For details of non-simple order classes, please see
                             Bracket Order Overview on the Alpaca Docs.
takeProfitLimitPrice - Additional parameter for take-profit leg of advanced orders. Required for bracket
                             orders.
stopLossStopPrice - Additional parameters for stop-loss leg of advanced orders. Required for bracket
                             orders.
stopLossLimitPrice - Additional parameters for stop-loss leg of advanced orders. The stop-loss order
                             becomes a stop-limit order if specified.
Returns:
the order
Throws:
AlpacaAPIRequestException - thrown for AlpacaAPIRequestExceptions
See Also:
Orders








requestNewMarketOrder
public Order requestNewMarketOrder(String symbol,
                                   Integer quantity,
                                   OrderSide side,
                                   OrderTimeInForce timeInForce)
                            throws AlpacaAPIRequestException
A market order is a request to buy or sell a security at the currently available market price. It provides the
 most likely method of filling an order. Market orders fill nearly instantaneously. This method calls requestNewOrder(String, Double, Double, OrderSide, OrderType, OrderTimeInForce, Double, Double, Double, Double,
 Boolean, String, OrderClass, Double, Double, Double) with OrderType.MARKET.

Parameters:
symbol - symbol or asset ID to identify the asset to trade
quantity - number of shares to trade
side - buy or sell
timeInForce - day, gtc, opg, cls, ioc, fok. Please see Understand Orders for more info.
Returns:
the order
Throws:
AlpacaAPIRequestException - thrown for AlpacaAPIRequestExceptions
See Also:
Order Types








requestNewFractionalMarketOrder
public Order requestNewFractionalMarketOrder(String symbol,
                                             Double quantity,
                                             OrderSide side)
                                      throws AlpacaAPIRequestException
A market order is a request to buy or sell a security at the currently available market price. It provides the
 most likely method of filling an order. Market orders fill nearly instantaneously. This method calls requestNewOrder(String, Double, Double, OrderSide, OrderType, OrderTimeInForce, Double, Double, Double, Double,
 Boolean, String, OrderClass, Double, Double, Double) with OrderType.MARKET and OrderTimeInForce.DAY with a fractional quantity.

Parameters:
symbol - symbol or asset ID to identify the asset to trade
quantity - number of shares to trade. Can be fractional.
side - buy or sell
Returns:
the order
Throws:
AlpacaAPIRequestException - thrown for AlpacaAPIRequestExceptions
See Also:
Order Types








requestNewNotionalMarketOrder
public Order requestNewNotionalMarketOrder(String symbol,
                                           Double notional,
                                           OrderSide side)
                                    throws AlpacaAPIRequestException
A market order is a request to buy or sell a security at the currently available market price. It provides the
 most likely method of filling an order. Market orders fill nearly instantaneously. This method calls requestNewOrder(String, Double, Double, OrderSide, OrderType, OrderTimeInForce, Double, Double, Double, Double,
 Boolean, String, OrderClass, Double, Double, Double) with OrderType.MARKET and OrderTimeInForce.DAY with a notional dollar amount.

Parameters:
symbol - symbol or asset ID to identify the asset to trade
notional - dollar amount to trade
side - buy or sell
Returns:
the order
Throws:
AlpacaAPIRequestException - thrown for AlpacaAPIRequestExceptions
See Also:
Order Types








requestNewLimitOrder
public Order requestNewLimitOrder(String symbol,
                                  Integer quantity,
                                  OrderSide side,
                                  OrderTimeInForce timeInForce,
                                  Double limitPrice,
                                  Boolean extendedHours)
                           throws AlpacaAPIRequestException
A limit order is an order to buy or sell at a specified price or better. A buy limit order (a limit order to buy)
 is executed at the specified limit price or lower (i.e., better). Conversely, a sell limit order (a limit order
 to sell) is executed at the specified limit price or higher (better). Unlike a market order, you have to specify
 the limit price parameter when submitting your order. This method calls requestNewOrder(String, Double,
 Double, OrderSide, OrderType, OrderTimeInForce, Double, Double, Double, Double, Boolean, String, OrderClass,
 Double, Double, Double) with OrderType.LIMIT.

Parameters:
symbol - symbol or asset ID to identify the asset to trade
quantity - number of shares to trade
side - buy or sell
timeInForce - day, gtc, opg, cls, ioc, fok. Please see Understand Orders for more info.
limitPrice - required if type is limit or stop_limit
extendedHours - (default) false. If true, order will be eligible to execute in premarket/afterhours. Only
                      works with type limit and time_in_force day.
Returns:
the order
Throws:
AlpacaAPIRequestException - thrown for AlpacaAPIRequestExceptions
See Also:
Order Types








requestNewStopOrder
public Order requestNewStopOrder(String symbol,
                                 Integer quantity,
                                 OrderSide side,
                                 OrderTimeInForce timeInForce,
                                 Double stopPrice,
                                 Boolean extendedHours)
                          throws AlpacaAPIRequestException
A stop (market) order is an order to buy or sell a security when its price moves past a particular point,
 ensuring a higher probability of achieving a predetermined entry or exit price. Once the market price crosses the
 specified stop price, the stop order becomes a market order. Alpaca converts buy stop orders into stop limit
 orders with a limit price that is 4% higher than a stop price < $50 (or 2.5% higher than a stop price >=
 $50). Sell stop orders are not converted into stop limit orders. This method calls requestNewOrder(String, Double, Double, OrderSide, OrderType, OrderTimeInForce, Double, Double, Double, Double,
 Boolean, String, OrderClass, Double, Double, Double) with OrderType.STOP.

Parameters:
symbol - symbol or asset ID to identify the asset to trade
quantity - number of shares to trade
side - buy or sell
timeInForce - day, gtc, opg, cls, ioc, fok. Please see Understand Orders for more info.
stopPrice - required if type is stop or stop_limit
extendedHours - (default) false. If true, order will be eligible to execute in premarket/afterhours. Only
                      works with type limit and time_in_force day.
Returns:
the order
Throws:
AlpacaAPIRequestException - thrown for AlpacaAPIRequestExceptions
See Also:
Order Types








requestNewStopLimitOrder
public Order requestNewStopLimitOrder(String symbol,
                                      Integer quantity,
                                      OrderSide side,
                                      OrderTimeInForce timeInForce,
                                      Double limitPrice,
                                      Double stopPrice,
                                      Boolean extendedHours)
                               throws AlpacaAPIRequestException
A stop-limit order is a conditional trade over a set time frame that combines the features of a stop order with
 those of a limit order and is used to mitigate risk. The stop-limit order will be executed at a specified limit
 price, or better, after a given stop price has been reached. Once the stop price is reached, the stop-limit order
 becomes a limit order to buy or sell at the limit price or better. This method calls requestNewOrder(String, Double, Double, OrderSide, OrderType, OrderTimeInForce, Double, Double, Double, Double,
 Boolean, String, OrderClass, Double, Double, Double) with OrderType.STOP_LIMIT.

Parameters:
symbol - symbol or asset ID to identify the asset to trade
quantity - number of shares to trade
side - buy or sell
timeInForce - day, gtc, opg, cls, ioc, fok. Please see Understand Orders for more info.
limitPrice - required if type is limit or stop_limit
stopPrice - required if type is stop or stop_limit
extendedHours - (default) false. If true, order will be eligible to execute in premarket/afterhours. Only
                      works with type limit and time_in_force day.
Returns:
the order
Throws:
AlpacaAPIRequestException - thrown for AlpacaAPIRequestExceptions
See Also:
Order Types








requestNewMarketBracketOrder
public Order requestNewMarketBracketOrder(String symbol,
                                          Integer quantity,
                                          OrderSide side,
                                          OrderTimeInForce timeInForce,
                                          Double takeProfitLimitPrice,
                                          Double stopLossStopPrice,
                                          Double stopLossLimitPrice)
                                   throws AlpacaAPIRequestException
A bracket order is a chain of three orders that can be used to manage your position entry and exit. It is a
 common use case of an OTOCO (One Triggers OCO {One Cancels Other}) order. This method calls requestNewOrder(String, Double, Double, OrderSide, OrderType, OrderTimeInForce, Double, Double, Double, Double,
 Boolean, String, OrderClass, Double, Double, Double) with OrderType.MARKET and with parameters for a
 bracket order.

Parameters:
symbol - symbol or asset ID to identify the asset to trade
quantity - number of shares to trade
side - buy or sell
timeInForce - day, gtc, opg, cls, ioc, fok. Please see Understand Orders for more info.
takeProfitLimitPrice - Additional parameter for take-profit leg of advanced orders. Required for bracket
                             orders.
stopLossStopPrice - Additional parameters for stop-loss leg of advanced orders. Required for bracket
                             orders.
stopLossLimitPrice - Additional parameters for stop-loss leg of advanced orders. The stop-loss order
                             becomes a stop-limit order if specified.
Returns:
the order
Throws:
AlpacaAPIRequestException - thrown for AlpacaAPIRequestExceptions
See Also:
Order Types








requestNewLimitBracketOrder
public Order requestNewLimitBracketOrder(String symbol,
                                         Integer quantity,
                                         OrderSide side,
                                         OrderTimeInForce timeInForce,
                                         Double limitPrice,
                                         Boolean extendedHours,
                                         Double takeProfitLimitPrice,
                                         Double stopLossStopPrice,
                                         Double stopLossLimitPrice)
                                  throws AlpacaAPIRequestException
A bracket order is a chain of three orders that can be used to manage your position entry and exit. It is a
 common use case of an OTOCO (One Triggers OCO {One Cancels Other}) order. This method calls requestNewOrder(String, Double, Double, OrderSide, OrderType, OrderTimeInForce, Double, Double, Double, Double,
 Boolean, String, OrderClass, Double, Double, Double) with OrderType.LIMIT and with parameters for a
 bracket order.

Parameters:
symbol - symbol or asset ID to identify the asset to trade
quantity - number of shares to trade
side - buy or sell
timeInForce - day, gtc, opg, cls, ioc, fok. Please see Understand Orders for more info.
limitPrice - required if type is limit or stop_limit
extendedHours - (default) false. If true, order will be eligible to execute in premarket/afterhours.
                             Only works with type limit and time_in_force day.
takeProfitLimitPrice - Additional parameter for take-profit leg of advanced orders. Required for bracket
                             orders.
stopLossStopPrice - Additional parameters for stop-loss leg of advanced orders. Required for bracket
                             orders.
stopLossLimitPrice - Additional parameters for stop-loss leg of advanced orders. The stop-loss order
                             becomes a stop-limit order if specified.
Returns:
the order
Throws:
AlpacaAPIRequestException - thrown for AlpacaAPIRequestExceptions
See Also:
Order Types








requestNewOCOOrder
public Order requestNewOCOOrder(String symbol,
                                Integer quantity,
                                OrderSide side,
                                OrderTimeInForce timeInForce,
                                Boolean extendedHours,
                                Double takeProfitLimitPrice,
                                Double stopLossStopPrice,
                                Double stopLossLimitPrice)
                         throws AlpacaAPIRequestException
OCO (One-Cancels-Other) is another type of advanced order type. This is a set of two orders with the same side
 (buy/buy or sell/sell) and currently only exit order is supported. In other words, this is the second part of the
 bracket orders where the entry order is already filled, and you can submit the take-profit and stop-loss in one
 order submission. This method calls requestNewOrder(String, Double, Double, OrderSide, OrderType,
 OrderTimeInForce, Double, Double, Double, Double, Boolean, String, OrderClass, Double, Double, Double) with
 parameters for an OCO order type.

Parameters:
symbol - symbol or asset ID to identify the asset to trade
quantity - number of shares to trade
side - buy or sell
timeInForce - day, gtc, opg, cls, ioc, fok. Please see Understand Orders for more info.
extendedHours - (default) false. If true, order will be eligible to execute in premarket/afterhours.
                             Only works with type limit and time_in_force day.
takeProfitLimitPrice - Additional parameter for take-profit leg of advanced orders.
stopLossStopPrice - Additional parameters for stop-loss leg of advanced orders.
stopLossLimitPrice - Additional parameters for stop-loss leg of advanced orders. The stop-loss order
                             becomes a stop-limit order if specified.
Returns:
the order
Throws:
AlpacaAPIRequestException - thrown for AlpacaAPIRequestExceptions
See Also:
Order Types








requestNewOTOMarketOrder
public Order requestNewOTOMarketOrder(String symbol,
                                      Integer quantity,
                                      OrderSide side,
                                      OrderTimeInForce timeInForce,
                                      Double takeProfitLimitPrice,
                                      Double stopLossStopPrice,
                                      Double stopLossLimitPrice)
                               throws AlpacaAPIRequestException
OTO (One-Triggers-Other) is a variant of bracket order. It takes one of the take-profit or stop-loss order in
 addition to the entry order. This method calls requestNewOrder(String, Double, Double, OrderSide,
 OrderType, OrderTimeInForce, Double, Double, Double, Double, Boolean, String, OrderClass, Double, Double,
 Double) with OrderType.LIMIT and with parameters for an OTO order type.

Parameters:
symbol - symbol or asset ID to identify the asset to trade
quantity - number of shares to trade
side - buy or sell
timeInForce - day, gtc, opg, cls, ioc, fok. Please see Understand Orders for more info.
takeProfitLimitPrice - Additional parameter for take-profit leg of advanced orders.
stopLossStopPrice - Additional parameters for stop-loss leg of advanced orders.
stopLossLimitPrice - Additional parameters for stop-loss leg of advanced orders. The stop-loss order
                             becomes a stop-limit order if specified.
Returns:
the order
Throws:
AlpacaAPIRequestException - thrown for AlpacaAPIRequestExceptions
See Also:
Order Types








requestNewOTOLimitOrder
public Order requestNewOTOLimitOrder(String symbol,
                                     Integer quantity,
                                     OrderSide side,
                                     OrderTimeInForce timeInForce,
                                     Double limitPrice,
                                     Boolean extendedHours,
                                     Double takeProfitLimitPrice,
                                     Double stopLossStopPrice,
                                     Double stopLossLimitPrice)
                              throws AlpacaAPIRequestException
OTO (One-Triggers-Other) is a variant of bracket order. It takes one of the take-profit or stop-loss order in
 addition to the entry order. This method calls requestNewOrder(String, Double, Double, OrderSide,
 OrderType, OrderTimeInForce, Double, Double, Double, Double, Boolean, String, OrderClass, Double, Double,
 Double) with OrderType.LIMIT and with parameters for an OTO order type.

Parameters:
symbol - symbol or asset ID to identify the asset to trade
quantity - number of shares to trade
side - buy or sell
timeInForce - day, gtc, opg, cls, ioc, fok. Please see Understand Orders for more info.
limitPrice - required if type is limit or stop_limit
extendedHours - (default) false. If true, order will be eligible to execute in premarket/afterhours.
                             Only works with type limit and time_in_force day.
takeProfitLimitPrice - Additional parameter for take-profit leg of advanced orders.
stopLossStopPrice - Additional parameters for stop-loss leg of advanced orders.
stopLossLimitPrice - Additional parameters for stop-loss leg of advanced orders. The stop-loss order
                             becomes a stop-limit order if specified.
Returns:
the order
Throws:
AlpacaAPIRequestException - thrown for AlpacaAPIRequestExceptions
See Also:
Order Types








requestNewOTOStopOrder
public Order requestNewOTOStopOrder(String symbol,
                                    Integer quantity,
                                    OrderSide side,
                                    OrderTimeInForce timeInForce,
                                    Double stopPrice,
                                    Boolean extendedHours,
                                    Double takeProfitLimitPrice,
                                    Double stopLossStopPrice,
                                    Double stopLossLimitPrice)
                             throws AlpacaAPIRequestException
OTO (One-Triggers-Other) is a variant of bracket order. It takes one of the take-profit or stop-loss order in
 addition to the entry order. This method calls requestNewOrder(String, Double, Double, OrderSide,
 OrderType, OrderTimeInForce, Double, Double, Double, Double, Boolean, String, OrderClass, Double, Double,
 Double) with OrderType.STOP and with parameters for an OTO order type.

Parameters:
symbol - symbol or asset ID to identify the asset to trade
quantity - number of shares to trade
side - buy or sell
timeInForce - day, gtc, opg, cls, ioc, fok. Please see Understand Orders for more info.
stopPrice - required if type is stop or stop_limit
extendedHours - (default) false. If true, order will be eligible to execute in premarket/afterhours.
                             Only works with type limit and time_in_force day.
takeProfitLimitPrice - Additional parameter for take-profit leg of advanced orders.
stopLossStopPrice - Additional parameters for stop-loss leg of advanced orders.
stopLossLimitPrice - Additional parameters for stop-loss leg of advanced orders. The stop-loss order
                             becomes a stop-limit order if specified.
Returns:
the order
Throws:
AlpacaAPIRequestException - thrown for AlpacaAPIRequestExceptions
See Also:
Order Types








requestNewOTOStopLimitOrder
public Order requestNewOTOStopLimitOrder(String symbol,
                                         Integer quantity,
                                         OrderSide side,
                                         OrderTimeInForce timeInForce,
                                         Double limitPrice,
                                         Double stopPrice,
                                         Boolean extendedHours,
                                         Double takeProfitLimitPrice,
                                         Double stopLossStopPrice,
                                         Double stopLossLimitPrice)
                                  throws AlpacaAPIRequestException
OTO (One-Triggers-Other) is a variant of bracket order. It takes one of the take-profit or stop-loss order in
 addition to the entry order. This method calls requestNewOrder(String, Double, Double, OrderSide,
 OrderType, OrderTimeInForce, Double, Double, Double, Double, Boolean, String, OrderClass, Double, Double,
 Double) with OrderType.STOP_LIMIT and with parameters for an OTO order type.

Parameters:
symbol - symbol or asset ID to identify the asset to trade
quantity - number of shares to trade
side - buy or sell
timeInForce - day, gtc, opg, cls, ioc, fok. Please see Understand Orders for more info.
limitPrice - required if type is limit or stop_limit
stopPrice - required if type is stop or stop_limit
extendedHours - (default) false. If true, order will be eligible to execute in premarket/afterhours.
                             Only works with type limit and time_in_force day.
takeProfitLimitPrice - Additional parameter for take-profit leg of advanced orders.
stopLossStopPrice - Additional parameters for stop-loss leg of advanced orders.
stopLossLimitPrice - Additional parameters for stop-loss leg of advanced orders. The stop-loss order
                             becomes a stop-limit order if specified.
Returns:
the order
Throws:
AlpacaAPIRequestException - thrown for AlpacaAPIRequestExceptions
See Also:
Order Types








requestNewTrailingStopPriceOrder
public Order requestNewTrailingStopPriceOrder(String symbol,
                                              Integer quantity,
                                              OrderSide side,
                                              OrderTimeInForce timeInForce,
                                              Double trailPrice,
                                              Boolean extendedHours)
                                       throws AlpacaAPIRequestException
Trailing stop orders allow you to continuously and automatically keep updating the stop price threshold based on
 the stock price movement. This method calls requestNewOrder(String, Double, Double, OrderSide, OrderType,
 OrderTimeInForce, Double, Double, Double, Double, Boolean, String, OrderClass, Double, Double, Double) with
 OrderType.TRAILING_STOP and with parameters for a Trailing Stop Price order type.

Parameters:
symbol - symbol or asset ID to identify the asset to trade
quantity - number of shares to trade
side - buy or sell
timeInForce - day, gtc, opg, cls, ioc, fok. Please see Understand Orders for more info.
trailPrice - this or trail_percent is required if type is trailing_stop
extendedHours - (default) false. If true, order will be eligible to execute in premarket/afterhours. Only
                      works with type limit and time_in_force day.
Returns:
the order
Throws:
AlpacaAPIRequestException - thrown for AlpacaAPIRequestExceptions
See Also:
Order Types








requestNewTrailingStopPercentOrder
public Order requestNewTrailingStopPercentOrder(String symbol,
                                                Integer quantity,
                                                OrderSide side,
                                                OrderTimeInForce timeInForce,
                                                Double trailPercent,
                                                Boolean extendedHours)
                                         throws AlpacaAPIRequestException
Trailing stop orders allow you to continuously and automatically keep updating the stop price threshold based on
 the stock price movement. This method calls requestNewOrder(String, Double, Double, OrderSide, OrderType,
 OrderTimeInForce, Double, Double, Double, Double, Boolean, String, OrderClass, Double, Double, Double) with
 OrderType.TRAILING_STOP and with parameters for a Trailing Stop Percent order type.

Parameters:
symbol - symbol or asset ID to identify the asset to trade
quantity - number of shares to trade
side - buy or sell
timeInForce - day, gtc, opg, cls, ioc, fok. Please see Understand Orders for more info.
trailPercent - this or trail_price is required if type is trailing_stop
extendedHours - (default) false. If true, order will be eligible to execute in premarket/afterhours. Only
                      works with type limit and time_in_force day.
Returns:
the order
Throws:
AlpacaAPIRequestException - thrown for AlpacaAPIRequestExceptions
See Also:
Order Types








getOrder
public Order getOrder(String orderID,
                      Boolean nested)
               throws AlpacaAPIRequestException
Retrieves a single order for the given order_id.

Parameters:
orderID - Order ID
nested - If true, the result will roll up multi-leg orders under the legs field of primary order.
Returns:
the order
Throws:
AlpacaAPIRequestException - thrown for AlpacaAPIRequestExceptions
See Also:
Orders








getOrderByClientID
public Order getOrderByClientID(String clientOrderId)
                         throws AlpacaAPIRequestException
Retrieves a single order for the given client_order_id.

Parameters:
clientOrderId - the client order id
Returns:
the order by client id
Throws:
AlpacaAPIRequestException - thrown for AlpacaAPIRequestExceptions
See Also:
Orders








replaceOrder
public Order replaceOrder(String orderID,
                          Integer quantity,
                          OrderTimeInForce timeInForce,
                          Double limitPrice,
                          Double stopPrice,
                          Double trail,
                          String clientOrderId)
                   throws AlpacaAPIRequestException
Replaces a single order with updated parameters. Each parameter overrides the corresponding attribute of the
 existing order. The other attributes remain the same as the existing order.

Parameters:
orderID - Order id
quantity - number of shares to trade
timeInForce - day, gtc, opg, cls, ioc, fok. Please see Understand Orders for more info.
limitPrice - required if type is limit or stop_limit
stopPrice - required if type is stop or stop_limit
trail - the new value of the trail_price or trail_percent value (works only for type=trailing_stop)
clientOrderId - A unique identifier for the order. Automatically generated if not sent.
Returns:
the order
Throws:
AlpacaAPIRequestException - thrown for AlpacaAPIRequestExceptions
See Also:
Orders








cancelAllOrders
public ArrayList<CancelledOrder> cancelAllOrders()
                                          throws AlpacaAPIRequestException
Attempts to cancel all open orders. A response will be provided for each order that is attempted to be cancelled.
 If an order is no longer cancelable, the server will respond with status 500 and reject the request.

Returns:
the array list of cancelled orders
Throws:
AlpacaAPIRequestException - thrown for AlpacaAPIRequestExceptions
See Also:
Orders








cancelOrder
public boolean cancelOrder(String orderId)
                    throws AlpacaAPIRequestException
Attempts to cancel an open order. If the order is no longer cancelable (example: status=order_filled), the server
 will respond with status 422, and reject the request.

Parameters:
orderId - Order ID
Returns:
true, if successful
Throws:
AlpacaAPIRequestException - thrown for AlpacaAPIRequestExceptions
See Also:
Orders








getOpenPositions
public ArrayList<Position> getOpenPositions()
                                     throws AlpacaAPIRequestException
Gets the open positions.

Returns:
the open positions
Throws:
AlpacaAPIRequestException - thrown for AlpacaAPIRequestExceptions
See Also:
Positions








getOpenPositionBySymbol
public Position getOpenPositionBySymbol(String symbol)
                                 throws AlpacaAPIRequestException
Gets the open position by symbol.

Parameters:
symbol - the symbol or asset_id (required)
Returns:
the open position by symbol
Throws:
AlpacaAPIRequestException - thrown for AlpacaAPIRequestExceptions
See Also:
Positions








closeAllPositions
public ArrayList<ClosePositionOrder> closeAllPositions()
                                                throws AlpacaAPIRequestException
Closes (liquidates) all of the account’s open long and short positions. A response will be provided for each
 order that is attempted to be cancelled. If an order is no longer cancelable, the server will respond with status
 500 and reject the request.

Returns:
a list of closing position orders
Throws:
AlpacaAPIRequestException - thrown for AlpacaAPIRequestExceptions
See Also:
Positions








closePosition
public Order closePosition(String symbol)
                    throws AlpacaAPIRequestException
Closes (liquidates) the account’s open position for the given symbol. Works for both long and short positions.

Parameters:
symbol - symbol or asset_id
Returns:
a closing position order
Throws:
AlpacaAPIRequestException - thrown for AlpacaAPIRequestExceptions
See Also:
Positions








getAssets
public ArrayList<Asset> getAssets(AssetStatus assetStatus,
                                  String assetClass)
                           throws AlpacaAPIRequestException
Get a list of assets.

Parameters:
assetStatus - e.g. “active”. By default, all statuses are included.
assetClass - Defaults to us_equity.
Returns:
the assets
Throws:
AlpacaAPIRequestException - thrown for AlpacaAPIRequestExceptions
See Also:
Assets








getAssetBySymbol
public Asset getAssetBySymbol(String symbolOrAssetID)
                       throws AlpacaAPIRequestException
Gets the asset by symbol or asset_id.

Parameters:
symbolOrAssetID - the symbol or asset_id (required)
Returns:
the asset by symbol
Throws:
AlpacaAPIRequestException - thrown for AlpacaAPIRequestExceptions
See Also:
Assets








getWatchlists
public ArrayList<Watchlist> getWatchlists()
                                   throws AlpacaAPIRequestException
Returns the list of watchlists registered under the account.

Returns:
the watch lists
Throws:
AlpacaAPIRequestException - thrown for AlpacaAPIRequestExceptions
See Also:
Watchlists








createWatchlist
public Watchlist createWatchlist(String name,
                                 String... symbols)
                          throws AlpacaAPIRequestException
Create a new watchlist with initial set of assets.

Parameters:
name - arbitrary name string, up to 64 characters
symbols - set of symbol string
Returns:
the created watchlist
Throws:
AlpacaAPIRequestException - thrown for AlpacaAPIRequestExceptions
See Also:
Watchlists








getWatchlist
public Watchlist getWatchlist(String watchlistID)
                       throws AlpacaAPIRequestException
Returns a watchlist identified by the ID.

Parameters:
watchlistID - Watchlist ID
Returns:
the watchlist
Throws:
AlpacaAPIRequestException - thrown for AlpacaAPIRequestExceptions
See Also:
Watchlists








updateWatchlist
public Watchlist updateWatchlist(String watchlistID,
                                 String name,
                                 String... symbols)
                          throws AlpacaAPIRequestException
Update the name and/or content of watchlist.

Parameters:
watchlistID - Watchlist ID
name - the new watchlist name
symbols - the new list of symbol names to replace the watchlist content
Returns:
the updated watchlist
Throws:
AlpacaAPIRequestException - thrown for AlpacaAPIRequestExceptions
See Also:
Watchlists








addWatchlistAsset
public Watchlist addWatchlistAsset(String watchlistID,
                                   String symbol)
                            throws AlpacaAPIRequestException
Append an asset for the symbol to the end of watchlist asset list

Parameters:
watchlistID - Watchlist ID
symbol - the symbol name to add to the watchlist
Returns:
the watchlist
Throws:
AlpacaAPIRequestException - thrown for AlpacaAPIRequestExceptions
See Also:
Watchlists








deleteWatchlist
public boolean deleteWatchlist(String watchlistID)
                        throws AlpacaAPIRequestException
Delete a watchlist. This is a permanent deletion.

Parameters:
watchlistID - Watchlist ID
Returns:
if the watchlist was deleted
Throws:
AlpacaAPIRequestException - thrown for AlpacaAPIRequestExceptions
See Also:
Watchlists








removeSymbolFromWatchlist
public Watchlist removeSymbolFromWatchlist(String watchlistID,
                                           String symbol)
                                    throws AlpacaAPIRequestException
Delete one entry for an asset by symbol name.

Parameters:
watchlistID - Watchlist ID
symbol - symbol name to remove from the watchlist content
Returns:
the updated watchlist
Throws:
AlpacaAPIRequestException - thrown for AlpacaAPIRequestExceptions
See Also:
Watchlists








getPortfolioHistory
public PortfolioHistory getPortfolioHistory(Integer periodLength,
                                            PortfolioPeriodUnit periodUnit,
                                            PortfolioTimeFrame timeFrame,
                                            LocalDate dateEnd,
                                            Boolean extendedHours)
                                     throws AlpacaAPIRequestException
Returns timeseries data about equity and profit/loss (P/L) of the account in requested timespan.

Parameters:
periodLength - The duration of the data in "number + unit", such as 1D, where unit can be D for day, W for
                      week, M for month and A for year. Defaults to 1M. This parameter is the number.
periodUnit - The duration of the data in "number + unit", such as 1D, where unit can be D for day, W for
                      week, M for month and A for year. Defaults to 1M. This parameter is the unit.
timeFrame - The resolution of time window. 1Min, 5Min, 15Min, 1H, or 1D. If omitted, 1Min for less than
                      7 days period, 15Min for less than 30 days, or otherwise 1D.
dateEnd - The date the data is returned up to, in "YYYY-MM-DD" format. Defaults to the current market
                      date (rolls over at the market open if extended_hours is false, otherwise at 7am ET)
extendedHours - If true, include extended hours in the result. This is effective only for timeframe less
                      than 1D.
Returns:
the portfolio history
Throws:
AlpacaAPIRequestException - thrown for AlpacaAPIRequestExceptions








getCalendar
public List<Calendar> getCalendar()
                           throws AlpacaAPIRequestException
Returns the market Calendar from 1970 to 2029.

Returns:
the Calendar List
Throws:
AlpacaAPIRequestException - thrown for AlpacaAPIRequestExceptions
See Also:
Calendar








getCalendar
public List<Calendar> getCalendar(LocalDate start,
                                  LocalDate end)
                           throws AlpacaAPIRequestException
Returns the market Calendar.

Parameters:
start - the first date to retrieve data for (inclusive)
end - the last date to retrieve data for (inclusive)
Returns:
the Calendar List
Throws:
AlpacaAPIRequestException - thrown for AlpacaAPIRequestExceptions
See Also:
Calendar








getClock
public Clock getClock()
               throws AlpacaAPIRequestException
Returns the market Clock.

Returns:
the Clock
Throws:
AlpacaAPIRequestException - thrown for AlpacaAPIRequestExceptions
See Also:
Clock








getTrades
public TradesResponse getTrades(String symbol,
                                ZonedDateTime start,
                                ZonedDateTime end,
                                Integer limit,
                                String pageToken)
                         throws AlpacaAPIRequestException
Gets Trade historical data for the requested security.

Parameters:
symbol - the symbol to query for
start - filter data equal to or after this ZonedDateTime. Fractions of a second are not
                  accepted
end - filter data equal to or before this ZonedDateTime. Fractions of a second are not
                  accepted
limit - number of data points to return. Must be in range 1-10000, defaults to 1000 if null is given
pageToken - pagination token to continue from
Returns:
the TradesResponse
Throws:
AlpacaAPIRequestException - thrown for AlpacaAPIRequestExceptions
See Also:

 Historical Market Data








getQuotes
public QuotesResponse getQuotes(String symbol,
                                ZonedDateTime start,
                                ZonedDateTime end,
                                Integer limit,
                                String pageToken)
                         throws AlpacaAPIRequestException
Gets Quote (NBBO or National Best Bid and Offer) historical data for the requested security.

Parameters:
symbol - the symbol to query for
start - filter data equal to or after this ZonedDateTime. Fractions of a second are not
                  accepted
end - filter data equal to or before this ZonedDateTime. Fractions of a second are not
                  accepted
limit - number of data points to return. Must be in range 1-10000, defaults to 1000 if null is given
pageToken - pagination token to continue from
Returns:
the QuotesResponse
Throws:
AlpacaAPIRequestException - thrown for AlpacaAPIRequestExceptions
See Also:

 Historical Market Data








getBars
public BarsResponse getBars(String symbol,
                            ZonedDateTime start,
                            ZonedDateTime end,
                            Integer limit,
                            String pageToken,
                            BarsTimeFrame timeFrame)
                     throws AlpacaAPIRequestException
Gets Bar aggregate historical data for the requested security.

Parameters:
symbol - the symbol to query for
start - filter data equal to or after this ZonedDateTime. Fractions of a second are not
                  accepted
end - filter data equal to or before this ZonedDateTime. Fractions of a second are not
                  accepted
limit - number of data points to return. Must be in range 1-10000, defaults to 1000 if null is given
pageToken - pagination token to continue from
timeFrame - the BarsTimeFrame for the aggregation
Returns:
the BarsResponse
Throws:
AlpacaAPIRequestException - thrown for AlpacaAPIRequestExceptions
See Also:

 Historical Market Data








addAlpacaStreamListener
public void addAlpacaStreamListener(AlpacaStreamListener streamListener)
                             throws WebsocketException
Adds the AlpacaStreamListener. Note that when the first AlpacaStreamListener is added, the
 Websocket connection is created.

Parameters:
streamListener - the stream listener
Throws:
WebsocketException - thrown for WebsocketExceptions








removeAlpacaStreamListener
public void removeAlpacaStreamListener(AlpacaStreamListener streamListener)
                                throws WebsocketException
Removes the AlpacaStreamListener. Note that when the last AlpacaStreamListener is removed, the
 Websocket connection is closed.

Parameters:
streamListener - the AlpacaStreamListener
Throws:
WebsocketException - thrown for WebsocketExceptions








addMarketDataStreamListener
public void addMarketDataStreamListener(MarketDataListener streamListener)
                                 throws WebsocketException
Adds the MarketDataListener. Note that when the first AlpacaStreamListener is added, the
 Websocket connection is created.

Parameters:
streamListener - the MarketDataListener
Throws:
WebsocketException - thrown for WebsocketExceptions








removeMarketDataStreamListener
public void removeMarketDataStreamListener(MarketDataListener streamListener)
                                    throws WebsocketException
Removes the MarketDataListener. Note that when the last MarketDataListener is removed, the
 Websocket connection is closed.

Parameters:
streamListener - the MarketDataListener
Throws:
WebsocketException - thrown for WebsocketExceptions








toString
public String toString()

Overrides:
toString in class Object

Modifier and Type	Method and Description
`void`	`addAlpacaStreamListener(AlpacaStreamListener streamListener)` Adds the `AlpacaStreamListener`.
`void`	`addMarketDataStreamListener(MarketDataListener streamListener)` Adds the `MarketDataListener`.
`Watchlist`	`addWatchlistAsset(String watchlistID, String symbol)` Append an asset for the symbol to the end of watchlist asset list
`ArrayList<CancelledOrder>`	`cancelAllOrders()` Attempts to cancel all open orders.
`boolean`	`cancelOrder(String orderId)` Attempts to cancel an open order.
`ArrayList<ClosePositionOrder>`	`closeAllPositions()` Closes (liquidates) all of the account’s open long and short positions.
`Order`	`closePosition(String symbol)` Closes (liquidates) the account’s open position for the given symbol.
`Watchlist`	`createWatchlist(String name, String... symbols)` Create a new watchlist with initial set of assets.
`boolean`	`deleteWatchlist(String watchlistID)` Delete a watchlist.
`Account`	`getAccount()` Returns the `Account` associated with the API key.
`List<AccountActivity>`	`getAccountActivities(ZonedDateTime date, ZonedDateTime until, ZonedDateTime after, SortDirection sortDirection, Integer pageSize, String pageToken, ActivityType... activityTypes)` Returns `AccountActivity` entries for many or for a specific type of activity.
`AccountConfiguration`	`getAccountConfiguration()` Returns the current `AccountConfiguration` values.
`Asset`	`getAssetBySymbol(String symbolOrAssetID)` Gets the asset by symbol or asset_id.
`ArrayList<Asset>`	`getAssets(AssetStatus assetStatus, String assetClass)` Get a list of assets.
`BarsResponse`	`getBars(String symbol, ZonedDateTime start, ZonedDateTime end, Integer limit, String pageToken, BarsTimeFrame timeFrame)` Gets `Bar` aggregate historical data for the requested security.
`List<Calendar>`	`getCalendar()` Returns the market `Calendar` from 1970 to 2029.
`List<Calendar>`	`getCalendar(LocalDate start, LocalDate end)` Returns the market `Calendar`.
`Clock`	`getClock()` Returns the market `Clock`.
`Position`	`getOpenPositionBySymbol(String symbol)` Gets the open position by symbol.
`ArrayList<Position>`	`getOpenPositions()` Gets the open positions.
`Order`	`getOrder(String orderID, Boolean nested)` Retrieves a single order for the given order_id.
`Order`	`getOrderByClientID(String clientOrderId)` Retrieves a single order for the given client_order_id.
`List<Order>`	`getOrders(OrderStatus status, Integer limit, ZonedDateTime after, ZonedDateTime until, SortDirection sortDirection, Boolean nested, List<String> symbols)` Retrieves a list of orders for the account, filtered by the supplied query parameters.
`PortfolioHistory`	`getPortfolioHistory(Integer periodLength, PortfolioPeriodUnit periodUnit, PortfolioTimeFrame timeFrame, LocalDate dateEnd, Boolean extendedHours)` Returns timeseries data about equity and profit/loss (P/L) of the account in requested timespan.
`QuotesResponse`	`getQuotes(String symbol, ZonedDateTime start, ZonedDateTime end, Integer limit, String pageToken)` Gets `Quote` (NBBO or National Best Bid and Offer) historical data for the requested security.
`TradesResponse`	`getTrades(String symbol, ZonedDateTime start, ZonedDateTime end, Integer limit, String pageToken)` Gets `Trade` historical data for the requested security.
`Watchlist`	`getWatchlist(String watchlistID)` Returns a watchlist identified by the ID.
`ArrayList<Watchlist>`	`getWatchlists()` Returns the list of watchlists registered under the account.
`void`	`removeAlpacaStreamListener(AlpacaStreamListener streamListener)` Removes the `AlpacaStreamListener`.
`void`	`removeMarketDataStreamListener(MarketDataListener streamListener)` Removes the `MarketDataListener`.
`Watchlist`	`removeSymbolFromWatchlist(String watchlistID, String symbol)` Delete one entry for an asset by symbol name.
`Order`	`replaceOrder(String orderID, Integer quantity, OrderTimeInForce timeInForce, Double limitPrice, Double stopPrice, Double trail, String clientOrderId)` Replaces a single order with updated parameters.
`Order`	`requestNewFractionalMarketOrder(String symbol, Double quantity, OrderSide side)` A market order is a request to buy or sell a security at the currently available market price.
`Order`	`requestNewLimitBracketOrder(String symbol, Integer quantity, OrderSide side, OrderTimeInForce timeInForce, Double limitPrice, Boolean extendedHours, Double takeProfitLimitPrice, Double stopLossStopPrice, Double stopLossLimitPrice)` A bracket order is a chain of three orders that can be used to manage your position entry and exit.
`Order`	`requestNewLimitOrder(String symbol, Integer quantity, OrderSide side, OrderTimeInForce timeInForce, Double limitPrice, Boolean extendedHours)` A limit order is an order to buy or sell at a specified price or better.
`Order`	`requestNewMarketBracketOrder(String symbol, Integer quantity, OrderSide side, OrderTimeInForce timeInForce, Double takeProfitLimitPrice, Double stopLossStopPrice, Double stopLossLimitPrice)` A bracket order is a chain of three orders that can be used to manage your position entry and exit.
`Order`	`requestNewMarketOrder(String symbol, Integer quantity, OrderSide side, OrderTimeInForce timeInForce)` A market order is a request to buy or sell a security at the currently available market price.
`Order`	`requestNewNotionalMarketOrder(String symbol, Double notional, OrderSide side)` A market order is a request to buy or sell a security at the currently available market price.
`Order`	`requestNewOCOOrder(String symbol, Integer quantity, OrderSide side, OrderTimeInForce timeInForce, Boolean extendedHours, Double takeProfitLimitPrice, Double stopLossStopPrice, Double stopLossLimitPrice)` OCO (One-Cancels-Other) is another type of advanced order type.
`Order`	`requestNewOrder(String symbol, Double quantity, Double notional, OrderSide side, OrderType type, OrderTimeInForce timeInForce, Double limitPrice, Double stopPrice, Double trailPrice, Double trailPercent, Boolean extendedHours, String clientOrderId, OrderClass orderClass, Double takeProfitLimitPrice, Double stopLossStopPrice, Double stopLossLimitPrice)` Places a new order for the given account.
`Order`	`requestNewOTOLimitOrder(String symbol, Integer quantity, OrderSide side, OrderTimeInForce timeInForce, Double limitPrice, Boolean extendedHours, Double takeProfitLimitPrice, Double stopLossStopPrice, Double stopLossLimitPrice)` OTO (One-Triggers-Other) is a variant of bracket order.
`Order`	`requestNewOTOMarketOrder(String symbol, Integer quantity, OrderSide side, OrderTimeInForce timeInForce, Double takeProfitLimitPrice, Double stopLossStopPrice, Double stopLossLimitPrice)` OTO (One-Triggers-Other) is a variant of bracket order.
`Order`	`requestNewOTOStopLimitOrder(String symbol, Integer quantity, OrderSide side, OrderTimeInForce timeInForce, Double limitPrice, Double stopPrice, Boolean extendedHours, Double takeProfitLimitPrice, Double stopLossStopPrice, Double stopLossLimitPrice)` OTO (One-Triggers-Other) is a variant of bracket order.
`Order`	`requestNewOTOStopOrder(String symbol, Integer quantity, OrderSide side, OrderTimeInForce timeInForce, Double stopPrice, Boolean extendedHours, Double takeProfitLimitPrice, Double stopLossStopPrice, Double stopLossLimitPrice)` OTO (One-Triggers-Other) is a variant of bracket order.
`Order`	`requestNewStopLimitOrder(String symbol, Integer quantity, OrderSide side, OrderTimeInForce timeInForce, Double limitPrice, Double stopPrice, Boolean extendedHours)` A stop-limit order is a conditional trade over a set time frame that combines the features of a stop order with those of a limit order and is used to mitigate risk.
`Order`	`requestNewStopOrder(String symbol, Integer quantity, OrderSide side, OrderTimeInForce timeInForce, Double stopPrice, Boolean extendedHours)` A stop (market) order is an order to buy or sell a security when its price moves past a particular point, ensuring a higher probability of achieving a predetermined entry or exit price.
`Order`	`requestNewTrailingStopPercentOrder(String symbol, Integer quantity, OrderSide side, OrderTimeInForce timeInForce, Double trailPercent, Boolean extendedHours)` Trailing stop orders allow you to continuously and automatically keep updating the stop price threshold based on the stock price movement.
`Order`	`requestNewTrailingStopPriceOrder(String symbol, Integer quantity, OrderSide side, OrderTimeInForce timeInForce, Double trailPrice, Boolean extendedHours)` Trailing stop orders allow you to continuously and automatically keep updating the stop price threshold based on the stock price movement.
`AccountConfiguration`	`setAccountConfiguration(AccountConfiguration accountConfiguration)` Sets `AccountConfiguration`.
`String`	`toString()`
`Watchlist`	`updateWatchlist(String watchlistID, String name, String... symbols)` Update the name and/or content of watchlist.

Class AlpacaAPI

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

AlpacaAPI

AlpacaAPI

AlpacaAPI

AlpacaAPI

AlpacaAPI

Method Detail

getAccount

getAccountActivities

getAccountConfiguration

setAccountConfiguration

getOrders

requestNewOrder

requestNewMarketOrder

requestNewFractionalMarketOrder

requestNewNotionalMarketOrder

requestNewLimitOrder

requestNewStopOrder

requestNewStopLimitOrder

requestNewMarketBracketOrder

requestNewLimitBracketOrder

requestNewOCOOrder

requestNewOTOMarketOrder

requestNewOTOLimitOrder

requestNewOTOStopOrder

requestNewOTOStopLimitOrder

requestNewTrailingStopPriceOrder

requestNewTrailingStopPercentOrder

getOrder

getOrderByClientID

replaceOrder

cancelAllOrders

cancelOrder

getOpenPositions

getOpenPositionBySymbol

closeAllPositions

closePosition

getAssets

getAssetBySymbol

getWatchlists

createWatchlist

getWatchlist

updateWatchlist

addWatchlistAsset

deleteWatchlist

removeSymbolFromWatchlist

getPortfolioHistory

getCalendar

getCalendar

getClock

getTrades

getQuotes

getBars

addAlpacaStreamListener

removeAlpacaStreamListener

addMarketDataStreamListener

removeMarketDataStreamListener

toString