Package net.jacobpeterson.alpaca.rest.endpoint.positions

Class PositionsEndpoint

java.lang.Object

net.jacobpeterson.alpaca.rest.endpoint.AlpacaEndpoint

net.jacobpeterson.alpaca.rest.endpoint.positions.PositionsEndpoint

public class PositionsEndpoint
extends AlpacaEndpoint

AlpacaEndpoint for Positions.

Field Summary

Fields inherited from class net.jacobpeterson.alpaca.rest.endpoint.AlpacaEndpoint

alpacaClient, endpointPathSegment

Constructor Summary

Constructors

Constructor	Description
PositionsEndpoint(AlpacaClient alpacaClient)	Instantiates a new PositionsEndpoint.

Method Summary

Modifier and Type	Method	Description
Order	close(String symbolOrAssetID, Integer quantity, Double percentage)	Closes (liquidates) the account’s open position for the given symbol.
List<ClosePositionOrder>	closeAll(Boolean cancelOrders)	Closes (liquidates) all of the account’s open long and short Positions.
List<Position>	get()	Retrieves a list of the account's open Positions.
Position	getBySymbol(String symbolOrAssetID)	Retrieves the account's open Positions for the given symbol or Asset.getId().

Methods inherited from class java.lang.Object

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

Constructor Details

PositionsEndpoint

public PositionsEndpoint(AlpacaClient alpacaClient)

Instantiates a new PositionsEndpoint.

Parameters:

alpacaClient - the AlpacaClient

Method Details

get

public List<Position> get() throws AlpacaClientException

Retrieves a list of the account's open Positions.

Returns:

a List of open Positions

Throws:

AlpacaClientException - thrown for AlpacaClientExceptions

getBySymbol

public Position getBySymbol(String symbolOrAssetID) throws AlpacaClientException

Retrieves the account's open Positions for the given symbol or Asset.getId().

Parameters:

symbolOrAssetID - the symbol or Asset.getId() (required)

Returns:

the open Position

Throws:

AlpacaClientException - thrown for AlpacaClientExceptions

closeAll

public List<ClosePositionOrder> closeAll(Boolean cancelOrders) throws AlpacaClientException

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.

Parameters:

cancelOrders - if true is specified, cancel all open orders before liquidating all positions

Returns:

a List of open ClosePositionOrders

Throws:

AlpacaClientException - thrown for AlpacaClientExceptions

close

public Order close(String symbolOrAssetID, Integer quantity, Double percentage) throws AlpacaClientException

Closes (liquidates) the account’s open position for the given symbol. Works for both long and short positions.

Parameters:

symbolOrAssetID - the symbol or Asset.getId()

quantity - the number of shares to liquidate. Can accept up to 9 decimal points. Cannot work with percentage.

percentage - the percentage of the position to liquidate. Must be between 0 and 100. Would only sell fractional if position is originally fractional. Can accept up to 9 decimal points. Cannot work with quantity.

Returns:

a closing Position Order

Throws:

AlpacaClientException - thrown for AlpacaClientExceptions