Position Information
Last updated
Last updated
Adjusts a virtual bot position by processing a simulated order using the defined specifications. Works similarly to PlaceExitLongOrder/PlaceExitShortOrder, but will NOT create a real order; only simulated!
AdjustVPosition(price, amount, [ positionId ])
Return Type: Void
Closes a virtual bot position entirely by processing a simulated order using the defined specifications. Works similarly to DoExitPosition and PlaceExitPositionOrder, but will NOT create a real order; only simulated! Use this to "clean up" bot positions if required.
CloseVPosition(price, [ positionId ])
Return Type: Void
Creates a bot position by processing a simulated order using the defined specifications. By doing this, profit/loss and position details can be used by the script. Use the returned position ID with PositionContainer() to extract position data.
CreatePosition(direction, price, amount, [ market ], [ leverage ], [ positionId ])
Returns the position ID.
Return Type: String
Gets all open positions and returns them as PositionContainers.
GetAllOpenPositions()
Returns an array of PositionContainers.
Return Type: Dynamic
Gets the total amount open in a specific position.
GetPositionAmount([ positionId ])
Returns the total amount open in a specific position.
Return Type: Number
Gets the direction of a specific position.
GetPositionDirection([ positionId ])
Returns PositionLong, PositionShort or NoPosition.
Return Type: Enum
Gets the average enter price of an open position.
GetPositionEnterPrice([ positionId ])
Returns the average enter price.
Return Type: Number
Gets the market of an open position.
GetPositionMarket([ positionId ])
Returns the account, market & leverage as a single string.
Return Type: String
Gets the total realized plus unrealized profit of a specific position.
GetPositionProfit([ positionId ], [ targetPrice ])
Returns the total realized plus unrealized profit of a specific position. On spot/margin the result will be in the quote currency. For leverage its in the underlying currency.
Return Type: Number
Calculates the ROI based on used margin and unrealized + realized profits.
GetPositionROI([ positionId ], [ targetPrice ])
Returns the ROI as a percentage.
Return Type: Number
Checks whether or not a position is closed.
IsPositionClosed([ positionId ])
Returns true if position is closed, otherwise false.
Return Type: Boolean
Gets the total amount open in a long position.
LongAmount([ market ])
Returns the total amount open in a long position.
Return Type: Number
Gets all the information from the open bot position.
PositionContainer([ positionId ])
Returns an array with position information.
Return Type: Dynamic
Gets the total amount open in a short position.
ShortAmount([ market ])
Returns the total amount open in a short position.
Return Type: Number
Parameter Name
Parameter Type
Required
Suggested
price
Number
True
Number, UserPositionContainer
amount
Number
True
Number, UserPositionContainer
positionId
String
False
NewGuid, Text, Load
Parameter Name
Parameter Type
Required
Suggested
price
Number
True
Number, UserPositionContainer
positionId
String
False
NewGuid, Text, Load
Parameter Name
Parameter Type
Required
Suggested
direction
Enum
True
PositionLong, PositionShort
price
Number
True
Number, UserPositionContainer
amount
Number
True
Number, UserPositionContainer, MaxExitLongAmount, MaxExitShortAmount
market
String
False
InputAccountMarket, InputMarket, InputPriceSourceMarket, PriceMarket
leverage
Number
False
Input, Number, Leverage
positionId
String
False
NewGuid, Text, Load
Parameter Name
Parameter Type
Required
Suggested
positionId
String
False
Load
Parameter Name
Parameter Type
Required
Suggested
positionId
String
False
Load
Parameter Name
Parameter Type
Required
Suggested
positionId
String
False
Load
Parameter Name
Parameter Type
Required
Suggested
positionId
String
False
Load
Parameter Name
Parameter Type
Required
Suggested
positionId
String
False
Load
targetPrice
Number
False
BuyPrices, SellPrices, OpenPrices, HighPrices, LowPrices, ClosePrices, HLPrices, HLCPrices, OCPrices, OHLCPrices
Parameter Name
Parameter Type
Required
Suggested
positionId
String
False
Load
targetPrice
Number
False
BuyPrices, SellPrices, OpenPrices, HighPrices, LowPrices, ClosePrices, HLPrices, HLCPrices, OCPrices, OHLCPrices
Parameter Name
Parameter Type
Required
Suggested
positionId
String
False
Load
Parameter Name
Parameter Type
Required
Suggested
market
String
False
InputAccountMarket, InputMarket, InputPriceSourceMarket, PriceMarket
Parameter Name
Parameter Type
Required
Suggested
positionId
String
False
Load
Parameter Name
Parameter Type
Required
Suggested
market
String
False
InputAccountMarket, InputMarket, InputPriceSourceMarket, PriceMarket