Array Helpers

ArrayAdd

Adds an element to an existing array.
  • ArrayAdd(input, element)
Returns the input array.
Return Type: Dynamic
Parameter Name
Parameter Type
Required
Suggested
input
Dynamic
True
-
element
Dynamic
True
-

ArrayAny

Returns true if the array contains any element or an element matches a specific value.
  • ArrayAny(input, [ value ])
Returns true if.
Return Type: Boolean
Parameter Name
Parameter Type
Required
Suggested
input
Dynamic
True
-
value
Dynamic
False
-

ArrayConcat

Concatenates two arrays.
  • ArrayConcat(array1, array2)
Returns the concatenated array.
Return Type: Dynamic
Parameter Name
Parameter Type
Required
Suggested
array1
Dynamic
True
-
array2
Dynamic
True
-

ArrayContains

Returns true if the array contains any element or an element matches a specific value.
  • ArrayContains(input, [ value ])
Returns true if.
Return Type: Boolean
Parameter Name
Parameter Type
Required
Suggested
input
Dynamic
True
-
value
Dynamic
False
-

ArrayFilter

Returns a new list with elements that only matches the value. Matching-rules specified by filterType.
  • ArrayFilter(input, value, [ filterType ])
Returns true if.
Return Type: Dynamic
Parameter Name
Parameter Type
Required
Suggested
input
Dynamic
True
-
value
Dynamic
True
-
filterType
Enum
False
ArrayFilterInclusiveType, ArrayFilterExclusiveType, ArrayFilterLessThanType, ArrayFilterGreaterThanType

ArrayFind

Returns a new list of indices of the matching values. Matching-rules specified by filterType.
  • ArrayFind(input, value, [ filterType ])
Returns the list.
Return Type: Dynamic
Parameter Name
Parameter Type
Required
Suggested
input
Dynamic
True
-
value
Dynamic
True
-
filterType
Enum
False
ArrayFilterInclusiveType, ArrayFilterExclusiveType, ArrayFilterLessThanType, ArrayFilterGreaterThanType

ArrayGet

Gets the value on a specific index. A negative index will take from the end of the array.
  • ArrayGet(input, index)
Return the value on that index.
Return Type: Dynamic
Parameter Name
Parameter Type
Required
Suggested
input
Dynamic
True
-
index
Number
True
Input, Number, SessionGet

ArrayIndex

Gets the value on a specific index. A negative index will take from the end of the array.
  • ArrayIndex(input, index)
Return the value on that index.
Return Type: Dynamic
Parameter Name
Parameter Type
Required
Suggested
input
Dynamic
True
-
index
Number
True
Input, Number, SessionGet

ArrayLast

Gets the last value of the array with an optional offset.
  • ArrayLast(input, [ offset ])
Return the last value of the array taking the offset into account.
Return Type: Dynamic
Parameter Name
Parameter Type
Required
Suggested
input
Dynamic
True
-
offset
Number
False
Input, Number, SessionGet

ArrayPop

Remove an item from the end of an array.
  • ArrayPop(input)
Returns the input array.
Return Type: Dynamic
Parameter Name
Parameter Type
Required
Suggested
input
Dynamic
True
-

ArrayRemove

Removes an element from a specified index.
  • ArrayRemove(input, index)
Returns the input array.
Return Type: Dynamic
Parameter Name
Parameter Type
Required
Suggested
input
Dynamic
True
-
index
Number
True
Input, Number, SessionGet

ArrayReplace

Replaces a specific value with another value.
  • ArrayReplace(input, oldValue, newValue)
Returns true if.
Return Type: Dynamic
Parameter Name
Parameter Type
Required
Suggested
input
Dynamic
True
-
oldValue
Dynamic
True
-
newValue
Dynamic
True
-

ArrayShift

Remove an item from the beginning of an array.
  • ArrayShift(input)
Returns the input array.
Return Type: Dynamic
Parameter Name
Parameter Type
Required
Suggested
input
Dynamic
True
-

ArraySort

Sorts the array values in ascending or descending order.
  • ArraySort(input, [ descending ])
Returns the sorted array.
Return Type: Dynamic
Parameter Name
Parameter Type
Required
Suggested
input
Dynamic
True
-
descending
Boolean
False
True, IsTrue, False, IsFalse, Or, Branch, Equals, IsBiggerThan, IsSmallerThan, IsBiggerOrSmallerThan, IsAnyOrderOpen, IsOrderFilled, IsOrderOpen, IsTradeAmountEnough

ArraySum

Computes the sum of the array. Can be used in combination with a list of numbers or container results like GetAllOpenOrders() or GetAllFinishedOrders().
  • ArraySum(input, [ key ])
Returns the sum of the array.
Return Type: Number
Parameter Name
Parameter Type
Required
Suggested
input
Dynamic
True
-
key
String
False
-

ArrayUnshift

Adds an element to the beginning of an array.
  • ArrayUnshift(input, element)
Returns the input array.
Return Type: Dynamic
Parameter Name
Parameter Type
Required
Suggested
input
Dynamic
True
-
element
Dynamic
True
-

Count

Gets the length of an array or the number of occurrences within the array of a specific value.
  • Count(input, [ value ])
Returns the length of an array or the number of occurrences within the array of a specific value.
Return Type: Number
Parameter Name
Parameter Type
Required
Suggested
input
Dynamic
True
-
value
Dynamic
False
-

Grab

Grabs a range from the array. If count is not set, return all after the offset.
  • Grab(input, offset, [ count ])
Specified range from the array.
Return Type: Dynamic
Parameter Name
Parameter Type
Required
Suggested
input
Dynamic
True
-
offset
Number
True
Input, Number, SessionGet
count
Number
False
Input, Number, SessionGet

Offset

Gets an offset amount of the given array.
  • Offset(input, offset)
Returns the given array with the offset amount of data removed from it.
Return Type: Dynamic
Parameter Name
Parameter Type
Required
Suggested
input
Dynamic
True
-
offset
Number
True
Input, Number, SessionGet

Range

Grabs a range from the array. If count is not set, return all after the offset.
  • Range(input, offset, [ count ])
Specified range from the array.
Return Type: Dynamic
Parameter Name
Parameter Type
Required
Suggested
input
Dynamic
True
-
offset
Number
True
Input, Number, SessionGet
count
Number
False
Input, Number, SessionGet

SourceManager

Stores numeric values in a collection. Only adds the new value when the candle on the specified interval closed. This results in interval based data.
  • SourceManager(newValue, [ interval ], [ cap ])
Returns the numeric collection.
Return Type: ListNumbers
Parameter Name
Parameter Type
Required
Suggested
newValue
Number
True
-
interval
Number
False
InputInterval, Number, CurrentInterval
cap
Number
False
-
Copy link
On this page
ArrayAdd
ArrayAny
ArrayConcat
ArrayContains
ArrayFilter
ArrayFind
ArrayGet
ArrayIndex
ArrayLast
ArrayPop
ArrayRemove
ArrayReplace
ArrayShift
ArraySort
ArraySum
ArrayUnshift
Count
Grab
Offset
Range
SourceManager