LogoLogo
Back to HaasOnline.comSwitch to Trade Platform
3.x
3.x
  • Welcome
  • Getting Started
    • Using Local API Server
    • Authentication
    • Response
      • Error Codes
  • HaasScript
    • Using HaasScript
      • HaasScript Facts
      • Charting
      • Order Handling
      • Interval
      • Input Fields
      • Positions Handling
        • Fee correction
      • Position Information
      • Memory Management
      • Optimizations
      • Signal Handling
      • Trading
    • Script Editor
      • Syntax
      • Parameters
      • Interaction
    • Visual Editor
      • Blocks
      • Parameters
      • Flow Control
      • Interaction
    • Custom Commands
    • Tutorials
      • Trade Bot Guide
        • Creating A Trade Bot
          • Visual Editor Guide
          • Script Editor Guide
          • Custom Containers
        • Customizing Indicators
        • Customizing Safeties
        • Customizing Insurances
        • Creating Easy Indicators
      • Unmanaged Trading Guide
        • Executing Orders
        • Managing Orders
        • Managing Positions
        • Managing Wallet
      • Script Editor
        • Classes
        • MadHatter BBands
        • Percentage Price Change
      • Visual Editor
        • Importing Scripts
        • SmoothRSI
        • Scalper Bot
    • Commands
      • Array Helpers
      • Charting
      • Constants
      • Custom Commands Helpers
      • Easy Indicators
      • Easy Insurances
      • Easy Safeties
      • Equations
      • Flow Control
      • Input Fields
      • Input Settings
      • Mathematical
      • Memory Helpers
      • Miscellaneous
      • Order Handling
      • Order Information
      • Position Information
      • Position Prices
      • Price Data
      • Price Market Information
      • Profit Information
      • Settings
      • Signal Helpers
      • String Helpers
      • Technical Analysis
      • Technical Analysis Helpers
      • Time Information
      • Trade Actions (Managed)
      • Trade Actions (Unmanaged)
      • Trade Bot
      • Trade Market Information
      • Wallet
  • API Endpoints
    • Software API
    • Market Data API
    • Account Data API
    • Trade Data API
    • Advanced Order API
    • Trade Bot API
    • Custom Trade Bot API
    • ENUMS
    • Data Objects
  • Examples
    • Script Bots (C#)
      • Scalper Trade Bot
      • Flash Crash Trade Bot
    • Script Indicators (C#)
      • Indicator Script
      • Technical Analysis Library
    • Pshai Scripts (C#)
      • BBands Ext
      • BBands Ext v2
      • Chaikin A/D Line
      • Calibrator
      • Pshai's RVI
    • Scripted Driver
  • Other Resources
    • YouTube
    • Guides & Tutorials
    • Questions & Answers
    • Community Projects
  • Need Help?
    • Ask on Discord
    • Submit Support Ticket
Powered by GitBook
On this page
  • GetBotProfit
  • GetBotROI
  • GetCurrentProfit
  • GetCurrentROI

Was this helpful?

  1. HaasScript
  2. Commands

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

PreviousPrice Market InformationNextSettings

Last updated 4 years ago

Was this helpful?