io.github.mainstringargs.alpaca

Class AlpacaAPI

java.lang.Object

io.github.mainstringargs.alpaca.AlpacaAPI

public class AlpacaAPI
extends java.lang.Object

The Class AlpacaAPI.

Constructor Summary

Constructors

Constructor and Description
AlpacaAPI() Instantiates a new Alpaca API using properties specified in alpaca.properties file (or relevant defaults)
AlpacaAPI(java.lang.String apiVersion) Instantiates a new Alpaca API using the specified apiVersion
AlpacaAPI(java.lang.String apiVersion, java.lang.String keyId, java.lang.String secret) Instantiates a new Alpaca API using the specified apiVersion, keyId, and secret.
AlpacaAPI(java.lang.String apiVersion, java.lang.String keyId, java.lang.String secret, java.lang.String baseAPIURL) Instantiates a new Alpaca API using the specified apiVersion, keyId, secret, and baseAPIURL.
AlpacaAPI(java.lang.String apiVersion, java.lang.String keyId, java.lang.String secret, java.lang.String baseAPIURL, java.lang.String baseDataUrl) Instantiates a new Alpaca API using the specified keyId, secret, baseAPIURL, and baseDataUrl.

Method Summary

Modifier and Type	Method and Description
void	addAlpacaStreamListener(AlpacaStreamListener streamListener) Adds the alpaca stream listener.
Watchlist	addWatchlistAsset(java.lang.String watchlistID, java.lang.String symbol) Append an asset for the symbol to the end of watchlist asset list
java.util.ArrayList<CancelledOrder>	cancelAllOrders() Attempts to cancel all open orders.
boolean	cancelOrder(java.lang.String orderId) Attempts to cancel an open order.
java.util.ArrayList<ClosePositionOrder>	closeAllPositions() Closes (liquidates) all of the account’s open long and short positions.
Order	closePosition(java.lang.String symbol) Closes (liquidates) the account’s open position for the given symbol.
Watchlist	createWatchlist(java.lang.String name, java.lang.String... symbols) Create a new watchlist with initial set of assets.
boolean	deleteWatchlist(java.lang.String watchlistID) Delete a watchlist.
Account	getAccount() Returns the account associated with the API key.
java.util.ArrayList<AccountActivity>	getAccountActivities(java.time.ZonedDateTime date, java.time.ZonedDateTime until, java.time.ZonedDateTime after, Direction direction, java.lang.Integer pageSize, java.lang.String pageToken, ActivityType... activityTypes) Returns account activity entries for many or for a specific type of activity.
AccountConfiguration	getAccountConfiguration() Returns the current account configuration values.
Asset	getAssetBySymbol(java.lang.String symbolOrAssetID) Gets the asset by symbol or asset_id.
java.util.ArrayList<Asset>	getAssets(AssetStatus assetStatus, java.lang.String assetClass) Get a list of assets.
java.util.Map<java.lang.String,java.util.ArrayList<Bar>>	getBars(BarsTimeFrame timeframe, java.lang.String[] symbols, java.lang.Integer limit, java.time.ZonedDateTime start, java.time.ZonedDateTime end, java.time.ZonedDateTime after, java.time.ZonedDateTime until) Retrieves a list of bars for each requested symbol.
java.util.Map<java.lang.String,java.util.ArrayList<Bar>>	getBars(BarsTimeFrame timeframe, java.lang.String symbol, java.lang.Integer limit, java.time.ZonedDateTime start, java.time.ZonedDateTime end, java.time.ZonedDateTime after, java.time.ZonedDateTime until) Retrieves a list of bars for each requested symbol.
java.util.ArrayList<Calendar>	getCalendar() Returns the market calendar.
java.util.ArrayList<Calendar>	getCalendar(java.time.LocalDate start, java.time.LocalDate end) Returns the market calendar.
Clock	getClock() Returns the market clock.
Position	getOpenPositionBySymbol(java.lang.String symbol) Gets the open position by symbol.
java.util.ArrayList<Position>	getOpenPositions() Gets the open positions.
Order	getOrder(java.lang.String orderID, java.lang.Boolean nested) Retrieves a single order for the given order_id.
Order	getOrderByClientID(java.lang.String clientOrderId) Retrieves a single order for the given client_order_id.
java.util.ArrayList<Order>	getOrders(OrderStatus status, java.lang.Integer limit, java.time.ZonedDateTime after, java.time.ZonedDateTime until, Direction direction, java.lang.Boolean nested) Retrieves a list of orders for the account, filtered by the supplied query parameters.
PortfolioHistory	getPortfolioHistory(java.lang.Integer periodLength, PortfolioPeriodUnit periodUnit, PortfolioTimeFrame timeFrame, java.time.LocalDate dateEnd, java.lang.Boolean extendedHours) Returns timeseries data about equity and profit/loss (P/L) of the account in requested timespan.
Watchlist	getWatchlist(java.lang.String watchlistID) Returns a watchlist identified by the ID.
java.util.ArrayList<Watchlist>	getWatchlists() Returns the list of watchlists registered under the account.
void	removeAlpacaStreamListener(AlpacaStreamListener streamListener) Removes the alpaca stream listener.
Watchlist	removeSymbolFromWatchlist(java.lang.String watchlistID, java.lang.String symbol) Delete one entry for an asset by symbol name.
Order	replaceOrder(java.lang.String orderID, java.lang.Integer quantity, OrderTimeInForce timeInForce, java.lang.Double limitPrice, java.lang.Double stopPrice, java.lang.String clientOrderId) Replaces a single order with updated parameters.
Order	requestNewLimitBracketOrder(java.lang.String symbol, java.lang.Integer quantity, OrderSide side, OrderTimeInForce timeInForce, java.lang.Double limitPrice, java.lang.Boolean extendedHours, java.lang.Double takeProfitLimitPrice, java.lang.Double stopLossStopPrice, java.lang.Double stopLossLimitPrice) A bracket order is a chain of three orders that can be used to manage your position entry and exit.
Order	requestNewLimitOrder(java.lang.String symbol, java.lang.Integer quantity, OrderSide side, OrderTimeInForce timeInForce, java.lang.Double limitPrice, java.lang.Boolean extendedHours) A limit order is an order to buy or sell at a specified price or better.
Order	requestNewMarketBracketOrder(java.lang.String symbol, java.lang.Integer quantity, OrderSide side, OrderTimeInForce timeInForce, java.lang.Boolean extendedHours, java.lang.Double takeProfitLimitPrice, java.lang.Double stopLossStopPrice, java.lang.Double stopLossLimitPrice) A bracket order is a chain of three orders that can be used to manage your position entry and exit.
Order	requestNewMarketOrder(java.lang.String symbol, java.lang.Integer quantity, OrderSide side, OrderTimeInForce timeInForce, java.lang.Boolean extendedHours) A market order is a request to buy or sell a security at the currently available market price.
Order	requestNewOCOOrder(java.lang.String symbol, java.lang.Integer quantity, OrderSide side, OrderTimeInForce timeInForce, java.lang.Boolean extendedHours, java.lang.Double takeProfitLimitPrice, java.lang.Double stopLossStopPrice, java.lang.Double stopLossLimitPrice) OCO (One-Cancels-Other) is another type of advanced order type.
Order	requestNewOrder(java.lang.String symbol, java.lang.Integer quantity, OrderSide side, OrderType type, OrderTimeInForce timeInForce, java.lang.Double limitPrice, java.lang.Double stopPrice, java.lang.Boolean extendedHours, java.lang.String clientOrderId, OrderClass orderClass, java.lang.Double takeProfitLimitPrice, java.lang.Double stopLossStopPrice, java.lang.Double stopLossLimitPrice) Places a new order for the given account.
Order	requestNewOTOLimitOrder(java.lang.String symbol, java.lang.Integer quantity, OrderSide side, OrderTimeInForce timeInForce, java.lang.Double limitPrice, java.lang.Boolean extendedHours, java.lang.Double takeProfitLimitPrice, java.lang.Double stopLossStopPrice, java.lang.Double stopLossLimitPrice) OTO (One-Triggers-Other) is a variant of bracket order.
Order	requestNewOTOMarketOrder(java.lang.String symbol, java.lang.Integer quantity, OrderSide side, OrderTimeInForce timeInForce, java.lang.Boolean extendedHours, java.lang.Double takeProfitLimitPrice, java.lang.Double stopLossStopPrice, java.lang.Double stopLossLimitPrice) OTO (One-Triggers-Other) is a variant of bracket order.
Order	requestNewOTOStopLimitOrder(java.lang.String symbol, java.lang.Integer quantity, OrderSide side, OrderTimeInForce timeInForce, java.lang.Double limitPrice, java.lang.Double stopPrice, java.lang.Boolean extendedHours, java.lang.Double takeProfitLimitPrice, java.lang.Double stopLossStopPrice, java.lang.Double stopLossLimitPrice) OTO (One-Triggers-Other) is a variant of bracket order.
Order	requestNewOTOStopOrder(java.lang.String symbol, java.lang.Integer quantity, OrderSide side, OrderTimeInForce timeInForce, java.lang.Double stopPrice, java.lang.Boolean extendedHours, java.lang.Double takeProfitLimitPrice, java.lang.Double stopLossStopPrice, java.lang.Double stopLossLimitPrice) OTO (One-Triggers-Other) is a variant of bracket order.
Order	requestNewStopLimitOrder(java.lang.String symbol, java.lang.Integer quantity, OrderSide side, OrderTimeInForce timeInForce, java.lang.Double limitPrice, java.lang.Double stopPrice, java.lang.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(java.lang.String symbol, java.lang.Integer quantity, OrderSide side, OrderTimeInForce timeInForce, java.lang.Double stopPrice, java.lang.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.
AccountConfiguration	setAccountConfiguration(AccountConfiguration accountConfiguration) Sets account configuration.
java.lang.String	toString()
Watchlist	updateWatchlist(java.lang.String watchlistID, java.lang.String name, java.lang.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 Alpaca API using properties specified in alpaca.properties file (or relevant defaults)

AlpacaAPI

public AlpacaAPI(java.lang.String apiVersion)

Instantiates a new Alpaca API using the specified apiVersion

Parameters:

apiVersion - the api version

AlpacaAPI

public AlpacaAPI(java.lang.String apiVersion,
                 java.lang.String keyId,
                 java.lang.String secret)

Instantiates a new Alpaca API using the specified apiVersion, keyId, and secret.

Parameters:

keyId - the key id

secret - the secret

AlpacaAPI

public AlpacaAPI(java.lang.String apiVersion,
                 java.lang.String keyId,
                 java.lang.String secret,
                 java.lang.String baseAPIURL)

Instantiates a new Alpaca API using the specified apiVersion, keyId, secret, and baseAPIURL.

Parameters:

apiVersion - the api version

keyId - the key id

secret - the secret

baseAPIURL - the api account url

AlpacaAPI

public AlpacaAPI(java.lang.String apiVersion,
                 java.lang.String keyId,
                 java.lang.String secret,
                 java.lang.String baseAPIURL,
                 java.lang.String baseDataUrl)

Instantiates a new Alpaca API using the specified keyId, secret, baseAPIURL, and baseDataUrl.

Parameters:

apiVersion - the api version

keyId - the key id

secret - the secret

baseAPIURL - the base api url

baseDataUrl - the base data url

Method Detail

getAccount

public Account getAccount()
                   throws AlpacaAPIRequestException

Returns the account associated with the API key.

Returns:

the account

Throws:

AlpacaAPIRequestException - the alpaca API exception

See Also:

Get the Account

getAccountActivities

public java.util.ArrayList<AccountActivity> getAccountActivities(java.time.ZonedDateTime date,
                                                                 java.time.ZonedDateTime until,
                                                                 java.time.ZonedDateTime after,
                                                                 Direction direction,
                                                                 java.lang.Integer pageSize,
                                                                 java.lang.String pageToken,
                                                                 ActivityType... activityTypes)
                                                          throws AlpacaAPIRequestException

Returns account activity 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.)

direction - asc or desc (default desc if unspecified.)

pageSize - The maximum number of entries to return in the response. (See the section on paging above.)

pageToken - The ID of the end of your current page of results. (See the section on paging above.)

activityTypes - the activity types (null for all activities)

Returns:

the account activities

Throws:

AlpacaAPIRequestException - the alpaca api exception

See Also:

Gets the Account Activities

getAccountConfiguration

public AccountConfiguration getAccountConfiguration()
                                             throws AlpacaAPIRequestException

Returns the current account configuration values.

Returns:

the account configurations

Throws:

AlpacaAPIRequestException - the alpaca api exception

See Also:

Account Configuration

setAccountConfiguration

public AccountConfiguration setAccountConfiguration(AccountConfiguration accountConfiguration)
                                             throws AlpacaAPIRequestException

Sets account configuration.

Parameters:

accountConfiguration - the account configuration

Returns:

the updated account configuration

Throws:

AlpacaAPIRequestException - the alpaca api exception

See Also:

Account Configuration

getOrders

public java.util.ArrayList<Order> getOrders(OrderStatus status,
                                            java.lang.Integer limit,
                                            java.time.ZonedDateTime after,
                                            java.time.ZonedDateTime until,
                                            Direction direction,
                                            java.lang.Boolean nested)
                                     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.)

direction - 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.

Returns:

the orders

Throws:

AlpacaAPIRequestException - the alpaca API exception

See Also:

Orders

requestNewOrder

public Order requestNewOrder(java.lang.String symbol,
                             java.lang.Integer quantity,
                             OrderSide side,
                             OrderType type,
                             OrderTimeInForce timeInForce,
                             java.lang.Double limitPrice,
                             java.lang.Double stopPrice,
                             java.lang.Boolean extendedHours,
                             java.lang.String clientOrderId,
                             OrderClass orderClass,
                             java.lang.Double takeProfitLimitPrice,
                             java.lang.Double stopLossStopPrice,
                             java.lang.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

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

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 - the alpaca API exception

See Also:

Orders

requestNewMarketOrder

public Order requestNewMarketOrder(java.lang.String symbol,
                                   java.lang.Integer quantity,
                                   OrderSide side,
                                   OrderTimeInForce timeInForce,
                                   java.lang.Boolean extendedHours)
                            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, Integer, OrderSide, OrderType, OrderTimeInForce, 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.

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 - the alpaca api request exception

See Also:

Order Types

requestNewLimitOrder

public Order requestNewLimitOrder(java.lang.String symbol,
                                  java.lang.Integer quantity,
                                  OrderSide side,
                                  OrderTimeInForce timeInForce,
                                  java.lang.Double limitPrice,
                                  java.lang.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, Integer, OrderSide, OrderType, OrderTimeInForce, 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 - the alpaca api request exception

See Also:

Order Types

requestNewStopOrder

public Order requestNewStopOrder(java.lang.String symbol,
                                 java.lang.Integer quantity,
                                 OrderSide side,
                                 OrderTimeInForce timeInForce,
                                 java.lang.Double stopPrice,
                                 java.lang.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, Integer, OrderSide, OrderType, OrderTimeInForce, 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 - the alpaca api request exception

See Also:

Order Types

requestNewStopLimitOrder

public Order requestNewStopLimitOrder(java.lang.String symbol,
                                      java.lang.Integer quantity,
                                      OrderSide side,
                                      OrderTimeInForce timeInForce,
                                      java.lang.Double limitPrice,
                                      java.lang.Double stopPrice,
                                      java.lang.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, Integer, OrderSide, OrderType, OrderTimeInForce, 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 - the alpaca api request exception

See Also:

Order Types

requestNewMarketBracketOrder

public Order requestNewMarketBracketOrder(java.lang.String symbol,
                                          java.lang.Integer quantity,
                                          OrderSide side,
                                          OrderTimeInForce timeInForce,
                                          java.lang.Boolean extendedHours,
                                          java.lang.Double takeProfitLimitPrice,
                                          java.lang.Double stopLossStopPrice,
                                          java.lang.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, Integer, OrderSide, OrderType, OrderTimeInForce, 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.

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 - the alpaca api request exception

See Also:

Order Types

requestNewLimitBracketOrder

public Order requestNewLimitBracketOrder(java.lang.String symbol,
                                         java.lang.Integer quantity,
                                         OrderSide side,
                                         OrderTimeInForce timeInForce,
                                         java.lang.Double limitPrice,
                                         java.lang.Boolean extendedHours,
                                         java.lang.Double takeProfitLimitPrice,
                                         java.lang.Double stopLossStopPrice,
                                         java.lang.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, Integer, OrderSide, OrderType, OrderTimeInForce, 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 - the alpaca api request exception

See Also:

Order Types

requestNewOCOOrder

public Order requestNewOCOOrder(java.lang.String symbol,
                                java.lang.Integer quantity,
                                OrderSide side,
                                OrderTimeInForce timeInForce,
                                java.lang.Boolean extendedHours,
                                java.lang.Double takeProfitLimitPrice,
                                java.lang.Double stopLossStopPrice,
                                java.lang.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, Integer, OrderSide, OrderType, OrderTimeInForce, 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 - the alpaca api request exception

See Also:

Order Types

requestNewOTOMarketOrder

public Order requestNewOTOMarketOrder(java.lang.String symbol,
                                      java.lang.Integer quantity,
                                      OrderSide side,
                                      OrderTimeInForce timeInForce,
                                      java.lang.Boolean extendedHours,
                                      java.lang.Double takeProfitLimitPrice,
                                      java.lang.Double stopLossStopPrice,
                                      java.lang.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, Integer, OrderSide, OrderType, OrderTimeInForce, 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.

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 - the alpaca api request exception

See Also:

Order Types

requestNewOTOLimitOrder

public Order requestNewOTOLimitOrder(java.lang.String symbol,
                                     java.lang.Integer quantity,
                                     OrderSide side,
                                     OrderTimeInForce timeInForce,
                                     java.lang.Double limitPrice,
                                     java.lang.Boolean extendedHours,
                                     java.lang.Double takeProfitLimitPrice,
                                     java.lang.Double stopLossStopPrice,
                                     java.lang.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, Integer, OrderSide, OrderType, OrderTimeInForce, 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 - the alpaca api request exception

See Also:

Order Types

requestNewOTOStopOrder

public Order requestNewOTOStopOrder(java.lang.String symbol,
                                    java.lang.Integer quantity,
                                    OrderSide side,
                                    OrderTimeInForce timeInForce,
                                    java.lang.Double stopPrice,
                                    java.lang.Boolean extendedHours,
                                    java.lang.Double takeProfitLimitPrice,
                                    java.lang.Double stopLossStopPrice,
                                    java.lang.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, Integer, OrderSide, OrderType, OrderTimeInForce, 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 - the alpaca api request exception

See Also:

Order Types

requestNewOTOStopLimitOrder

public Order requestNewOTOStopLimitOrder(java.lang.String symbol,
                                         java.lang.Integer quantity,
                                         OrderSide side,
                                         OrderTimeInForce timeInForce,
                                         java.lang.Double limitPrice,
                                         java.lang.Double stopPrice,
                                         java.lang.Boolean extendedHours,
                                         java.lang.Double takeProfitLimitPrice,
                                         java.lang.Double stopLossStopPrice,
                                         java.lang.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, Integer, OrderSide, OrderType, OrderTimeInForce, 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 - the alpaca api request exception

See Also:

Order Types

getOrder

public Order getOrder(java.lang.String orderID,
                      java.lang.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 - the alpaca API exception

See Also:

Orders

getOrderByClientID

public Order getOrderByClientID(java.lang.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 - the alpaca API exception

See Also:

Orders

replaceOrder

public Order replaceOrder(java.lang.String orderID,
                          java.lang.Integer quantity,
                          OrderTimeInForce timeInForce,
                          java.lang.Double limitPrice,
                          java.lang.Double stopPrice,
                          java.lang.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

clientOrderId - A unique identifier for the order. Automatically generated if not sent.

Returns:

the order

Throws:

AlpacaAPIRequestException - the alpaca api request exception

See Also:

Orders

cancelAllOrders

public java.util.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 - the alpaca api request exception

See Also:

Orders

cancelOrder

public boolean cancelOrder(java.lang.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 - the alpaca API exception

See Also:

Orders

getOpenPositions

public java.util.ArrayList<Position> getOpenPositions()
                                               throws AlpacaAPIRequestException

Gets the open positions.

Returns:

the open positions

Throws:

AlpacaAPIRequestException - the alpaca API exception

See Also:

Positions

getOpenPositionBySymbol

public Position getOpenPositionBySymbol(java.lang.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 - the alpaca API exception

See Also:

Positions

closeAllPositions

public java.util.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 - the alpaca API exception

See Also:

Positions

closePosition

public Order closePosition(java.lang.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 - the alpaca API exception

See Also:

Positions

getAssets

public java.util.ArrayList<Asset> getAssets(AssetStatus assetStatus,
                                            java.lang.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 - the alpaca API exception

See Also:

Assets

getAssetBySymbol

public Asset getAssetBySymbol(java.lang.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 - the alpaca API exception

See Also:

Assets

getWatchlists

public java.util.ArrayList<Watchlist> getWatchlists()
                                             throws AlpacaAPIRequestException

Returns the list of watchlists registered under the account.

Returns:

the watch lists

Throws:

AlpacaAPIRequestException - the alpaca api exception

See Also:

Watchlists

createWatchlist

public Watchlist createWatchlist(java.lang.String name,
                                 java.lang.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 - the alpaca api exception

See Also:

Watchlists

getWatchlist

public Watchlist getWatchlist(java.lang.String watchlistID)
                       throws AlpacaAPIRequestException

Returns a watchlist identified by the ID.

Parameters:

watchlistID - Watchlist ID

Returns:

the watchlist

Throws:

AlpacaAPIRequestException - the alpaca api exception

See Also:

Watchlists

updateWatchlist

public Watchlist updateWatchlist(java.lang.String watchlistID,
                                 java.lang.String name,
                                 java.lang.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 - the alpaca api exception

See Also:

Watchlists

addWatchlistAsset

public Watchlist addWatchlistAsset(java.lang.String watchlistID,
                                   java.lang.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 - the alpaca api exception

See Also:

Watchlists

deleteWatchlist

public boolean deleteWatchlist(java.lang.String watchlistID)
                        throws AlpacaAPIRequestException

Delete a watchlist. This is a permanent deletion.

Parameters:

watchlistID - Watchlist ID

Returns:

if the watchlist was deleted

Throws:

AlpacaAPIRequestException - the alpaca api exception

See Also:

Watchlists

removeSymbolFromWatchlist

public Watchlist removeSymbolFromWatchlist(java.lang.String watchlistID,
                                           java.lang.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 - the alpaca api exception

See Also:

Watchlists

getPortfolioHistory

public PortfolioHistory getPortfolioHistory(java.lang.Integer periodLength,
                                            PortfolioPeriodUnit periodUnit,
                                            PortfolioTimeFrame timeFrame,
                                            java.time.LocalDate dateEnd,
                                            java.lang.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 - the alpaca api request exception

getCalendar

public java.util.ArrayList<Calendar> getCalendar()
                                          throws AlpacaAPIRequestException

Returns the market calendar.

Returns:

the calendar

Throws:

AlpacaAPIRequestException - the alpaca API exception

See Also:

Calendar

getCalendar

public java.util.ArrayList<Calendar> getCalendar(java.time.LocalDate start,
                                                 java.time.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

Throws:

AlpacaAPIRequestException - the alpaca API exception

See Also:

Calendar

getClock

public Clock getClock()
               throws AlpacaAPIRequestException

Returns the market clock.

Returns:

the clock

Throws:

AlpacaAPIRequestException - the alpaca API exception

See Also:

Clock

getBars

public java.util.Map<java.lang.String,java.util.ArrayList<Bar>> getBars(BarsTimeFrame timeframe,
                                                                        java.lang.String symbol,
                                                                        java.lang.Integer limit,
                                                                        java.time.ZonedDateTime start,
                                                                        java.time.ZonedDateTime end,
                                                                        java.time.ZonedDateTime after,
                                                                        java.time.ZonedDateTime until)
                                                                 throws AlpacaAPIRequestException

Retrieves a list of bars for each requested symbol. It is guaranteed all bars are in ascending order by time.

Currently, no “incomplete” bars are returned. For example, a 1 minute bar for 09:30 will not be returned until 09:31.

Parameters:

timeframe - One of minute, 1Min, 5Min, 15Min, day or 1D. minute is an alias of 1Min. Similarly, day is of 1D.

symbol - One symbol name.

limit - The maximum number of bars to be returned for each symbol. It can be between 1 and 1000. Default is 100 if parameter is unspecified or 0.

start - Filter bars equal to or after this time. Cannot be used with after.

end - Filter bars equal to or before this time. Cannot be used with until.

after - Filter bars after this time. Cannot be used with start.

until - Filter bars before this time. Cannot be used with end.

Returns:

the bars

Throws:

AlpacaAPIRequestException - the alpaca API exception

See Also:

Bars

getBars

public java.util.Map<java.lang.String,java.util.ArrayList<Bar>> getBars(BarsTimeFrame timeframe,
                                                                        java.lang.String[] symbols,
                                                                        java.lang.Integer limit,
                                                                        java.time.ZonedDateTime start,
                                                                        java.time.ZonedDateTime end,
                                                                        java.time.ZonedDateTime after,
                                                                        java.time.ZonedDateTime until)
                                                                 throws AlpacaAPIRequestException

Retrieves a list of bars for each requested symbol. It is guaranteed all bars are in ascending order by time.

Currently, no “incomplete” bars are returned. For example, a 1 minute bar for 09:30 will not be returned until 09:31.

Parameters:

timeframe - One of minute, 1Min, 5Min, 15Min, day or 1D. minute is an alias of 1Min. Similarly, day is of 1D.

symbols - One or more (max 200) symbol names split by commas (“,”).

limit - The maximum number of bars to be returned for each symbol. It can be between 1 and 1000. Default is 100 if parameter is unspecified or 0.

start - Filter bars equal to or after this time. Cannot be used with after.

end - Filter bars equal to or before this time. Cannot be used with until.

after - Filter bars after this time. Cannot be used with start.

until - Filter bars before this time. Cannot be used with end.

Returns:

the bars

Throws:

AlpacaAPIRequestException - the alpaca API exception

See Also:

Bars

addAlpacaStreamListener

public void addAlpacaStreamListener(AlpacaStreamListener streamListener)

Adds the alpaca stream listener.

Parameters:

streamListener - the stream listener

removeAlpacaStreamListener

public void removeAlpacaStreamListener(AlpacaStreamListener streamListener)

Removes the alpaca stream listener.

Parameters:

streamListener - the stream listener

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object