Profit Information
GetBotProfit
Gets the total realized profit from all open and closed positions.
GetBotProfit([ market ])
Return total realized profit. On spot/margin the result will be in the quote currency. For leverage its in the underlying currency.
Return Type: Number
Parameter Name | Parameter Type | Required | Suggested |
market | String | False | InputAccount, InputAccountMarket, InputMarket, AccountGuid |
GetBotROI
Gets the return on investment. The ROI is calculated by dividing the total realized profits by the average position size.
GetBotROI([ market ])
Return the ROI percentage.
Return Type: Number
Parameter Name | Parameter Type | Required | Suggested |
market | String | False | InputAccount, InputAccountMarket, InputMarket, AccountGuid |
GetCurrentProfit
Gets unrealized plus realized profits of the current open position. Optional parameters fall back to main bot settings. The accountId parameter can take a positionId as well.
GetCurrentProfit([ direction ], [ market ])
Returns the total profit. On spot/margin the result will be in the quote currency. For leverage its in the underlying currency.
Return Type: Number
Parameter Name | Parameter Type | Required | Suggested |
direction | Enum | False | PositionLong, PositionShort, NoPosition |
market | String | False | InputAccount, InputAccountMarket, InputMarket, AccountGuid |
GetCurrentROI
Gets the return on investment percentage based on the total cost/margin used of the open positions. Optional parameters fall back to main bot settings. The accountId parameter can take a positionId as well.
GetCurrentROI([ direction ], [ market ])
Returns the ROI percentage.
Return Type: Number
Parameter Name | Parameter Type | Required | Suggested |
direction | Enum | False | PositionLong, PositionShort, NoPosition |
market | String | False | InputAccount, InputAccountMarket, InputMarket, AccountGuid |
Last updated