HaasOnline TradeServer

https://help.haasonline.com
Admin
HaasOnline TradeServer is a comprehensive automated trading platform that enables cryptocurrency...
Tokens:121,787
Snippets:1,347
Trust Score:9.9
Update:6 months ago
Show doc for...
Tokens:
Raw
### Install Flask for API

Source: https://help.haasonline.com/enterprise-edition/configuration-1/machine-learning/custom-machine-learning

Install the Flask framework to create a web API for your machine learning model. Run this command in your terminal.

```bash
pip install Flask

```

--------------------------------

### Install Python ML Libraries

Source: https://help.haasonline.com/enterprise-edition/configuration-1/machine-learning/custom-machine-learning

Install necessary Python libraries for data manipulation, machine learning, and model serialization. Run this command in your terminal.

```bash
pip install pandas scikit-learn joblib

```

--------------------------------

### Place Buy Order and Get Position Profit

Source: https://help.haasonline.com/haasscript/tutorials/usage/unmanaged-trading

Executes a buy order and then retrieves the profit of the current position. This example uses an auto-generated position ID.

```HaasScript
orderId = PlaceBuyOrder(price, amount)
profit = GetPositionProfit()
```

--------------------------------

### GetCommand API

Source: https://help.haasonline.com/haasscript/commands/helpers/miscellaneous

Gets a command by name.

```APIDOC
## GetCommand

### Description
Gets a command by name.

### Syntax
`GetCommand(name)`

### Parameters
#### Path Parameters
- **name** (String) - Required - The name of the command to retrieve.

### Response
Returns the command.
Return type: **Dynamic**
```

--------------------------------

### Leverage

Source: https://help.haasonline.com/haasscript/commands/input-data/script-settings

Gets the main account leverage setting.

```APIDOC
## Leverage

### Description
Gets the main account leverage setting.

### Method
GET

### Endpoint
/api/script/settings/leverage

### Returns
- **Number** - The leverage setting.
```

--------------------------------

### Direct Property Access Example (Problematic)

Source: https://help.haasonline.com/haasscript/tutorials/usage/script-editor/classes

Illustrates how direct access to public properties in a Lua class can lead to unexpected behavior, as changes to these properties do not affect the internal state used by methods.

```lua
local myCalc = Calculator(1, 2)

Log( myCalc.Value1 ) -- Outputs 1, since input1 got the number 1
Log( myCalc.Value2 ) -- Outputs 2, since input2 got the number 2

Log( myCalc.Calculate() ) -- Outputs 3

-- Change the values
myCalc.Value1 = 10
mycalc.Value2 = 20

Log( myCalc.Value1 ) -- Outputs 10
Log( myCalc.Value2 ) -- Outputs 20

Log( myCalc.Calculate() ) -- Outputs 3, since internal values are still 1 and 2
```

--------------------------------

### AccountGuid

Source: https://help.haasonline.com/haasscript/commands/input-data/script-settings

Gets the main account guid of the bot.

```APIDOC
## AccountGuid

### Description
Gets the main account guid of the bot.

### Method
GET

### Endpoint
/api/script/settings/accountguid

### Returns
- **String** - The account GUID.
```

--------------------------------

### License Key Configuration

Source: https://help.haasonline.com/enterprise-edition/configuration/license-key

Set up your email and license key in the settings.env file. Ensure these fields are correctly populated for license validation.

```env
# --------------------------------------
# License key setup
# --------------------------------------
EMAIL = 
LICENSEKEY = 

```

--------------------------------

### Configure settings.env file

Source: https://help.haasonline.com/enterprise-edition/configuration/login-credentials

Update the EMAIL, LICENSEKEY, USERNAME, and PASSWORD fields within the settings.env file to configure your instance.

```text
# --------------------------------------
# License key setup
# --------------------------------------
EMAIL = 
LICENSEKEY = 


# --------------------------------------
# Login credentials setup
# --------------------------------------
USERNAME = 
PASSWORD =
```

--------------------------------

### Place a Buy Order

Source: https://help.haasonline.com/haasscript/tutorials/usage/unmanaged-trading

Demonstrates placing a buy order by checking for an existing order ID and executing a trade if none exists.

```lua
orderId = Load('orderId', '') -- Load the orderId, if any

if (orderId == '') then
  price = CurrentPrice().close
  amount = TradeAmount()

  orderId = PlaceBuyOrder(price,amount)
else
  -- Do something else
end

Save('orderId', orderId) 
```

--------------------------------

### HeikinOpenPrices

Source: https://help.haasonline.com/haasscript/commands/prices

Gets the Heikin-Ashi open prices.

```APIDOC
## HeikinOpenPrices

### Description
Gets the Heikin-Ashi open prices.

### Method
GET

### Endpoint
/websites/help_haasonline/HeikinOpenPrices

### Parameters
#### Query Parameters
- **interval** (Number) - Optional - InputInterval, Number, CurrentInterval
- **fullCandles** (Boolean) - Optional - True, False
- **market** (String) - Optional - InputAccountMarket, InputMarket, InputPriceSourceMarket, PriceMarket

### Response
#### Success Response (200)
- **ListNumbers** (ListNumbers) - A list of Heikin-Ashi open prices.
```

--------------------------------

### GetOrderbook

Source: https://help.haasonline.com/haasscript/commands/input-data/price-market-information

Gets the orderbook on a specific market.

```APIDOC
## GetOrderbook

### Description
Gets the orderbook on a specific market.

### Parameters
#### Query Parameters
- **market** (String) - Optional - InputAccountMarket, InputMarket, InputPriceSourceMarket, PriceMarket

### Response
- **Return Type** (ListNumbers) - A collection with 4 arrays.
```

--------------------------------

### Configure settings.env file

Source: https://help.haasonline.com/enterprise-edition/configuration

The settings.env file is used to define core server parameters including license keys, login credentials, and network hosting configurations.

```text
# --------------------------------------
# License key setup
# --------------------------------------
EMAIL = 
LICENSEKEY = 


# --------------------------------------
# Login credentials setup
# --------------------------------------
USERNAME = 
PASSWORD =
2FA_SECRET =

# --------------------------------------
# Local API
#
# To enable the local API, enter your password secret key here
# --------------------------------------
LOCALAPI_SECRET =

# --------------------------------------
# Startup settings, set to "false" when starting as a service
# --------------------------------------
OPEN_INTERFACE = true


# --------------------------------------
# REST (API) Server Settings
# --------------------------------------
SERVER_PROTOCOL = http
SERVER_HOST = 127.0.0.1
SERVER_PORT = 8090

EXTERNAL_SERVER_PROTOCOL = http
EXTERNAL_SERVER_HOST = 127.0.0.1
EXTERNAL_SERVER_PORT = 8090

# --------------------------------------
# Socket Server Settings
# --------------------------------------
SOCKET_HOST = 127.0.0.1
SOCKET_PORT = 8092

EXTERNAL_SOCKET_HOST = 127.0.0.1
EXTERNAL_SOCKET_PORT = 8092

# --------------------------------------
# Reverse Proxy Mode
# --------------------------------------
REVERSE_PROXY_MODE = false
```

--------------------------------

### Create Dataset with HaasScript

Source: https://help.haasonline.com/enterprise-edition/configuration-1/machine-learning/custom-machine-learning

Use this HaasScript to generate a dataset with price, RSI, and a trading signal. Ensure the script is run and the data is exported as CSV.

```HaasScript
local fileName = "Performance";

InitExportData(fileName, "Timestamp", "Price", "RSI", "Signal")

local rsi = RSI(ClosePrices(), 12)
local signal = SignalNone

if (rsi[1] > 80) then
  signal = SignalSell
end

if (rsi[1] < 20) then
  signal = SignalBuy
end

WriteExportData(fileName, Time(), ClosePrices(), rsi, signal)

```

--------------------------------

### GetLastTrades

Source: https://help.haasonline.com/haasscript/commands/input-data/price-market-information

Gets a list of the last trades.

```APIDOC
## GetLastTrades

### Description
Gets a list of the last trades.

### Parameters
#### Query Parameters
- **depth** (Number) - Optional - Input, Number, SessionGet
- **market** (String) - Optional - InputAccountMarket, InputMarket, InputPriceSourceMarket, PriceMarket

### Response
- **Return Type** (ListNumbers) - Array format: [[price, amount, isBuy?, unix], ... ]
```

--------------------------------

### Create a Basic RSI Scripted Bot

Source: https://help.haasonline.com/haasscript/tutorials/bot-building/scripted-bot-building

Defines input fields, calculates RSI based on close prices, plots the indicator, and executes buy/sell orders based on threshold levels.

```lua
-- Input fields
local period = Input('Period', 14)
local buyLevel = Input('Buy level', 30)
local sellLevel = Input('Sell level', 70)

-- Getting required data
local cp = ClosePrices()

-- Calculations
local rsi = RSI(cp, period)

-- Plotting
Plot(1, 'RSI', rsi, SkyBlue)

-- Trading logic
if rsi > sellLevel then
  DoSell()
end

if rsi < buyLevel then
  DoBuy()
end
```

--------------------------------

### Create a Static Object

Source: https://help.haasonline.com/haasscript/tutorials/usage/script-editor/classes

Demonstrates the creation of a static object in HaasScript, which is a collection of data fields and functions. This object cannot be instantiated multiple times.

```HaasScript
local object = {}

```

```HaasScript
local Person = {
    Name = "Some Old Guy",
    Age = 50,
    SayHello = function(name)
        return name..' says hello!'
    end
}

Log(Person.SayHello( Person.Name )) -- Outputs 'Some Old Guy says hello!'

```

--------------------------------

### TradeAmount

Source: https://help.haasonline.com/haasscript/commands/input-data/script-settings

Gets the trade amount setting.

```APIDOC
## TradeAmount

### Description
Gets the trade amount setting.

### Method
GET

### Endpoint
/api/script/settings/tradeamount

### Returns
- **Number** - The trade amount.
```

--------------------------------

### PriceMarket

Source: https://help.haasonline.com/haasscript/commands/input-data/script-settings

Gets the main market of the bot.

```APIDOC
## PriceMarket

### Description
Gets the main market of the bot.

### Method
GET

### Endpoint
/api/script/settings/pricemarket

### Returns
- **String** - A market string (e.g., `BITFINEX_BTC_USD_` or `BITMEX_XBT_USD_XBTUSD`).
```

--------------------------------

### GetRemoteSignal

Source: https://help.haasonline.com/haasscript/commands/helpers/signal-helpers

Gets the remote signal which is published by SaveRemoteSignal().

```APIDOC
## GetRemoteSignal

### Description
Gets the remote signal which is published by SaveRemoteSignal().

### Parameters
#### Request Body
- **id** (String) - Required - The identifier for the remote signal.
```

--------------------------------

### EasyDynamicLongShortLevels

Source: https://help.haasonline.com/haasscript/commands/trade-bots/easy-indicators

Automatically defines input fields, calculates DynamicBuySellLevel, plots the chart, and returns a signal based on dynamic short/long levels.

```APIDOC
## EasyDynamicLongShortLevels

### Description
Automatically defines the input fields, calculates the DynamicBuySellLevel, plots the chart and returns the signal.

### Syntax
`EasyDynamicLongShortLevels(chartIndex, [ name ], [ interval ])`

### Returns
A signal based on dynamic short/long level.
Return type: **Enum**

### Parameters
#### Path Parameters
- **chartIndex** (Number) - Required - The index of the chart.
- **name** (String) - Optional - The name of the indicator.
- **interval** (Number) - Optional - The interval for the indicator. Suggestions: InputInterval, Number, CurrentInterval.
```

--------------------------------

### DoSell Command

Source: https://help.haasonline.com/haasscript/commands/trading/managed-trade-commands

Generates a sell signal on spot or a short signal on margin & leverage.

```APIDOC
## DoSell

### Description
Generates a sell signal on spot or a short signal on margin & leverage.

### Syntax
`DoSell([ note ], [ count ])`

### Parameters
#### Path Parameters
- **note** (String) - Optional - Text, Input, SessionGet, Load
- **count** (Number) - Optional

### Return Type
Void
```

--------------------------------

### CurrentPrice

Source: https://help.haasonline.com/haasscript/commands/prices

Gets all the price data from the current candle.

```APIDOC
## CurrentPrice

### Description
Gets all the price data from the current candle.

### Parameters
#### Query Parameters
- **market** (String) - Optional - InputAccountMarket, InputMarket, InputPriceSourceMarket, PriceMarket

### Response
- **Return Type** (Dynamic) - The price data in an array.
```

--------------------------------

### EasyAlice

Source: https://help.haasonline.com/haasscript/commands/trade-bots/easy-indicators

Calculates the Alice signal based on the Haasonline Intelli Alice bot.

```APIDOC
## EasyAlice

### Description
Automatically defines the input fields, calculates the Alice signal based on the Haasonline Intelli Alice bot.

### Parameters
#### Path Parameters
- **interval** (Number) - Optional - Time interval

### Response
- **Return type** (Enum) - Signal based on the Intelli-Bot Alice
```

--------------------------------

### Offset

Source: https://help.haasonline.com/haasscript/commands/helpers/array-helpers

Gets an offset amount of the given array.

```APIDOC
## Offset

### Description
Returns the given array with the offset amount of data removed from it.

### Parameters
#### Path Parameters
- **input** (Dynamic) - Required - The source array.
- **offset** (Number) - Required - The amount of data to remove.
```

--------------------------------

### GetOrderbookBid

Source: https://help.haasonline.com/haasscript/commands/input-data/price-market-information

Gets a list of the orderbook bid records.

```APIDOC
## GetOrderbookBid

### Description
Gets a list of the orderbook bid records.

### Parameters
#### Query Parameters
- **market** (String) - Optional - InputAccountMarket, InputMarket, InputPriceSourceMarket, PriceMarket

### Response
- **Return Type** (Dynamic) - Array of bid prices and order sizes: [[price, amount], [price, amount] ...].
```

--------------------------------

### DoBuy Command

Source: https://help.haasonline.com/haasscript/commands/trading/managed-trade-commands

Generates a buy signal on spot or a long signal on margin & leverage.

```APIDOC
## DoBuy

### Description
Generates a buy signal on spot or a long signal on margin & leverage.

### Syntax
`DoBuy([ note ], [ count ])`

### Parameters
#### Path Parameters
- **note** (String) - Optional - Text, Input, SessionGet, Load
- **count** (Number) - Optional

### Return Type
Void
```

--------------------------------

### InputSignalManagement

Source: https://help.haasonline.com/haasscript/commands/input-data/input-fields

Creates multiple dropdown options for signal management and mapping.

```APIDOC
## InputSignalManagement

### Description
Creates multiple dropdown options for signal management and mapping.

### Syntax
`InputSignalManagement(label, signal, [ tooltip ], [ group ])`

### Parameters
#### Path Parameters
- **label** (String) - Required - The label for the signal management dropdown.
- **signal** (Enum) - Required - The signal type. Suggestions: InputSignalTypes,IndicatorSignalCross,IndicatorCenterCross,SignalCenterCross,BothCenterCross,IndicatorThreshold,SignalThreshold,BothThreshold.
- **tooltip** (String) - Optional - The tooltip text for the dropdown.
- **group** (String) - Optional - The group the dropdown belongs to.

### Returns
Returns the baked signal based on settings as an Enum.
```

--------------------------------

### GetOrderbookAsk

Source: https://help.haasonline.com/haasscript/commands/input-data/price-market-information

Gets a list of the orderbook ask records.

```APIDOC
## GetOrderbookAsk

### Description
Gets a list of the orderbook ask records.

### Parameters
#### Query Parameters
- **market** (String) - Optional - InputAccountMarket, InputMarket, InputPriceSourceMarket, PriceMarket

### Response
- **Return Type** (Dynamic) - Array of bid prices and order sizes: [[price, amount], [price, amount] ...].
```

--------------------------------

### Optimize custom commands with DefineIntervalOptimization

Source: https://help.haasonline.com/haasscript/tutorials/usage/haasscript/optimizations

Increases backtest speed for custom commands by restricting execution to specific intervals.

```HaasScript
local interval = DefineParameter(NumberType, 'interval', 'The interval of the command', true, 1)
DefineIntervalOptimization(interval)
```

```HaasScript
local source = DefineParameter(ListNumberType, 'source', 'Source data for the command', true, ClosePrices())
local interval = CurrentInterval(source)
DefineIntervalOptimization(interval)
```

--------------------------------

### GetType API

Source: https://help.haasonline.com/haasscript/commands/helpers/miscellaneous

Gets the data type of the input.

```APIDOC
## GetType

### Description
Gets the data type of the input.

### Syntax
`GetType(value)`

### Parameters
#### Path Parameters
- **value** (Dynamic) - Required - The input value to check the data type of.

### Response
Returns the data type.
Return type: **Enum**
```

--------------------------------

### Configure settings.env for Hosting

Source: https://help.haasonline.com/enterprise-edition/configuration/hosting

Modify these fields in settings.env to update the REST and socket server host and port configurations for remote access.

```text
# --------------------------------------
# REST (API) Server Settings
# --------------------------------------
SERVER_PROTOCOL = http
SERVER_HOST = 127.0.0.1
SERVER_PORT = 8090

EXTERNAL_SERVER_PROTOCOL = http
EXTERNAL_SERVER_HOST = 127.0.0.1
EXTERNAL_SERVER_PORT = 8090

# --------------------------------------
# Socket Server Settings
# --------------------------------------
SOCKET_HOST = 127.0.0.1
SOCKET_PORT = 8092

EXTERNAL_SOCKET_HOST = 127.0.0.1
EXTERNAL_SOCKET_PORT = 8092
```

--------------------------------

### LineOptions

Source: https://help.haasonline.com/haasscript/commands/charting

Creates a configuration object for chart lines.

```APIDOC
## LineOptions

### Description
Creates a line options object to be used for Plot().

### Parameters
- **color** (String) - Optional - Line color.
- **style** (Enum) - Optional - Line style.
- **deco** (Enum) - Optional - Line decoration.
- **width** (Number) - Optional - Line width.
- **offset** (Number) - Optional - Line offset.
- **side** (Enum) - Optional - Axis side.
- **id** (String) - Optional - Line ID.
- **behind** (Boolean) - Optional - Draw behind.
- **ignoreOnAxis** (Boolean) - Optional - Ignore on axis.
- **drawTrailingLine** (Boolean) - Optional - Draw trailing line.
```

--------------------------------

### GetWebHookSignal

Source: https://help.haasonline.com/haasscript/commands/helpers/signal-helpers

Gets the latest WebHook signal of a specific key.

```APIDOC
## GetWebHookSignal

### Description
Gets the latest signal object stored by an incoming WebHook. Note: Once processed, the signal is removed.

### Parameters
#### Request Body
- **id** (String) - Required - The unique key for the webhook signal.

### Response
#### Success Response (200)
- **webhook_received_at** (Number) - Unix timestamp of receipt.
- **[user-defined]** (Dynamic) - Custom fields from the webhook payload.
```

--------------------------------

### Configure Local SSH Client

Source: https://help.haasonline.com/enterprise-edition/configuration/hosting/linux-vps-hosting

Update your local SSH client configuration to use the generated private key for connecting to the server. Replace 'the.ip.address.of.server' and 'my_ssh_username' with your actual server details.

```bash
Host the.ip.address.of.server
  User my_ssh_username
  IdentityFile ~/.ssh/haasonline_ent_id_rsa # Or update this path to where you saved it on your local machine.

```

--------------------------------

### Count

Source: https://help.haasonline.com/haasscript/commands/helpers/array-helpers

Gets the length of an array or the number of occurrences of a value.

```APIDOC
## Count

### Description
Gets the length of an array or the number of occurrences within the array of a specific value.

### Parameters
#### Path Parameters
- **input** (Dynamic) - Required - The array to count.
- **value** (Dynamic) - Optional - The specific value to count occurrences of.
```

--------------------------------

### DoShort Command

Source: https://help.haasonline.com/haasscript/commands/trading/managed-trade-commands

Generates a sell signal on spot or a short signal on margin & leverage.

```APIDOC
## DoShort

### Description
Generates a sell signal on spot or a short signal on margin & leverage.

### Syntax
`DoShort([ note ], [ count ])`

### Parameters
#### Path Parameters
- **note** (String) - Optional - Text, Input, SessionGet, Load
- **count** (Number) - Optional

### Return Type
Void
```

--------------------------------

### GetLeverage

Source: https://help.haasonline.com/haasscript/commands/input-data/bot-settings

Gets the set leverage for current or specified market.

```APIDOC
## GetLeverage

### Description
Gets the set leverage for current or specified market.

### Parameters
#### Request Body
- **market** (String) - Optional - InputAccountMarket,InputMarket,InputPriceSourceMarket,PriceMarket
- **accountId** (String) - Optional - InputAccount,InputAccountMarket,InputMarket,AccountGuid

### Response
#### Success Response (200)
- **Number** - Returns the leverage value or -1 if request failed.
```

--------------------------------

### ArrayLast API

Source: https://help.haasonline.com/haasscript/commands/helpers/array-helpers

Gets the last value of the array with an optional offset.

```APIDOC
## ArrayLast

### Description
Gets the last value of the array with an optional offset.

### Syntax
`ArrayLast(input, [ offset ])`

### Parameters
#### Path Parameters
- **input** (Dynamic) - Required - The array to retrieve the last value from.
- **offset** (Number) - Optional - An offset to apply from the end of the array.

### Return Type
Dynamic

### Response Example
(Returns the last value of the array)
```

--------------------------------

### Retrieve Position Prices

Source: https://help.haasonline.com/haasscript/tutorials/usage/unmanaged-trading

Use these functions to log or access various entry and exit price metrics for positions.

```lua
Log(AverageEnterPrice(positionid)) -- Average entry price
Log(AverageExitPrice(positionIa)) -- Average exit price
Log(LastExitLongPrice()) -- Last long exit price
Log(LastExitShortPrice()) -- Last short exit price
Log(LastLongPrice() -- Last long entry price
Log(LastShortPrice()) -- Last short entry price
Log(LastNoPositionPrice()) -- Last long/short exit price
```

--------------------------------

### Fee

Source: https://help.haasonline.com/haasscript/commands/input-data/script-settings

Gets the current fee percentage of the main or specific market.

```APIDOC
## Fee

### Description
Gets the current fee percentage of the main or specific market.

### Method
GET

### Endpoint
/api/script/settings/fee

### Query Parameters
- **market** (String) - Optional - Specifies the market for which to retrieve the fee percentage. Suggestions: InputAccount, InputAccountMarket, InputMarket, AccountGuid.

### Returns
- **Number** - The fee percentage.
```

--------------------------------

### Check Order Status and Completion

Source: https://help.haasonline.com/haasscript/tutorials/usage/haasscript/order-handling

Demonstrates checking if an order is open and subsequently verifying if it has been filled.

```Lua
if not IsOrderOpen(orderId) then
    if IsOrderFilled(orderId) then
        -- Order is filled
    else
        -- Order is cancelled/rejected
    end
end
```

--------------------------------

### EasyBBANDSW

Source: https://help.haasonline.com/haasscript/commands/trade-bots/easy-indicators

Calculates Bollinger Bands %W and returns a signal.

```APIDOC
## EasyBBANDSW

### Description
Automatically defines the input fields, calculates the BBANDS %W, plots the chart and returns the signal.

### Parameters
#### Path Parameters
- **chartIndex** (Number) - Required - Index of the chart
- **name** (String) - Optional - Name of the indicator
- **interval** (Number) - Optional - Time interval

### Response
- **Return type** (Enum) - Signal based on GetBuySellLevelSignal() template
```

--------------------------------

### PlotStackedArea

Source: https://help.haasonline.com/haasscript/commands/charting

Creates a stacked area chart from a line guid collection.

```APIDOC
## PlotStackedArea

### Description
Creates a stacked area chart from a line guid collection.

### Parameters
#### Parameters
- **lineGuids** (Dynamic) - Required - Plot

### Response
- **Return Type** (Void)
```

--------------------------------

### NeverExitWithLoss

Source: https://help.haasonline.com/haasscript/commands/trade-bots/easy-insurances

Compares the average enter price to the targetPrice or current price to prevent loss.

```APIDOC
## NeverExitWithLoss

### Description
Compares the average enter price to the targetPrice or current price.

### Parameters
#### Request Body
- **acceptedLoss** (Number) - Optional - Input,Number,SessionGet
- **targetPrice** (Number) - Optional - Input,Number,SessionGet
- **positionId** (String) - Optional - Load

### Response
- **Return Type** (Boolean) - Returns true if the trade is allowed.
```

--------------------------------

### ShortAmount

Source: https://help.haasonline.com/haasscript/commands/trading/position-information

Gets the total amount open in a short position for a given market.

```APIDOC
## ShortAmount

### Description
Gets the total amount open in a short position.

### Syntax
`ShortAmount([ market ])`

### Parameters
- **market** (String) - Optional - The market identifier.

### Response
- **Return Type** (Number) - The total amount open in a short position.
```

--------------------------------

### LongAmount

Source: https://help.haasonline.com/haasscript/commands/trading/position-information

Gets the total amount open in a long position for a given market.

```APIDOC
## LongAmount

### Description
Gets the total amount open in a long position.

### Syntax
`LongAmount([ market ])`

### Parameters
- **market** (String) - Optional - The market identifier.

### Response
- **Return Type** (Number) - The total amount open in a long position.
```

--------------------------------

### DoExitPosition Command

Source: https://help.haasonline.com/haasscript/commands/trading/managed-trade-commands

Sends out a sell signal on spot or an exit positions signal on margin & leverage.

```APIDOC
## DoExitPosition

### Description
Sends out a sell signal on spot or an exit positions signal on margin & leverage.

### Syntax
`DoExitPosition([ note ], [ count ])`

### Parameters
#### Path Parameters
- **note** (String) - Optional - Text, Input, SessionGet, Load
- **count** (Number) - Optional

### Return Type
Void
```

--------------------------------

### CurrentInterval

Source: https://help.haasonline.com/haasscript/commands/input-data/script-settings

Gets the default interval selected by the user or returns the interval of a price source.

```APIDOC
## CurrentInterval

### Description
Gets the default interval selected by the user or returns the interval of a price source.

### Method
GET

### Endpoint
/api/script/settings/currentinterval

### Query Parameters
- **sources** (DynamicParams) - Optional - Specifies the price sources to consider for the interval.

### Returns
- **Number** - The interval in minutes.
```

--------------------------------

### EasyIMI

Source: https://help.haasonline.com/haasscript/commands/trade-bots/easy-indicators

Automatically defines input fields, calculates IMI, plots the chart, and returns a signal based on IMI, its MA, and selected signal type.

```APIDOC
## EasyIMI

### Description
Automatically defines the input fields, calculates the IMI, plots the chart and returns the signal.

### Syntax
`EasyIMI(chartIndex, [ name ], [ interval ])`

### Returns
A signal based on IMI, it's MA and selected signal type.
Return type: **Enum**

### Parameters
#### Path Parameters
- **chartIndex** (Number) - Required - The index of the chart.
- **name** (String) - Optional - The name of the indicator.
- **interval** (Number) - Optional - The interval for the indicator. Suggestions: InputInterval, Number, CurrentInterval.
```

--------------------------------

### ArrayIndex API

Source: https://help.haasonline.com/haasscript/commands/helpers/array-helpers

Gets the value at a specific index in the array. Negative indices count from the end.

```APIDOC
## ArrayIndex

### Description
Gets the value on a specific index. A negative index will take from the end of the array.

### Syntax
`ArrayIndex(input, index)`

### Parameters
#### Path Parameters
- **input** (Dynamic) - Required - The array to retrieve the value from.
- **index** (Number) - Required - The index of the value to retrieve. Can be negative to count from the end.

### Return Type
Dynamic

### Response Example
(Returns the value at the specified index)
```

--------------------------------

### Configure SSH Authorized Keys

Source: https://help.haasonline.com/enterprise-edition/configuration/hosting/linux-vps-hosting

After generating keys, set up the authorized_keys file and copy your public key into it. This allows passwordless SSH login. Permissions are set to restrict access.

```bash
touch ~/.ssh/authorized_keys
chmod -R go= ~/.ssh
cat ~/.ssh/haasonline_ent_id_rsa.pub >> ~/.ssh/authorized_keys

```

--------------------------------

### ArrayGet API

Source: https://help.haasonline.com/haasscript/commands/helpers/array-helpers

Gets the value at a specific index in the array. Negative indices count from the end.

```APIDOC
## ArrayGet

### Description
Gets the value on a specific index. A negative index will take from the end of the array.

### Syntax
`ArrayGet(input, index)`

### Parameters
#### Path Parameters
- **input** (Dynamic) - Required - The array to retrieve the value from.
- **index** (Number) - Required - The index of the value to retrieve. Can be negative to count from the end.

### Return Type
Dynamic

### Response Example
(Returns the value at the specified index)
```

--------------------------------

### EasyCMO

Source: https://help.haasonline.com/haasscript/commands/trade-bots/easy-indicators

Automatically defines input fields, calculates the Chande Momentum Oscillator (CMO), plots the chart, and returns a signal.

```APIDOC
## EasyCMO

### Description
Automatically defines the input fields, calculates the CMO, plots the chart and returns the signal.

### Syntax
`EasyCMO(chartIndex, [ name ], [ interval ])`

### Returns
A signal based on CMO, its MA and selected signal type. Return type: Enum.

### Parameters
#### Path Parameters
- **chartIndex** (Number) - Required - The index of the chart.
- **name** (String) - Optional - The name for the indicator.
- **interval** (Number) - Optional - The interval for the indicator. Suggestions: InputInterval, Number, CurrentInterval.
```

--------------------------------

### Produce a Signal via Webhook

Source: https://help.haasonline.com/usage/remote-signals

Trigger a signal externally by making a GET request to the provided API endpoint.

```HTTP
https://cloud.haasonlineapi.com/SignalAPI.php?channel=STORE_SIGNAL&id=&secret=&signal=
```

--------------------------------

### SourcePrices API

Source: https://help.haasonline.com/haasscript/commands/prices

Gets the price source based on the input enum given. Can be any of Enumerations Source Price Types.

```APIDOC
## SourcePrices

### Description
Gets the price source based on the input enum given. Can be any of Enumerations Source Price Types.

### Method
GET

### Endpoint
/api/prices/source

### Parameters
#### Query Parameters
- **sourceType** (Enum) - Required - The type of price source (e.g., ClosePriceSourceType, OpenPriceSourceType).
- **interval** (Number) - Optional - Specifies the time interval for the prices.
- **fullCandles** (Boolean) - Optional - If true, returns data for full candles.
- **market** (String) - Optional - Specifies the market for which to retrieve prices.
- **hlcStyle** (Boolean) - Optional - If true, returns data in HLC style.

### Response
#### Success Response (200)
- **data** (ListNumbers) - A collection of prices.
```

--------------------------------

### EasyDPO

Source: https://help.haasonline.com/haasscript/commands/trade-bots/easy-indicators

Automatically defines input fields, calculates the Detrended Price Oscillator (DPO), plots the chart, and returns a signal.

```APIDOC
## EasyDPO

### Description
Automatically defines the input fields, calculates the DPO, plots the chart and returns the signal.

### Syntax
`EasyDPO(chartIndex, [ name ], [ interval ])`

### Returns
A signal based on DPO, its MA and selected signal type. Return type: Enum.

### Parameters
#### Path Parameters
- **chartIndex** (Number) - Required - The index of the chart.
- **name** (String) - Optional - The name for the indicator.
- **interval** (Number) - Optional - The interval for the indicator. Suggestions: InputInterval, Number, CurrentInterval.
```

--------------------------------

### Get Order Cancelled Amount

Source: https://help.haasonline.com/haasscript/tutorials/usage/unmanaged-trading

Retrieves the amount of an order that was left unfilled when it was cancelled. This is useful for calculating remaining tradeable amounts.

```HaasScript
tradeAmount = Input('Amount per order', 1)
orderId = Load('orderId', '') -- Load the orderId, if any

if (orderId == '') then
  -- Do something else
else
  cancelledAmount = GetOrderCancelledAmount(orderId)
  filledAmount = tradeAmount - cancelledAmount
end
```

--------------------------------

### EasyCCI

Source: https://help.haasonline.com/haasscript/commands/trade-bots/easy-indicators

Automatically defines input fields, calculates the Commodity Channel Index (CCI), plots the chart, and returns a signal.

```APIDOC
## EasyCCI

### Description
Automatically defines the input fields, calculates the CCI, plots the chart and returns the signal.

### Syntax
`EasyCCI(chartIndex, [ name ], [ interval ])`

### Returns
A signal based on CCI, its MA and selected signal type. Return type: Enum.

### Parameters
#### Path Parameters
- **chartIndex** (Number) - Required - The index of the chart.
- **name** (String) - Optional - The name for the indicator.
- **interval** (Number) - Optional - The interval for the indicator. Suggestions: InputInterval, Number, CurrentInterval.
```

--------------------------------

### Get Order Filled Amount

Source: https://help.haasonline.com/haasscript/tutorials/usage/unmanaged-trading

Retrieves the amount of an order that has been successfully filled. This value can be compared to the total trade amount to determine the remaining balance.

```HaasScript
tradeAmount = Input('Amount per order', 1)
orderId = Load('orderId', '') -- Load the orderId, if any

if (orderId == '') then
  -- Do something else
else
  filledAmount = GetOrderFilledAmount(orderId)
  amountLeft = tradeAmount - filledAmount
end
```

--------------------------------

### Get All Open Orders

Source: https://help.haasonline.com/haasscript/tutorials/usage/unmanaged-trading

Retrieves a collection of all open orders executed by the bot. Access individual order properties such as price, filled amount, and cancellation status.

```HaasScript
openOrders = GetAllOpenOrders()

order = openOrders[1]

price = order.price
filledAmount = order.filledAmount
isCancelled = order.isCancelled
```

--------------------------------

### InputPriceSource

Source: https://help.haasonline.com/haasscript/commands/input-data/input-fields

Creates a price source dropdown.

```APIDOC
## InputPriceSource

### Description
Creates a price source dropdown.

### Syntax
`InputPriceSource(label, [ defaultValue ], [ tooltip ], [ group ])`

### Parameters
#### Path Parameters
- **label** (String) - Required - The label for the price source dropdown.
- **defaultValue** (String) - Optional - The default selected price source.
- **tooltip** (String) - Optional - The tooltip text for the dropdown.
- **group** (String) - Optional - The group the dropdown belongs to.

### Returns
Returns the selected price source as a String. For example BITSTAMP.
```

--------------------------------

### DeactivateAfterXIdleMinutes

Source: https://help.haasonline.com/haasscript/commands/trade-bots/easy-safeties

Deactivates the bot if the last completed order was a specified number of minutes ago. The timeout starts after the first completed order. Returns true when the bot has been deactivated.

```APIDOC
## DeactivateAfterXIdleMinutes

### Description
Deactivates the bot if the last completed order is a specified number of minutes in the past. Timeout starts after the first completed order.

### Method
N/A (Function Call)

### Endpoint
N/A (Function Call)

### Parameters
#### Path Parameters
N/A

#### Query Parameters
N/A

#### Request Body
N/A

### Request Example
```
DeactivateAfterXIdleMinutes(minutes)
```

### Response
#### Success Response (Boolean)
- **true** - The bot has been deactivated.

#### Response Example
```
true
```
```

--------------------------------

### EasyBOP

Source: https://help.haasonline.com/haasscript/commands/trade-bots/easy-indicators

Automatically defines input fields, calculates the Balance of Power (BOP), plots the chart, and returns a signal.

```APIDOC
## EasyBOP

### Description
Automatically defines the input fields, calculates the BOP, plots the chart and returns the signal.

### Syntax
`EasyBOP(chartIndex, [ name ], [ interval ])`

### Returns
A signal based on BOP, its MA and selected signal type. Return type: Enum.

### Parameters
#### Path Parameters
- **chartIndex** (Number) - Required - The index of the chart.
- **name** (String) - Optional - The name for the indicator.
- **interval** (Number) - Optional - The interval for the indicator. Suggestions: InputInterval, Number, CurrentInterval.
```

--------------------------------

### Get Order Open Time

Source: https://help.haasonline.com/haasscript/tutorials/usage/unmanaged-trading

Retrieves the time when an order was created, with options to return the value in minutes or seconds. Requires an order ID and a boolean to specify the time unit.

```HaasScript
orderId = Load('orderId', '') -- Load the orderId, if any

if (orderId == '') then
  -- Do something else
else
  timeInMinutes = GetOrderOpenTime(orderId, false)
  timeInSeconds = GetOrderOpenTime(orderId, true)
end
```

--------------------------------

### Configure line properties

Source: https://help.haasonline.com/haasscript/tutorials/usage/haasscript/charting

Define line appearance using an options object or the LineOptions helper function.

```HaasScript
Plot(1, 'BTCUSD', ClosePrices(), {style=Smooth, color=Yellow)
Plot(1, 'BTCUSD', ClosePrices(), LineOptions(Yellow, Smooth))
```

--------------------------------

### Get All Filled Orders

Source: https://help.haasonline.com/haasscript/tutorials/usage/unmanaged-trading

Retrieves a collection of all partially or fully filled orders executed by the bot. Access individual order properties like price, executed amount, and open status.

```HaasScript
filledOrders = GetAllFilledOrders()

latestOrder = filledOrders[1]

price = latestOrder.price
executedAmount = latestOrder.executedAmount
isOpen = latestOrder.isOpen
```
Tokens:
Raw