Package 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	Description
AlpacaAPI()	Instantiates a new Alpaca API using properties specified in alpaca.properties file (or relevant defaults)
AlpacaAPI(java.lang.String keyId, java.lang.String secret, java.lang.String baseAccountUrl)	Instantiates a new Alpaca API using the specified keyId, secret, baseAccountUrl, and baseDataUrl
AlpacaAPI(java.lang.String keyId, java.lang.String secret, java.lang.String baseAccountUrl, java.lang.String baseDataUrl)	Instantiates a new Alpaca API using the specified keyId, secret, baseAccountUrl, and baseDataUrl.

Method Summary

Modifier and Type	Method	Description
boolean	cancelOrder(java.lang.String orderId)	Cancel order.
Account	getAccount()	Gets the account.
Asset	getAssetBySymbol(java.lang.String symbol)	Gets the asset by symbol or asset_id.
java.util.List<Asset>	getAssets()	Gets the assets using the following API defaults: Status: Active Asset Class: us_equity
java.util.List<Asset>	getAssets(AssetStatus assetStatus, java.lang.String assetClass)	Gets the assets.
java.util.Map<java.lang.String,java.util.List<Bar>>	getBars(BarsTimeFrame timeframe, java.lang.String[] symbols, java.lang.Integer limit, java.time.LocalDateTime start, java.time.LocalDateTime end, java.time.LocalDateTime after, java.time.LocalDateTime until)	Gets the bars.
java.util.List<Bar>	getBars(BarsTimeFrame timeframe, java.lang.String symbol, java.lang.Integer limit, java.time.LocalDateTime start, java.time.LocalDateTime end, java.time.LocalDateTime after, java.time.LocalDateTime until)	Gets the bars.
java.util.List<Calendar>	getCalendar()	Gets the calendar.
java.util.List<Calendar>	getCalendar(java.time.LocalDate start, java.time.LocalDate end)	Gets the calendar.
Clock	getClock()	Gets the clock.
Position	getOpenPositionBySymbol(java.lang.String symbol)	Gets the open position by symbol.
java.util.List<Position>	getOpenPositions()	Gets the open positions.
Order	getOrder(java.lang.String orderId)	Gets the order.
Order	getOrderByClientId(java.lang.String clientOrderId)	Gets the order by client id.
java.util.List<Order>	getOrders()	Gets the orders using the following API defaults:
java.util.List<Order>	getOrders(OrderStatus status, java.lang.Integer limit, java.time.LocalDateTime after, java.time.LocalDateTime until, Direction direction)	Gets the orders.
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.String clientOrderId)	Request/Submits new order.

Methods inherited from class java.lang.Object

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

Constructor Detail

AlpacaAPI

public AlpacaAPI()

Instantiates a new Alpaca API using properties specified in alpaca.properties file (or relevant defaults)

AlpacaAPI

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

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

Parameters:

keyId - the key id

secret - the secret

baseAccountUrl - the base account url

baseDataUrl - the base data url

AlpacaAPI

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

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

Parameters:

keyId - the key id

secret - the secret

baseAccountUrl - the base account url

Method Detail

getAccount

public Account getAccount()
                   throws AlpacaAPIException

Gets the account.

Returns:

the account

Throws:

AlpacaAPIException - the alpaca API exception

See Also:

https://docs.alpaca.markets/api-documentation/web-api/account/#get-the-account

getOrders

public java.util.List<Order> getOrders()
                                throws AlpacaAPIException

Gets the orders using the following API defaults:

Returns:

the orders

Throws:

AlpacaAPIException - the alpaca API exception

See Also:

https://docs.alpaca.markets/api-documentation/web-api/orders/#get-a-list-of-orders Status: Open Limit: 50 Direction: Descending

getOrders

public java.util.List<Order> getOrders(OrderStatus status,
                                       java.lang.Integer limit,
                                       java.time.LocalDateTime after,
                                       java.time.LocalDateTime until,
                                       Direction direction)
                                throws AlpacaAPIException

Gets the orders.

Parameters:

status - the status (Open if null)

limit - the limit (50 if null)

after - the after

until - the until

direction - the direction (Descending if null)

Returns:

the orders

Throws:

AlpacaAPIException - the alpaca API exception

See Also:

https://docs.alpaca.markets/api-documentation/web-api/orders/#get-a-list-of-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.String clientOrderId)
                      throws AlpacaAPIException

Request/Submits new order.

Parameters:

symbol - the symbol or asset_id (required)

quantity - the quantity (required)

side - the side (required)

type - the type (required)

timeInForce - the time in force (required)

limitPrice - the limit price (required if Limit or Stop Limit)

stopPrice - the stop price (required if Stop or Stop Limit)

clientOrderId - the client order id (optional)

Returns:

the order

Throws:

AlpacaAPIException - the alpaca API exception

See Also:

https://docs.alpaca.markets/api-documentation/web-api/orders/#request-a-new-order

getOrder

public Order getOrder(java.lang.String orderId)
               throws AlpacaAPIException

Gets the order.

Parameters:

orderId - the order id (required)

Returns:

the order

Throws:

AlpacaAPIException - the alpaca API exception

See Also:

https://docs.alpaca.markets/api-documentation/web-api/orders/#get-an-order

getOrderByClientId

public Order getOrderByClientId(java.lang.String clientOrderId)
                         throws AlpacaAPIException

Gets the order by client id.

Parameters:

clientOrderId - the client order id (required)

Returns:

the order by client id

Throws:

AlpacaAPIException - the alpaca API exception

See Also:

https://docs.alpaca.markets/api-documentation/web-api/orders/#get-an-order-by-client-order-id

cancelOrder

public boolean cancelOrder(java.lang.String orderId)
                    throws AlpacaAPIException

Cancel order.

Parameters:

orderId - the order id (required)

Returns:

true, if successful

Throws:

AlpacaAPIException - the alpaca API exception

See Also:

https://docs.alpaca.markets/api-documentation/web-api/orders/#cancel-an-order

getOpenPositions

public java.util.List<Position> getOpenPositions()
                                          throws AlpacaAPIException

Gets the open positions.

Returns:

the open positions

Throws:

AlpacaAPIException - the alpaca API exception

See Also:

https://docs.alpaca.markets/api-documentation/web-api/positions/#get-open-positions

getOpenPositionBySymbol

public Position getOpenPositionBySymbol(java.lang.String symbol)
                                 throws AlpacaAPIException

Gets the open position by symbol.

Parameters:

symbol - the symbol or asset_id (required)

Returns:

the open position by symbol

Throws:

AlpacaAPIException - the alpaca API exception

See Also:

https://docs.alpaca.markets/api-documentation/web-api/positions/#get-an-open-position

getAssets

public java.util.List<Asset> getAssets()
                                throws AlpacaAPIException

Gets the assets using the following API defaults: Status: Active Asset Class: us_equity

Returns:

the assets

Throws:

AlpacaAPIException - the alpaca API exception

See Also:

https://docs.alpaca.markets/api-documentation/web-api/assets/#get-assets

getAssets

public java.util.List<Asset> getAssets(AssetStatus assetStatus,
                                       java.lang.String assetClass)
                                throws AlpacaAPIException

Gets the assets.

Parameters:

assetStatus - the asset status (Active if null)

assetClass - the asset class (us_equity if null)

Returns:

the assets

Throws:

AlpacaAPIException - the alpaca API exception

See Also:

https://docs.alpaca.markets/api-documentation/web-api/assets/#get-assets

getAssetBySymbol

public Asset getAssetBySymbol(java.lang.String symbol)
                       throws AlpacaAPIException

Gets the asset by symbol or asset_id.

Parameters:

symbol - the symbol (required)

Returns:

the asset by symbol

Throws:

AlpacaAPIException - the alpaca API exception

See Also:

https://docs.alpaca.markets/api-documentation/web-api/assets/#get-an-asset

getCalendar

public java.util.List<Calendar> getCalendar()
                                     throws AlpacaAPIException

Gets the calendar.

Returns:

the calendar

Throws:

AlpacaAPIException - the alpaca API exception

See Also:

https://docs.alpaca.markets/api-documentation/web-api/calendar/#get-the-calendar

getCalendar

public java.util.List<Calendar> getCalendar(java.time.LocalDate start,
                                            java.time.LocalDate end)
                                     throws AlpacaAPIException

Gets the calendar.

Parameters:

start - the start

end - the end

Returns:

the calendar

Throws:

AlpacaAPIException - the alpaca API exception

See Also:

https://docs.alpaca.markets/api-documentation/web-api/calendar/#get-the-calendar

getClock

public Clock getClock()
               throws AlpacaAPIException

Gets the clock.

Returns:

the clock

Throws:

AlpacaAPIException - the alpaca API exception

See Also:

https://docs.alpaca.markets/api-documentation/web-api/clock/#get-the-clock

getBars

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

Gets the bars.

Parameters:

timeframe - the timeframe (required)

symbols - One or more (max 200) symbol names (required)

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. (100 if null)

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:

AlpacaAPIException - the alpaca API exception

See Also:

https://docs.alpaca.markets/api-documentation/web-api/market-data/bars/#get-a-list-of-bars

getBars

public java.util.List<Bar> getBars(BarsTimeFrame timeframe,
                                   java.lang.String symbol,
                                   java.lang.Integer limit,
                                   java.time.LocalDateTime start,
                                   java.time.LocalDateTime end,
                                   java.time.LocalDateTime after,
                                   java.time.LocalDateTime until)
                            throws AlpacaAPIException

Gets the bars.

Parameters:

timeframe - the timeframe (required)

symbol - One symbol name (required)

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. (100 if null)

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:

AlpacaAPIException - the alpaca API exception

See Also:

https://docs.alpaca.markets/api-documentation/web-api/market-data/bars/#get-a-list-of-bars