net.jacobpeterson.alpaca.AlpacaAPI Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of alpaca-java Show documentation
Show all versions of alpaca-java Show documentation
Java API for Alpaca and Polygon
package net.jacobpeterson.alpaca;
import com.google.common.base.Preconditions;
import com.google.gson.JsonArray;
import com.google.gson.JsonElement;
import com.google.gson.JsonObject;
import com.google.gson.JsonPrimitive;
import com.google.gson.reflect.TypeToken;
import com.mashape.unirest.http.HttpResponse;
import net.jacobpeterson.alpaca.enums.ActivityType;
import net.jacobpeterson.alpaca.enums.AssetStatus;
import net.jacobpeterson.alpaca.enums.BarsTimeFrame;
import net.jacobpeterson.alpaca.enums.Direction;
import net.jacobpeterson.alpaca.enums.OrderClass;
import net.jacobpeterson.alpaca.enums.OrderSide;
import net.jacobpeterson.alpaca.enums.OrderStatus;
import net.jacobpeterson.alpaca.enums.OrderTimeInForce;
import net.jacobpeterson.alpaca.enums.OrderType;
import net.jacobpeterson.alpaca.enums.PortfolioPeriodUnit;
import net.jacobpeterson.alpaca.enums.PortfolioTimeFrame;
import net.jacobpeterson.alpaca.properties.AlpacaProperties;
import net.jacobpeterson.alpaca.rest.AlpacaRequest;
import net.jacobpeterson.alpaca.rest.AlpacaRequestBuilder;
import net.jacobpeterson.alpaca.rest.exception.AlpacaAPIRequestException;
import net.jacobpeterson.alpaca.websocket.client.AlpacaWebsocketClient;
import net.jacobpeterson.alpaca.websocket.listener.AlpacaStreamListener;
import net.jacobpeterson.domain.alpaca.account.Account;
import net.jacobpeterson.domain.alpaca.accountactivities.AccountActivity;
import net.jacobpeterson.domain.alpaca.accountactivities.NonTradeActivity;
import net.jacobpeterson.domain.alpaca.accountactivities.TradeActivity;
import net.jacobpeterson.domain.alpaca.accountconfiguration.AccountConfiguration;
import net.jacobpeterson.domain.alpaca.asset.Asset;
import net.jacobpeterson.domain.alpaca.bar.Bar;
import net.jacobpeterson.domain.alpaca.calendar.Calendar;
import net.jacobpeterson.domain.alpaca.clock.Clock;
import net.jacobpeterson.domain.alpaca.order.CancelledOrder;
import net.jacobpeterson.domain.alpaca.order.Order;
import net.jacobpeterson.domain.alpaca.portfoliohistory.PortfolioHistory;
import net.jacobpeterson.domain.alpaca.position.ClosePositionOrder;
import net.jacobpeterson.domain.alpaca.position.Position;
import net.jacobpeterson.domain.alpaca.watchlist.Watchlist;
import net.jacobpeterson.util.gson.GsonUtil;
import net.jacobpeterson.util.time.TimeUtil;
import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.Logger;
import java.io.InputStream;
import java.lang.reflect.Type;
import java.time.LocalDate;
import java.time.ZonedDateTime;
import java.time.format.DateTimeFormatter;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.util.StringJoiner;
import java.util.stream.Collectors;
/**
* The Class AlpacaAPI.
*/
public class AlpacaAPI {
/** The logger. */
private static Logger LOGGER = LogManager.getLogger(AlpacaAPI.class);
/** The version. */
private final String apiVersion;
/** The key id. */
private final String keyId;
/** The base API url. */
private final String baseAPIURL;
/** The alpaca request. */
private final AlpacaRequest alpacaRequest;
/** The base data url. */
private final String baseDataUrl;
/** The alpaca web socket client. */
private final AlpacaWebsocketClient alpacaWebSocketClient;
/**
* Instantiates a new Alpaca API using properties specified in alpaca.properties file (or relevant defaults)
*/
public AlpacaAPI() {
this(AlpacaProperties.API_VERSION_VALUE, AlpacaProperties.KEY_ID_VALUE,
AlpacaProperties.SECRET_VALUE, AlpacaProperties.BASE_API_URL_VALUE,
AlpacaProperties.BASE_DATA_URL_VALUE);
LOGGER.debug(AlpacaProperties.staticToString());
}
/**
* Instantiates a new Alpaca API using the specified apiVersion
*
* @param apiVersion the api version
*/
public AlpacaAPI(String apiVersion) {
this(apiVersion, AlpacaProperties.KEY_ID_VALUE, AlpacaProperties.SECRET_VALUE,
AlpacaProperties.BASE_API_URL_VALUE, AlpacaProperties.BASE_DATA_URL_VALUE);
}
/**
* Instantiates a new Alpaca API using the specified apiVersion, keyId, and secret.
*
* @param keyId the key id
* @param secret the secret
*/
public AlpacaAPI(String apiVersion, String keyId, String secret) {
this(apiVersion, keyId, secret, AlpacaProperties.BASE_API_URL_VALUE,
AlpacaProperties.BASE_DATA_URL_VALUE);
}
/**
* Instantiates a new Alpaca API using the specified apiVersion, keyId, secret, and baseAPIURL.
*
* @param apiVersion the api version
* @param keyId the key id
* @param secret the secret
* @param baseAPIURL the api account url
*/
public AlpacaAPI(String apiVersion, String keyId, String secret, String baseAPIURL) {
this(apiVersion, keyId, secret, baseAPIURL, AlpacaProperties.BASE_DATA_URL_VALUE);
}
/**
* Instantiates a new Alpaca API using the specified keyId, secret, baseAPIURL, and baseDataUrl.
*
* @param apiVersion the api version
* @param keyId the key id
* @param secret the secret
* @param baseAPIURL the base api url
* @param baseDataUrl the base data url
*/
public AlpacaAPI(String apiVersion, String keyId, String secret, String baseAPIURL, String baseDataUrl) {
this.apiVersion = apiVersion;
this.keyId = keyId;
this.baseAPIURL = baseAPIURL;
this.baseDataUrl = baseDataUrl;
alpacaRequest = new AlpacaRequest(keyId, secret);
alpacaWebSocketClient = new AlpacaWebsocketClient(keyId, secret, baseAPIURL);
LOGGER.debug(this.toString());
}
/**
* Returns the account associated with the API key.
*
* @return the account
*
* @throws AlpacaAPIRequestException the alpaca API exception
* @see Get the Account
*/
public Account getAccount() throws AlpacaAPIRequestException {
AlpacaRequestBuilder urlBuilder = new AlpacaRequestBuilder(baseAPIURL, apiVersion,
AlpacaConstants.ACCOUNT_ENDPOINT);
HttpResponse response = alpacaRequest.invokeGet(urlBuilder);
if (response.getStatus() != 200) {
throw new AlpacaAPIRequestException(response);
}
return alpacaRequest.getResponseObject(response, Account.class);
}
/**
* Returns account activity entries for many or for a specific type of activity.
*
* @param date The date for which you want to see activities.
* @param until The response will contain only activities submitted before this date. (Cannot be used with
* date.)
* @param after The response will contain only activities submitted after this date. (Cannot be used with
* date.)
* @param direction asc or desc (default desc if unspecified.)
* @param pageSize The maximum number of entries to return in the response. (See the section on paging above.)
* @param pageToken The ID of the end of your current page of results. (See the section on paging above.)
* @param activityTypes the activity types (null for all activities)
*
* @return the account activities
*
* @throws AlpacaAPIRequestException the alpaca api exception
* @see Gets the Account
* Activities
*/
public ArrayList getAccountActivities(ZonedDateTime date, ZonedDateTime until, ZonedDateTime after,
Direction direction, Integer pageSize, String pageToken, ActivityType... activityTypes)
throws AlpacaAPIRequestException {
AlpacaRequestBuilder urlBuilder = new AlpacaRequestBuilder(baseAPIURL, AlpacaConstants.VERSION_2_ENDPOINT,
AlpacaConstants.ACCOUNT_ENDPOINT,
AlpacaConstants.ACTIVITIES_ENDPOINT);
if (activityTypes != null) { // Check if we don't want all activity types
if (activityTypes.length == 1) { // Get one activity
urlBuilder.appendEndpoint(activityTypes[0].getAPIName());
} else { // Get list of activities
urlBuilder.appendURLParameter("activity_types", Arrays.stream(activityTypes)
.map(ActivityType::getAPIName).collect(Collectors.joining(","))); // Makes comma-separated list
}
}
if (date != null) {
urlBuilder.appendURLParameter(AlpacaConstants.DATE_PARAMETER,
date.format(DateTimeFormatter.ISO_OFFSET_DATE_TIME));
}
if (until != null) {
urlBuilder.appendURLParameter(AlpacaConstants.UNTIL_PARAMETER,
until.format(DateTimeFormatter.ISO_OFFSET_DATE_TIME));
}
if (after != null) {
urlBuilder.appendURLParameter(AlpacaConstants.AFTER_PARAMETER,
after.format(DateTimeFormatter.ISO_OFFSET_DATE_TIME));
}
if (direction != null) {
urlBuilder.appendURLParameter(AlpacaConstants.DIRECTION_PARAMETER, direction.getAPIName());
}
if (pageSize != null) {
urlBuilder.appendURLParameter(AlpacaConstants.PAGE_SIZE_PARAMETER, pageSize.toString());
}
if (pageToken != null) {
urlBuilder.appendURLParameter(AlpacaConstants.PAGE_TOKEN_PARAMETER, pageToken);
}
HttpResponse response = alpacaRequest.invokeGet(urlBuilder);
if (response.getStatus() != 200) {
throw new AlpacaAPIRequestException(response);
}
JsonElement responseJsonElement = alpacaRequest.getResponseJSON(response);
ArrayList accountActivities = new ArrayList<>();
if (responseJsonElement instanceof JsonArray) {
JsonArray responseJsonArray = (JsonArray) responseJsonElement;
for (JsonElement arrayJsonElement : responseJsonArray) { // Loop through response array
if (arrayJsonElement instanceof JsonObject) {
JsonObject arrayJsonObject = (JsonObject) arrayJsonElement;
if (GsonUtil.doesGsonPOJOMatch(TradeActivity.class, arrayJsonObject)) {
accountActivities.add(GsonUtil.GSON.fromJson(arrayJsonObject, TradeActivity.class));
} else if (GsonUtil.doesGsonPOJOMatch(NonTradeActivity.class, arrayJsonObject)) {
accountActivities.add(GsonUtil.GSON.fromJson(arrayJsonObject, NonTradeActivity.class));
} else {
LOGGER.warn("Received unknown JSON Object in response!");
}
} else {
throw new IllegalStateException("All array elements must be objects!");
}
}
return accountActivities;
} else {
throw new IllegalStateException("The response must be an array!");
}
}
/**
* Returns the current account configuration values.
*
* @return the account configurations
*
* @throws AlpacaAPIRequestException the alpaca api exception
* @see Account
* Configuration
*/
public AccountConfiguration getAccountConfiguration() throws AlpacaAPIRequestException {
AlpacaRequestBuilder urlBuilder = new AlpacaRequestBuilder(baseAPIURL, apiVersion,
AlpacaConstants.ACCOUNT_ENDPOINT,
AlpacaConstants.CONFIGURATIONS_ENDPOINT);
HttpResponse response = alpacaRequest.invokeGet(urlBuilder);
if (response.getStatus() != 200) {
throw new AlpacaAPIRequestException(response);
}
return alpacaRequest.getResponseObject(response, AccountConfiguration.class);
}
/**
* Sets account configuration.
*
* @param accountConfiguration the account configuration
*
* @return the updated account configuration
*
* @throws AlpacaAPIRequestException the alpaca api exception
* @see Account
* Configuration
*/
public AccountConfiguration setAccountConfiguration(AccountConfiguration accountConfiguration)
throws AlpacaAPIRequestException {
Preconditions.checkNotNull(accountConfiguration);
AlpacaRequestBuilder urlBuilder = new AlpacaRequestBuilder(baseAPIURL, apiVersion,
AlpacaConstants.ACCOUNT_ENDPOINT,
AlpacaConstants.CONFIGURATIONS_ENDPOINT);
urlBuilder.setCustomBody(GsonUtil.GSON.toJson(accountConfiguration));
HttpResponse response = alpacaRequest.invokePatch(urlBuilder);
if (response.getStatus() != 200) {
throw new AlpacaAPIRequestException(response);
}
return alpacaRequest.getResponseObject(response, AccountConfiguration.class);
}
/**
* Retrieves a list of orders for the account, filtered by the supplied query parameters.
*
* @param status Order status to be queried. open, closed or all. Defaults to open.
* @param limit The maximum number of orders in response. Defaults to 50 and max is 500.
* @param after The response will include only ones submitted after this timestamp (exclusive.)
* @param until The response will include only ones submitted until this timestamp (exclusive.)
* @param direction The chronological order of response based on the submission time. asc or desc. Defaults to
* desc.
* @param nested If true, the result will roll up multi-leg orders under the legs field of primary order.
*
* @return the orders
*
* @throws AlpacaAPIRequestException the alpaca API exception
* @see Orders
*/
public ArrayList getOrders(OrderStatus status, Integer limit, ZonedDateTime after, ZonedDateTime until,
Direction direction, Boolean nested) throws AlpacaAPIRequestException {
AlpacaRequestBuilder urlBuilder = new AlpacaRequestBuilder(baseAPIURL, apiVersion,
AlpacaConstants.ORDERS_ENDPOINT);
if (status != null) {
urlBuilder.appendURLParameter(AlpacaConstants.STATUS_PARAMETER, status.getAPIName());
}
if (limit != null) {
urlBuilder.appendURLParameter(AlpacaConstants.LIMIT_PARAMETER, limit.toString());
}
if (after != null) {
urlBuilder.appendURLParameter(AlpacaConstants.AFTER_PARAMETER,
after.format(DateTimeFormatter.ISO_OFFSET_DATE_TIME));
}
if (until != null) {
urlBuilder.appendURLParameter(AlpacaConstants.UNTIL_PARAMETER,
until.format(DateTimeFormatter.ISO_OFFSET_DATE_TIME));
}
if (direction != null) {
urlBuilder.appendURLParameter(AlpacaConstants.DIRECTION_PARAMETER, direction.getAPIName());
}
if (nested != null) {
urlBuilder.appendURLParameter(AlpacaConstants.NESTED_PARAMETER, nested.toString());
}
HttpResponse response = alpacaRequest.invokeGet(urlBuilder);
if (response.getStatus() != 200) {
throw new AlpacaAPIRequestException(response);
}
Type arrayListType = new TypeToken>() {}.getType();
return alpacaRequest.getResponseObject(response, arrayListType);
}
/**
* 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.
*
* @param symbol symbol or asset ID to identify the asset to trade
* @param quantity number of shares to trade
* @param side buy or sell
* @param type market, limit, stop, or stop_limit
* @param timeInForce day, gtc, opg, cls, ioc, fok. Please see Understand Orders for more info.
* @param limitPrice required if type is limit or stop_limit
* @param stopPrice required if type is stop or stop_limit
* @param extendedHours (default) false. If true, order will be eligible to execute in premarket/afterhours.
* Only works with type limit and time_in_force day.
* @param clientOrderId A unique identifier for the order. Automatically generated if not sent.
* @param orderClass Simple, bracket, oco, or oto. For details of non-simple order classes, please see
* Bracket Order Overview on the Alpaca Docs.
* @param takeProfitLimitPrice Additional parameter for take-profit leg of advanced orders. Required for bracket
* orders.
* @param stopLossStopPrice Additional parameters for stop-loss leg of advanced orders. Required for bracket
* orders.
* @param stopLossLimitPrice Additional parameters for stop-loss leg of advanced orders. The stop-loss order
* becomes a stop-limit order if specified.
*
* @return the order
*
* @throws AlpacaAPIRequestException the alpaca API exception
* @see Orders
*/
public Order requestNewOrder(String symbol, Integer quantity, OrderSide side, OrderType type,
OrderTimeInForce timeInForce, Double limitPrice, Double stopPrice, Boolean extendedHours,
String clientOrderId, OrderClass orderClass, Double takeProfitLimitPrice, Double stopLossStopPrice,
Double stopLossLimitPrice)
throws AlpacaAPIRequestException {
Preconditions.checkNotNull(symbol);
Preconditions.checkNotNull(quantity);
Preconditions.checkNotNull(side);
Preconditions.checkNotNull(type);
Preconditions.checkNotNull(timeInForce);
AlpacaRequestBuilder urlBuilder = new AlpacaRequestBuilder(baseAPIURL, apiVersion,
AlpacaConstants.ORDERS_ENDPOINT);
urlBuilder.appendJSONBodyProperty(AlpacaConstants.SYMBOL_PARAMETER, symbol);
urlBuilder.appendJSONBodyProperty(AlpacaConstants.QTY_PARAMETER, quantity.toString());
urlBuilder.appendJSONBodyProperty(AlpacaConstants.SIDE_PARAMETER, side.getAPIName());
urlBuilder.appendJSONBodyProperty(AlpacaConstants.TYPE_PARAMETER, type.getAPIName());
urlBuilder.appendJSONBodyProperty(AlpacaConstants.TIME_IN_FORCE_PARAMETER, timeInForce.getAPIName());
if (limitPrice != null) {
urlBuilder.appendJSONBodyProperty(AlpacaConstants.LIMIT_PRICE_PARAMETER,
TimeUtil.toDecimalFormat(limitPrice));
}
if (stopPrice != null) {
urlBuilder.appendJSONBodyProperty(AlpacaConstants.STOP_PRICE_PARAMETER,
TimeUtil.toDecimalFormat(stopPrice));
}
if (extendedHours != null) {
urlBuilder.appendJSONBodyJSONProperty(AlpacaConstants.EXTENDED_HOURS_PARAMETER,
new JsonPrimitive(extendedHours));
}
if (clientOrderId != null) {
urlBuilder.appendJSONBodyProperty(AlpacaConstants.CLIENT_ORDER_ID_PARAMETER, clientOrderId);
}
if (orderClass != null) {
urlBuilder.appendJSONBodyProperty(AlpacaConstants.ORDER_CLASS_PARAMETER, orderClass.getAPIName());
}
if (takeProfitLimitPrice != null) {
JsonObject takeProfit = new JsonObject();
takeProfit.addProperty(AlpacaConstants.LIMIT_PRICE_PARAMETER, takeProfitLimitPrice);
urlBuilder.appendJSONBodyJSONProperty(AlpacaConstants.TAKE_PROFIT_PARAMETER, takeProfit);
}
if (stopLossStopPrice != null || stopLossLimitPrice != null) {
JsonObject stopLoss = new JsonObject();
if (stopLossStopPrice != null) {
stopLoss.addProperty(AlpacaConstants.STOP_PRICE_PARAMETER, stopLossStopPrice);
}
if (stopLossLimitPrice != null) {
stopLoss.addProperty(AlpacaConstants.LIMIT_PRICE_PARAMETER, stopLossLimitPrice);
}
urlBuilder.appendJSONBodyJSONProperty(AlpacaConstants.STOP_LOSS_PARAMETER, stopLoss);
}
HttpResponse response = alpacaRequest.invokePost(urlBuilder);
if (response.getStatus() != 200) {
throw new AlpacaAPIRequestException(response);
}
return alpacaRequest.getResponseObject(response, Order.class);
}
/**
* 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 {@link
* #requestNewOrder(String, Integer, OrderSide, OrderType, OrderTimeInForce, Double, Double, Boolean, String,
* OrderClass, Double, Double, Double)} with {@link OrderType#MARKET}.
*
* @param symbol symbol or asset ID to identify the asset to trade
* @param quantity number of shares to trade
* @param side buy or sell
* @param timeInForce day, gtc, opg, cls, ioc, fok. Please see Understand Orders for more info.
* @param extendedHours (default) false. If true, order will be eligible to execute in premarket/afterhours. Only
* works with type limit and time_in_force day.
*
* @return the order
*
* @throws AlpacaAPIRequestException the alpaca api request exception
* @see Order Types
*/
public Order requestNewMarketOrder(String symbol, Integer quantity, OrderSide side, OrderTimeInForce timeInForce,
Boolean extendedHours) throws AlpacaAPIRequestException {
return requestNewOrder(symbol, quantity, side, OrderType.MARKET, timeInForce, null, null, extendedHours,
null, OrderClass.SIMPLE, null, null, null);
}
/**
* 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 {@link #requestNewOrder(String, Integer,
* OrderSide, OrderType, OrderTimeInForce, Double, Double, Boolean, String, OrderClass, Double, Double, Double)}
* with {@link OrderType#LIMIT}.
*
* @param symbol symbol or asset ID to identify the asset to trade
* @param quantity number of shares to trade
* @param side buy or sell
* @param timeInForce day, gtc, opg, cls, ioc, fok. Please see Understand Orders for more info.
* @param limitPrice required if type is limit or stop_limit
* @param extendedHours (default) false. If true, order will be eligible to execute in premarket/afterhours. Only
* works with type limit and time_in_force day.
*
* @return the order
*
* @throws AlpacaAPIRequestException the alpaca api request exception
* @see Order Types
*/
public Order requestNewLimitOrder(String symbol, Integer quantity, OrderSide side, OrderTimeInForce timeInForce,
Double limitPrice, Boolean extendedHours) throws AlpacaAPIRequestException {
return requestNewOrder(symbol, quantity, side, OrderType.LIMIT, timeInForce, limitPrice, null, extendedHours,
null, OrderClass.SIMPLE, null, null, null);
}
/**
* 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 {@link
* #requestNewOrder(String, Integer, OrderSide, OrderType, OrderTimeInForce, Double, Double, Boolean, String,
* OrderClass, Double, Double, Double)} with {@link OrderType#STOP}.
*
* @param symbol symbol or asset ID to identify the asset to trade
* @param quantity number of shares to trade
* @param side buy or sell
* @param timeInForce day, gtc, opg, cls, ioc, fok. Please see Understand Orders for more info.
* @param stopPrice required if type is stop or stop_limit
* @param extendedHours (default) false. If true, order will be eligible to execute in premarket/afterhours. Only
* works with type limit and time_in_force day.
*
* @return the order
*
* @throws AlpacaAPIRequestException the alpaca api request exception
* @see Order Types
*/
public Order requestNewStopOrder(String symbol, Integer quantity, OrderSide side, OrderTimeInForce timeInForce,
Double stopPrice, Boolean extendedHours) throws AlpacaAPIRequestException {
return requestNewOrder(symbol, quantity, side, OrderType.STOP, timeInForce, null, stopPrice, extendedHours,
null, OrderClass.SIMPLE, null, null, null);
}
/**
* 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 {@link
* #requestNewOrder(String, Integer, OrderSide, OrderType, OrderTimeInForce, Double, Double, Boolean, String,
* OrderClass, Double, Double, Double)} with {@link OrderType#STOP_LIMIT}.
*
* @param symbol symbol or asset ID to identify the asset to trade
* @param quantity number of shares to trade
* @param side buy or sell
* @param timeInForce day, gtc, opg, cls, ioc, fok. Please see Understand Orders for more info.
* @param limitPrice required if type is limit or stop_limit
* @param stopPrice required if type is stop or stop_limit
* @param extendedHours (default) false. If true, order will be eligible to execute in premarket/afterhours. Only
* works with type limit and time_in_force day.
*
* @return the order
*
* @throws AlpacaAPIRequestException the alpaca api request exception
* @see Order Types
*/
public Order requestNewStopLimitOrder(String symbol, Integer quantity, OrderSide side, OrderTimeInForce timeInForce,
Double limitPrice, Double stopPrice, Boolean extendedHours) throws AlpacaAPIRequestException {
return requestNewOrder(symbol, quantity, side, OrderType.STOP_LIMIT, timeInForce, limitPrice, stopPrice,
extendedHours, null, OrderClass.SIMPLE, null, null, null);
}
/**
* 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 {@link
* #requestNewOrder(String, Integer, OrderSide, OrderType, OrderTimeInForce, Double, Double, Boolean, String,
* OrderClass, Double, Double, Double)} with {@link OrderType#MARKET} and with parameters for a bracket order.
*
* @param symbol symbol or asset ID to identify the asset to trade
* @param quantity number of shares to trade
* @param side buy or sell
* @param timeInForce day, gtc, opg, cls, ioc, fok. Please see Understand Orders for more info.
* @param extendedHours (default) false. If true, order will be eligible to execute in premarket/afterhours.
* Only works with type limit and time_in_force day.
* @param takeProfitLimitPrice Additional parameter for take-profit leg of advanced orders. Required for bracket
* orders.
* @param stopLossStopPrice Additional parameters for stop-loss leg of advanced orders. Required for bracket
* orders.
* @param stopLossLimitPrice Additional parameters for stop-loss leg of advanced orders. The stop-loss order
* becomes a stop-limit order if specified.
*
* @return the order
*
* @throws AlpacaAPIRequestException the alpaca api request exception
* @see Order Types
*/
public Order requestNewMarketBracketOrder(String symbol, Integer quantity, OrderSide side,
OrderTimeInForce timeInForce, Boolean extendedHours, Double takeProfitLimitPrice, Double stopLossStopPrice,
Double stopLossLimitPrice) throws AlpacaAPIRequestException {
return requestNewOrder(symbol, quantity, side, OrderType.MARKET, timeInForce, null, null,
extendedHours, null, OrderClass.BRACKET, takeProfitLimitPrice, stopLossStopPrice, stopLossLimitPrice);
}
/**
* 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 {@link
* #requestNewOrder(String, Integer, OrderSide, OrderType, OrderTimeInForce, Double, Double, Boolean, String,
* OrderClass, Double, Double, Double)} with {@link OrderType#LIMIT} and with parameters for a bracket order.
*
* @param symbol symbol or asset ID to identify the asset to trade
* @param quantity number of shares to trade
* @param side buy or sell
* @param timeInForce day, gtc, opg, cls, ioc, fok. Please see Understand Orders for more info.
* @param limitPrice required if type is limit or stop_limit
* @param extendedHours (default) false. If true, order will be eligible to execute in premarket/afterhours.
* Only works with type limit and time_in_force day.
* @param takeProfitLimitPrice Additional parameter for take-profit leg of advanced orders. Required for bracket
* orders.
* @param stopLossStopPrice Additional parameters for stop-loss leg of advanced orders. Required for bracket
* orders.
* @param stopLossLimitPrice Additional parameters for stop-loss leg of advanced orders. The stop-loss order
* becomes a stop-limit order if specified.
*
* @return the order
*
* @throws AlpacaAPIRequestException the alpaca api request exception
* @see Order Types
*/
public Order requestNewLimitBracketOrder(String symbol, Integer quantity, OrderSide side,
OrderTimeInForce timeInForce, Double limitPrice, Boolean extendedHours, Double takeProfitLimitPrice,
Double stopLossStopPrice, Double stopLossLimitPrice) throws AlpacaAPIRequestException {
return requestNewOrder(symbol, quantity, side, OrderType.LIMIT, timeInForce, limitPrice, null,
extendedHours, null, OrderClass.BRACKET, takeProfitLimitPrice, stopLossStopPrice, stopLossLimitPrice);
}
/**
* 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 {@link #requestNewOrder(String, Integer, OrderSide, OrderType,
* OrderTimeInForce, Double, Double, Boolean, String, OrderClass, Double, Double, Double)} with parameters for an
* OCO order type.
*
* @param symbol symbol or asset ID to identify the asset to trade
* @param quantity number of shares to trade
* @param side buy or sell
* @param timeInForce day, gtc, opg, cls, ioc, fok. Please see Understand Orders for more info.
* @param extendedHours (default) false. If true, order will be eligible to execute in premarket/afterhours.
* Only works with type limit and time_in_force day.
* @param takeProfitLimitPrice Additional parameter for take-profit leg of advanced orders.
* @param stopLossStopPrice Additional parameters for stop-loss leg of advanced orders.
* @param stopLossLimitPrice Additional parameters for stop-loss leg of advanced orders. The stop-loss order
* becomes a stop-limit order if specified.
*
* @return the order
*
* @throws AlpacaAPIRequestException the alpaca api request exception
* @see Order Types
*/
public Order requestNewOCOOrder(String symbol, Integer quantity, OrderSide side,
OrderTimeInForce timeInForce, Boolean extendedHours, Double takeProfitLimitPrice,
Double stopLossStopPrice, Double stopLossLimitPrice) throws AlpacaAPIRequestException {
return requestNewOrder(symbol, quantity, side, OrderType.LIMIT, timeInForce, null, null, extendedHours, null,
OrderClass.OCO, takeProfitLimitPrice, stopLossStopPrice, stopLossLimitPrice);
}
/**
* 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 {@link #requestNewOrder(String, Integer, OrderSide, OrderType,
* OrderTimeInForce, Double, Double, Boolean, String, OrderClass, Double, Double, Double)} with {@link
* OrderType#LIMIT} and with parameters for an OTO order type.
*
* @param symbol symbol or asset ID to identify the asset to trade
* @param quantity number of shares to trade
* @param side buy or sell
* @param timeInForce day, gtc, opg, cls, ioc, fok. Please see Understand Orders for more info.
* @param extendedHours (default) false. If true, order will be eligible to execute in premarket/afterhours.
* Only works with type limit and time_in_force day.
* @param takeProfitLimitPrice Additional parameter for take-profit leg of advanced orders.
* @param stopLossStopPrice Additional parameters for stop-loss leg of advanced orders.
* @param stopLossLimitPrice Additional parameters for stop-loss leg of advanced orders. The stop-loss order
* becomes a stop-limit order if specified.
*
* @return the order
*
* @throws AlpacaAPIRequestException the alpaca api request exception
* @see Order Types
*/
public Order requestNewOTOMarketOrder(String symbol, Integer quantity, OrderSide side,
OrderTimeInForce timeInForce, Boolean extendedHours, Double takeProfitLimitPrice,
Double stopLossStopPrice, Double stopLossLimitPrice) throws AlpacaAPIRequestException {
return requestNewOrder(symbol, quantity, side, OrderType.MARKET, timeInForce, null, null, extendedHours, null,
OrderClass.OTO, takeProfitLimitPrice, stopLossStopPrice, stopLossLimitPrice);
}
/**
* 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 {@link #requestNewOrder(String, Integer, OrderSide, OrderType,
* OrderTimeInForce, Double, Double, Boolean, String, OrderClass, Double, Double, Double)} with {@link
* OrderType#LIMIT} and with parameters for an OTO order type.
*
* @param symbol symbol or asset ID to identify the asset to trade
* @param quantity number of shares to trade
* @param side buy or sell
* @param timeInForce day, gtc, opg, cls, ioc, fok. Please see Understand Orders for more info.
* @param limitPrice required if type is limit or stop_limit
* @param extendedHours (default) false. If true, order will be eligible to execute in premarket/afterhours.
* Only works with type limit and time_in_force day.
* @param takeProfitLimitPrice Additional parameter for take-profit leg of advanced orders.
* @param stopLossStopPrice Additional parameters for stop-loss leg of advanced orders.
* @param stopLossLimitPrice Additional parameters for stop-loss leg of advanced orders. The stop-loss order
* becomes a stop-limit order if specified.
*
* @return the order
*
* @throws AlpacaAPIRequestException the alpaca api request exception
* @see Order Types
*/
public Order requestNewOTOLimitOrder(String symbol, Integer quantity, OrderSide side,
OrderTimeInForce timeInForce, Double limitPrice, Boolean extendedHours, Double takeProfitLimitPrice,
Double stopLossStopPrice, Double stopLossLimitPrice) throws AlpacaAPIRequestException {
return requestNewOrder(symbol, quantity, side, OrderType.LIMIT, timeInForce, limitPrice, null, extendedHours,
null, OrderClass.OTO, takeProfitLimitPrice, stopLossStopPrice, stopLossLimitPrice);
}
/**
* 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 {@link #requestNewOrder(String, Integer, OrderSide, OrderType,
* OrderTimeInForce, Double, Double, Boolean, String, OrderClass, Double, Double, Double)} with {@link
* OrderType#STOP} and with parameters for an OTO order type.
*
* @param symbol symbol or asset ID to identify the asset to trade
* @param quantity number of shares to trade
* @param side buy or sell
* @param timeInForce day, gtc, opg, cls, ioc, fok. Please see Understand Orders for more info.
* @param stopPrice required if type is stop or stop_limit
* @param extendedHours (default) false. If true, order will be eligible to execute in premarket/afterhours.
* Only works with type limit and time_in_force day.
* @param takeProfitLimitPrice Additional parameter for take-profit leg of advanced orders.
* @param stopLossStopPrice Additional parameters for stop-loss leg of advanced orders.
* @param stopLossLimitPrice Additional parameters for stop-loss leg of advanced orders. The stop-loss order
* becomes a stop-limit order if specified.
*
* @return the order
*
* @throws AlpacaAPIRequestException the alpaca api request exception
* @see Order Types
*/
public Order requestNewOTOStopOrder(String symbol, Integer quantity, OrderSide side,
OrderTimeInForce timeInForce, Double stopPrice, Boolean extendedHours, Double takeProfitLimitPrice,
Double stopLossStopPrice, Double stopLossLimitPrice) throws AlpacaAPIRequestException {
return requestNewOrder(symbol, quantity, side, OrderType.STOP, timeInForce, null, stopPrice, extendedHours,
null, OrderClass.OTO, takeProfitLimitPrice, stopLossStopPrice, stopLossLimitPrice);
}
/**
* 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 {@link #requestNewOrder(String, Integer, OrderSide, OrderType,
* OrderTimeInForce, Double, Double, Boolean, String, OrderClass, Double, Double, Double)} with {@link
* OrderType#STOP_LIMIT} and with parameters for an OTO order type.
*
* @param symbol symbol or asset ID to identify the asset to trade
* @param quantity number of shares to trade
* @param side buy or sell
* @param timeInForce day, gtc, opg, cls, ioc, fok. Please see Understand Orders for more info.
* @param limitPrice required if type is limit or stop_limit
* @param stopPrice required if type is stop or stop_limit
* @param extendedHours (default) false. If true, order will be eligible to execute in premarket/afterhours.
* Only works with type limit and time_in_force day.
* @param takeProfitLimitPrice Additional parameter for take-profit leg of advanced orders.
* @param stopLossStopPrice Additional parameters for stop-loss leg of advanced orders.
* @param stopLossLimitPrice Additional parameters for stop-loss leg of advanced orders. The stop-loss order
* becomes a stop-limit order if specified.
*
* @return the order
*
* @throws AlpacaAPIRequestException the alpaca api request exception
* @see Order Types
*/
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 {
return requestNewOrder(symbol, quantity, side, OrderType.STOP_LIMIT, timeInForce, limitPrice, stopPrice,
extendedHours, null, OrderClass.OTO, takeProfitLimitPrice, stopLossStopPrice, stopLossLimitPrice);
}
/**
* Retrieves a single order for the given order_id.
*
* @param orderID Order ID
* @param nested If true, the result will roll up multi-leg orders under the legs field of primary order.
*
* @return the order
*
* @throws AlpacaAPIRequestException the alpaca API exception
* @see Orders
*/
public Order getOrder(String orderID, Boolean nested) throws AlpacaAPIRequestException {
Preconditions.checkNotNull(orderID);
AlpacaRequestBuilder urlBuilder = new AlpacaRequestBuilder(baseAPIURL, apiVersion,
AlpacaConstants.ORDERS_ENDPOINT,
orderID);
if (nested != null) {
urlBuilder.appendURLParameter(AlpacaConstants.NESTED_PARAMETER, nested.toString());
}
HttpResponse response = alpacaRequest.invokeGet(urlBuilder);
if (response.getStatus() != 200) {
throw new AlpacaAPIRequestException(response);
}
return alpacaRequest.getResponseObject(response, Order.class);
}
/**
* Retrieves a single order for the given client_order_id.
*
* @param clientOrderId the client order id
*
* @return the order by client id
*
* @throws AlpacaAPIRequestException the alpaca API exception
* @see Orders
*/
public Order getOrderByClientID(String clientOrderId) throws AlpacaAPIRequestException {
Preconditions.checkNotNull(clientOrderId);
AlpacaRequestBuilder urlBuilder = new AlpacaRequestBuilder(baseAPIURL, apiVersion,
AlpacaConstants.ORDERS_BY_CLIENT_ORDER_ID_ENDPOINT);
urlBuilder.appendURLParameter(AlpacaConstants.CLIENT_ORDER_ID_PARAMETER, clientOrderId);
HttpResponse response = alpacaRequest.invokeGet(urlBuilder);
if (response.getStatus() != 200) {
throw new AlpacaAPIRequestException(response);
}
return alpacaRequest.getResponseObject(response, Order.class);
}
/**
* 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.
*
* @param orderID Order id
* @param quantity number of shares to trade
* @param timeInForce day, gtc, opg, cls, ioc, fok. Please see Understand Orders for more info.
* @param limitPrice required if type is limit or stop_limit
* @param stopPrice required if type is stop or stop_limit
* @param clientOrderId A unique identifier for the order. Automatically generated if not sent.
*
* @return the order
*
* @throws AlpacaAPIRequestException the alpaca api request exception
* @see Orders
*/
public Order replaceOrder(String orderID, Integer quantity, OrderTimeInForce timeInForce, Double limitPrice,
Double stopPrice, String clientOrderId) throws AlpacaAPIRequestException {
Preconditions.checkNotNull(orderID);
AlpacaRequestBuilder urlBuilder = new AlpacaRequestBuilder(baseAPIURL, apiVersion,
AlpacaConstants.ORDERS_ENDPOINT,
orderID);
if (quantity != null) {
urlBuilder.appendJSONBodyProperty(AlpacaConstants.QTY_PARAMETER, quantity.toString());
}
if (timeInForce != null) {
urlBuilder.appendJSONBodyProperty(AlpacaConstants.TIME_IN_FORCE_PARAMETER, timeInForce.getAPIName());
}
if (limitPrice != null) {
urlBuilder.appendJSONBodyProperty(AlpacaConstants.LIMIT_PRICE_PARAMETER,
TimeUtil.toDecimalFormat(limitPrice));
}
if (stopPrice != null) {
urlBuilder.appendJSONBodyProperty(AlpacaConstants.STOP_PRICE_PARAMETER,
TimeUtil.toDecimalFormat(stopPrice));
}
if (clientOrderId != null) {
urlBuilder.appendJSONBodyProperty(AlpacaConstants.CLIENT_ORDER_ID_PARAMETER, clientOrderId);
}
HttpResponse response = alpacaRequest.invokePatch(urlBuilder);
if (response.getStatus() != 200) {
throw new AlpacaAPIRequestException(response);
}
return alpacaRequest.getResponseObject(response, Order.class);
}
/**
* 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.
*
* @return the array list of cancelled orders
*
* @throws AlpacaAPIRequestException the alpaca api request exception
* @see Orders
*/
public ArrayList cancelAllOrders() throws AlpacaAPIRequestException {
AlpacaRequestBuilder urlBuilder = new AlpacaRequestBuilder(baseAPIURL, apiVersion,
AlpacaConstants.ORDERS_ENDPOINT);
HttpResponse response = alpacaRequest.invokeDelete(urlBuilder);
if (response.getStatus() != 207) { // This returns a 207 multi-status message
throw new AlpacaAPIRequestException(response);
}
Type arrayListType = new TypeToken>() {}.getType();
return alpacaRequest.getResponseObject(response, arrayListType);
}
/**
* 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.
*
* @param orderId Order ID
*
* @return true, if successful
*
* @throws AlpacaAPIRequestException the alpaca API exception
* @see Orders
*/
public boolean cancelOrder(String orderId) throws AlpacaAPIRequestException {
Preconditions.checkNotNull(orderId);
AlpacaRequestBuilder urlBuilder = new AlpacaRequestBuilder(baseAPIURL, apiVersion,
AlpacaConstants.ORDERS_ENDPOINT,
orderId);
HttpResponse response = alpacaRequest.invokeDelete(urlBuilder);
if ((response.getStatus() != 200 && response.getStatus() != 204)) {
throw new AlpacaAPIRequestException(response);
}
return response.getStatus() == 200 || response.getStatus() == 204;
}
/**
* Gets the open positions.
*
* @return the open positions
*
* @throws AlpacaAPIRequestException the alpaca API exception
* @see Positions
*/
public ArrayList getOpenPositions() throws AlpacaAPIRequestException {
AlpacaRequestBuilder urlBuilder = new AlpacaRequestBuilder(baseAPIURL, apiVersion,
AlpacaConstants.POSITIONS_ENDPOINT);
HttpResponse response = alpacaRequest.invokeGet(urlBuilder);
if (response.getStatus() != 200) {
throw new AlpacaAPIRequestException(response);
}
Type arrayListType = new TypeToken>() {}.getType();
return alpacaRequest.getResponseObject(response, arrayListType);
}
/**
* Gets the open position by symbol.
*
* @param symbol the symbol or asset_id (required)
*
* @return the open position by symbol
*
* @throws AlpacaAPIRequestException the alpaca API exception
* @see Positions
*/
public Position getOpenPositionBySymbol(String symbol) throws AlpacaAPIRequestException {
Preconditions.checkNotNull(symbol);
AlpacaRequestBuilder urlBuilder = new AlpacaRequestBuilder(baseAPIURL, apiVersion,
AlpacaConstants.POSITIONS_ENDPOINT,
symbol.trim());
HttpResponse response = alpacaRequest.invokeGet(urlBuilder);
if (response.getStatus() != 200) {
throw new AlpacaAPIRequestException(response);
}
return alpacaRequest.getResponseObject(response, Position.class);
}
/**
* 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.
*
* @return a list of closing position orders
*
* @throws AlpacaAPIRequestException the alpaca API exception
* @see Positions
*/
public ArrayList closeAllPositions() throws AlpacaAPIRequestException {
AlpacaRequestBuilder urlBuilder = new AlpacaRequestBuilder(baseAPIURL, apiVersion,
AlpacaConstants.POSITIONS_ENDPOINT);
HttpResponse response = alpacaRequest.invokeDelete(urlBuilder);
if (response.getStatus() != 207) { // This returns a 207 multi-status message
throw new AlpacaAPIRequestException(response);
}
Type arrayListType = new TypeToken>() {}.getType();
return alpacaRequest.getResponseObject(response, arrayListType);
}
/**
* Closes (liquidates) the account’s open position for the given symbol. Works for both long and short positions.
*
* @param symbol symbol or asset_id
*
* @return a closing position order
*
* @throws AlpacaAPIRequestException the alpaca API exception
* @see Positions
*/
public Order closePosition(String symbol) throws AlpacaAPIRequestException {
Preconditions.checkNotNull(symbol);
AlpacaRequestBuilder urlBuilder = new AlpacaRequestBuilder(baseAPIURL, apiVersion,
AlpacaConstants.POSITIONS_ENDPOINT,
symbol);
HttpResponse response = alpacaRequest.invokeDelete(urlBuilder);
if (response.getStatus() != 200) {
throw new AlpacaAPIRequestException(response);
}
return alpacaRequest.getResponseObject(response, Order.class);
}
/**
* Get a list of assets.
*
* @param assetStatus e.g. “active”. By default, all statuses are included.
* @param assetClass Defaults to us_equity.
*
* @return the assets
*
* @throws AlpacaAPIRequestException the alpaca API exception
* @see Assets
*/
public ArrayList getAssets(AssetStatus assetStatus, String assetClass) throws AlpacaAPIRequestException {
AlpacaRequestBuilder urlBuilder = new AlpacaRequestBuilder(baseAPIURL, apiVersion,
AlpacaConstants.ASSETS_ENDPOINT);
if (assetStatus != null) {
urlBuilder.appendURLParameter(AlpacaConstants.STATUS_PARAMETER, assetStatus.getAPIName());
}
if (assetClass != null) {
urlBuilder.appendURLParameter(AlpacaConstants.ASSET_CLASS_PARAMETER, assetClass.trim());
}
HttpResponse response = alpacaRequest.invokeGet(urlBuilder);
if (response.getStatus() != 200) {
throw new AlpacaAPIRequestException(response);
}
Type arrayListType = new TypeToken>() {}.getType();
return alpacaRequest.getResponseObject(response, arrayListType);
}
/**
* Gets the asset by symbol or asset_id.
*
* @param symbolOrAssetID the symbol or asset_id (required)
*
* @return the asset by symbol
*
* @throws AlpacaAPIRequestException the alpaca API exception
* @see Assets
*/
public Asset getAssetBySymbol(String symbolOrAssetID) throws AlpacaAPIRequestException {
Preconditions.checkNotNull(symbolOrAssetID);
AlpacaRequestBuilder urlBuilder = new AlpacaRequestBuilder(baseAPIURL, apiVersion,
AlpacaConstants.ASSETS_ENDPOINT,
symbolOrAssetID.trim());
HttpResponse response = alpacaRequest.invokeGet(urlBuilder);
if (response.getStatus() != 200) {
throw new AlpacaAPIRequestException(response);
}
return alpacaRequest.getResponseObject(response, Asset.class);
}
/**
* Returns the list of watchlists registered under the account.
*
* @return the watch lists
*
* @throws AlpacaAPIRequestException the alpaca api exception
* @see Watchlists
*/
public ArrayList getWatchlists() throws AlpacaAPIRequestException {
AlpacaRequestBuilder urlBuilder = new AlpacaRequestBuilder(baseAPIURL, apiVersion,
AlpacaConstants.WATCHLISTS_ENDPOINT);
HttpResponse response = alpacaRequest.invokeGet(urlBuilder);
if (response.getStatus() != 200) {
throw new AlpacaAPIRequestException(response);
}
Type arrayListType = new TypeToken>() {}.getType();
return alpacaRequest.getResponseObject(response, arrayListType);
}
/**
* Create a new watchlist with initial set of assets.
*
* @param name arbitrary name string, up to 64 characters
* @param symbols set of symbol string
*
* @return the created watchlist
*
* @throws AlpacaAPIRequestException the alpaca api exception
* @see Watchlists
*/
public Watchlist createWatchlist(String name, String... symbols) throws AlpacaAPIRequestException {
Preconditions.checkNotNull(name);
Preconditions.checkState(name.length() <= 64);
AlpacaRequestBuilder urlBuilder = new AlpacaRequestBuilder(baseAPIURL, apiVersion,
AlpacaConstants.WATCHLISTS_ENDPOINT);
urlBuilder.appendJSONBodyProperty("name", name);
if (symbols != null) {
JsonArray symbolsArray = new JsonArray();
Arrays.stream(symbols).forEach(symbolsArray::add);
urlBuilder.appendJSONBodyJSONProperty("symbols", symbolsArray);
}
HttpResponse response = alpacaRequest.invokePost(urlBuilder);
if (response.getStatus() != 200) {
throw new AlpacaAPIRequestException(response);
}
return alpacaRequest.getResponseObject(response, Watchlist.class);
}
/**
* Returns a watchlist identified by the ID.
*
* @param watchlistID Watchlist ID
*
* @return the watchlist
*
* @throws AlpacaAPIRequestException the alpaca api exception
* @see Watchlists
*/
public Watchlist getWatchlist(String watchlistID) throws AlpacaAPIRequestException {
Preconditions.checkNotNull(watchlistID);
AlpacaRequestBuilder urlBuilder = new AlpacaRequestBuilder(baseAPIURL, apiVersion,
AlpacaConstants.WATCHLISTS_ENDPOINT,
watchlistID);
HttpResponse response = alpacaRequest.invokeGet(urlBuilder);
if (response.getStatus() != 200) {
throw new AlpacaAPIRequestException(response);
}
return alpacaRequest.getResponseObject(response, Watchlist.class);
}
/**
* Update the name and/or content of watchlist.
*
* @param watchlistID Watchlist ID
* @param name the new watchlist name
* @param symbols the new list of symbol names to replace the watchlist content
*
* @return the updated watchlist
*
* @throws AlpacaAPIRequestException the alpaca api exception
* @see Watchlists
*/
public Watchlist updateWatchlist(String watchlistID, String name, String... symbols)
throws AlpacaAPIRequestException {
Preconditions.checkNotNull(watchlistID);
AlpacaRequestBuilder urlBuilder = new AlpacaRequestBuilder(baseAPIURL, apiVersion,
AlpacaConstants.WATCHLISTS_ENDPOINT,
watchlistID);
if (name != null) {
urlBuilder.appendJSONBodyProperty("name", name);
}
if (symbols != null) {
JsonArray symbolsArray = new JsonArray();
Arrays.stream(symbols).forEach(symbolsArray::add);
urlBuilder.appendJSONBodyJSONProperty("symbols", symbolsArray);
}
HttpResponse response = alpacaRequest.invokePut(urlBuilder);
if (response.getStatus() != 200) {
throw new AlpacaAPIRequestException(response);
}
return alpacaRequest.getResponseObject(response, Watchlist.class);
}
/**
* Append an asset for the symbol to the end of watchlist asset list
*
* @param watchlistID Watchlist ID
* @param symbol the symbol name to add to the watchlist
*
* @return the watchlist
*
* @throws AlpacaAPIRequestException the alpaca api exception
* @see Watchlists
*/
public Watchlist addWatchlistAsset(String watchlistID, String symbol) throws AlpacaAPIRequestException {
Preconditions.checkNotNull(watchlistID);
Preconditions.checkNotNull(symbol);
AlpacaRequestBuilder urlBuilder = new AlpacaRequestBuilder(baseAPIURL, apiVersion,
AlpacaConstants.WATCHLISTS_ENDPOINT,
watchlistID);
urlBuilder.appendJSONBodyProperty("symbol", symbol);
HttpResponse response = alpacaRequest.invokePost(urlBuilder);
if (response.getStatus() != 200) {
throw new AlpacaAPIRequestException(response);
}
return alpacaRequest.getResponseObject(response, Watchlist.class);
}
/**
* Delete a watchlist. This is a permanent deletion.
*
* @param watchlistID Watchlist ID
*
* @return if the watchlist was deleted
*
* @throws AlpacaAPIRequestException the alpaca api exception
* @see Watchlists
*/
public boolean deleteWatchlist(String watchlistID) throws AlpacaAPIRequestException {
Preconditions.checkNotNull(watchlistID);
AlpacaRequestBuilder urlBuilder = new AlpacaRequestBuilder(baseAPIURL, apiVersion,
AlpacaConstants.WATCHLISTS_ENDPOINT,
watchlistID);
HttpResponse response = alpacaRequest.invokeDelete(urlBuilder);
if ((response.getStatus() != 200 && response.getStatus() != 204)) {
throw new AlpacaAPIRequestException(response);
}
return response.getStatus() == 200 || response.getStatus() == 204;
}
/**
* Delete one entry for an asset by symbol name.
*
* @param watchlistID Watchlist ID
* @param symbol symbol name to remove from the watchlist content
*
* @return the updated watchlist
*
* @throws AlpacaAPIRequestException the alpaca api exception
* @see Watchlists
*/
public Watchlist removeSymbolFromWatchlist(String watchlistID, String symbol) throws AlpacaAPIRequestException {
Preconditions.checkNotNull(watchlistID);
Preconditions.checkNotNull(symbol);
AlpacaRequestBuilder urlBuilder = new AlpacaRequestBuilder(baseAPIURL, apiVersion,
AlpacaConstants.WATCHLISTS_ENDPOINT,
watchlistID,
symbol);
HttpResponse response = alpacaRequest.invokeDelete(urlBuilder);
if (response.getStatus() != 200) {
throw new AlpacaAPIRequestException(response);
}
return alpacaRequest.getResponseObject(response, Watchlist.class);
}
/**
* Returns timeseries data about equity and profit/loss (P/L) of the account in requested timespan.
*
* @param 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.
* @param 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.
* @param 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.
* @param 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)
* @param extendedHours If true, include extended hours in the result. This is effective only for timeframe less
* than 1D.
*
* @return the portfolio history
*
* @throws AlpacaAPIRequestException the alpaca api request exception
*/
public PortfolioHistory getPortfolioHistory(Integer periodLength, PortfolioPeriodUnit periodUnit,
PortfolioTimeFrame timeFrame, LocalDate dateEnd, Boolean extendedHours) throws AlpacaAPIRequestException {
AlpacaRequestBuilder urlBuilder = new AlpacaRequestBuilder(baseAPIURL, apiVersion,
AlpacaConstants.ACCOUNT_ENDPOINT,
AlpacaConstants.PORTFOLIO_ENDPOINT,
AlpacaConstants.HISTORY_ENDPOINT);
if (periodLength != null && periodUnit != null) {
urlBuilder.appendURLParameter(AlpacaConstants.PERIOD_PARAMETER, periodLength + periodUnit.getAPIName());
}
if (timeFrame != null) {
urlBuilder.appendURLParameter(AlpacaConstants.TIMEFRAME_PARAMETER, timeFrame.getAPIName());
}
if (dateEnd != null) {
urlBuilder.appendURLParameter(AlpacaConstants.DATE_END_PARAMETER, TimeUtil.toDateString(dateEnd));
}
if (extendedHours != null) {
urlBuilder.appendURLParameter(AlpacaConstants.EXTENDED_HOURS_PARAMETER, extendedHours.toString());
}
HttpResponse response = alpacaRequest.invokeGet(urlBuilder);
if (response.getStatus() != 200) {
throw new AlpacaAPIRequestException(response);
}
return alpacaRequest.getResponseObject(response, PortfolioHistory.class);
}
/**
* Returns the market calendar.
*
* @return the calendar
*
* @throws AlpacaAPIRequestException the alpaca API exception
* @see Calendar
*/
public ArrayList getCalendar() throws AlpacaAPIRequestException {
AlpacaRequestBuilder urlBuilder = new AlpacaRequestBuilder(baseAPIURL, apiVersion,
AlpacaConstants.CALENDAR_ENDPOINT);
HttpResponse response = alpacaRequest.invokeGet(urlBuilder);
if (response.getStatus() != 200) {
throw new AlpacaAPIRequestException(response);
}
Type arrayListType = new TypeToken>() {}.getType();
return alpacaRequest.getResponseObject(response, arrayListType);
}
/**
* Returns the market calendar.
*
* @param start The first date to retrieve data for (inclusive)
* @param end The last date to retrieve data for (inclusive)
*
* @return the calendar
*
* @throws AlpacaAPIRequestException the alpaca API exception
* @see Calendar
*/
public ArrayList getCalendar(LocalDate start, LocalDate end) throws AlpacaAPIRequestException {
AlpacaRequestBuilder urlBuilder = new AlpacaRequestBuilder(baseAPIURL, apiVersion,
AlpacaConstants.CALENDAR_ENDPOINT);
if (start != null) {
urlBuilder.appendURLParameter(AlpacaConstants.START_PARAMETER, TimeUtil.toDateString(start));
}
if (end != null) {
urlBuilder.appendURLParameter(AlpacaConstants.END_PARAMETER, TimeUtil.toDateString(end));
}
HttpResponse response = alpacaRequest.invokeGet(urlBuilder);
if (response.getStatus() != 200) {
throw new AlpacaAPIRequestException(response);
}
Type arrayListType = new TypeToken>() {}.getType();
return alpacaRequest.getResponseObject(response, arrayListType);
}
/**
* Returns the market clock.
*
* @return the clock
*
* @throws AlpacaAPIRequestException the alpaca API exception
* @see Clock
*/
public Clock getClock() throws AlpacaAPIRequestException {
AlpacaRequestBuilder urlBuilder = new AlpacaRequestBuilder(baseAPIURL, apiVersion,
AlpacaConstants.CLOCK_ENDPOINT);
HttpResponse response = alpacaRequest.invokeGet(urlBuilder);
if (response.getStatus() != 200) {
throw new AlpacaAPIRequestException(response);
}
return alpacaRequest.getResponseObject(response, Clock.class);
}
/**
* 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.
*
* @param timeframe One of minute, 1Min, 5Min, 15Min, day or 1D. minute is an alias of 1Min. Similarly, day is of
* 1D.
* @param symbol One symbol name.
* @param 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.
* @param start Filter bars equal to or after this time. Cannot be used with after.
* @param end Filter bars equal to or before this time. Cannot be used with until.
* @param after Filter bars after this time. Cannot be used with start.
* @param until Filter bars before this time. Cannot be used with end.
*
* @return the bars
*
* @throws AlpacaAPIRequestException the alpaca API exception
* @see Bars
*/
public Map> getBars(BarsTimeFrame timeframe, String symbol, Integer limit,
ZonedDateTime start, ZonedDateTime end, ZonedDateTime after, ZonedDateTime until)
throws AlpacaAPIRequestException {
return this.getBars(timeframe, new String[]{symbol}, limit, start, end, after, until);
}
/**
* 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.
*
* @param timeframe One of minute, 1Min, 5Min, 15Min, day or 1D. minute is an alias of 1Min. Similarly, day is of
* 1D.
* @param symbols One or more (max 200) symbol names split by commas (“,”).
* @param 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.
* @param start Filter bars equal to or after this time. Cannot be used with after.
* @param end Filter bars equal to or before this time. Cannot be used with until.
* @param after Filter bars after this time. Cannot be used with start.
* @param until Filter bars before this time. Cannot be used with end.
*
* @return the bars
*
* @throws AlpacaAPIRequestException the alpaca API exception
* @see Bars
*/
public Map> getBars(BarsTimeFrame timeframe, String[] symbols, Integer limit,
ZonedDateTime start, ZonedDateTime end, ZonedDateTime after, ZonedDateTime until)
throws AlpacaAPIRequestException {
AlpacaRequestBuilder urlBuilder = new AlpacaRequestBuilder(baseDataUrl, AlpacaConstants.VERSION_1_ENDPOINT,
AlpacaConstants.BARS_ENDPOINT);
if (timeframe != null) {
urlBuilder.appendEndpoint(timeframe.getAPIName());
}
if (symbols != null) {
urlBuilder.appendURLParameter(AlpacaConstants.SYMBOLS_PARAMETER, String.join(",", symbols));
}
if (limit != null) {
urlBuilder.appendURLParameter(AlpacaConstants.LIMIT_PARAMETER, limit.toString());
}
if (start != null) {
urlBuilder.appendURLParameter(AlpacaConstants.START_PARAMETER,
start.format(DateTimeFormatter.ISO_OFFSET_DATE_TIME));
}
if (end != null) {
urlBuilder.appendURLParameter(AlpacaConstants.END_PARAMETER,
end.format(DateTimeFormatter.ISO_OFFSET_DATE_TIME));
}
if (after != null) {
urlBuilder.appendURLParameter(AlpacaConstants.AFTER_PARAMETER,
after.format(DateTimeFormatter.ISO_OFFSET_DATE_TIME));
}
if (until != null) {
urlBuilder.appendURLParameter(AlpacaConstants.UNTIL_PARAMETER,
until.format(DateTimeFormatter.ISO_OFFSET_DATE_TIME));
}
HttpResponse response = alpacaRequest.invokeGet(urlBuilder);
if (response.getStatus() != 200) {
throw new AlpacaAPIRequestException(response);
}
Type mapType = new TypeToken>>() {}.getType();
return alpacaRequest.getResponseObject(response, mapType);
}
/**
* Adds the alpaca stream listener.
*
* @param streamListener the stream listener
*/
public void addAlpacaStreamListener(AlpacaStreamListener streamListener) {
alpacaWebSocketClient.addListener(streamListener);
}
/**
* Removes the alpaca stream listener.
*
* @param streamListener the stream listener
*/
public void removeAlpacaStreamListener(AlpacaStreamListener streamListener) {
alpacaWebSocketClient.removeListener(streamListener);
}
@Override
public String toString() {
return new StringJoiner(", ", this.getClass().getSimpleName() + "[", "]")
.add("apiVersion = " + apiVersion)
.add("baseAPIURL = " + baseAPIURL)
.add("baseDataUrl = " + baseDataUrl)
.add("keyId = " + keyId)
.toString();
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy