ta lib - drorgl/node-talib GitHub Wiki
- talib
- node-talib
- Enums
- talib
- Interfaces
- Modules
- Module: "index"
- Index
- Cycle Indicators Functions
- Math Operators Functions
- Math Transform Functions
- Momentum Indicators Functions
- Other Functions
- Overlap Studies Functions
- Pattern Recognition Functions
- Price Transform Functions
- Statistic Functions Functions
- Volatility Indicators Functions
- Volume Indicators Functions
- Module: "index"
talib
node-talib
A thin node.js wrapper around TA-LIB, a technical analysis library with 100+ indicators such as ADX, MACD, RSI, Stochastic, Bollinger Bands, TRIX and candlestick pattern recognition.
Installation
To install the most recent release from npm, run:
npm install drorgl/node-talib
Building
The source code is available at github. You can either clone the repository or download a zip file of the latest release.
Once you have the source, you can build the module by running
npm install
in the main directory. If everything goes well, the module will be available in the build/Release folder.
Examples
TALib is very simple to use.
// load the module and display its version
var talib = require('./build/Release/talib');
console.log("TALib Version: " + talib.version);
// Display all available indicator function names
var functions = talib.functions;
for (i in functions) {
console.log(functions[i].name);
}
Assuming the market data is readily available, you can calculate an indicator by calling the execute function with the name of the indicator and required input parameters.
// market data as arrays
var marketData = { open: [...], close: [...], high: [...], low: [...], volume: [...] };
// execute Average Directional Movement Index indicator with time period 9
talib.execute({
name: "ADX",
startIdx: 0,
endIdx: marketData.close.length - 1,
high: marketData.high,
low: marketData.low,
close: marketData.close,
optInTimePeriod: 9
}, function (err, result) {
console.log("ADX Function Results:");
console.log(result);
});
Input parameters can be discovered by:
// Retreive Average Directional Movement Index indicator specifications
var function_desc = talib.explain("ADX");
console.dir(function_desc);
{
// Function Name
name: 'ADX',
// Function Group Name
group: 'Momentum Indicators',
// Function Description
hint: 'Average Directional Movement Index',
// Input Parameters
inputs:
[ {
// Parameter Name
name: 'inPriceHLC',
// Parameter Type
// price, real, or integer
type: 'price',
// Parameter keys to be passed in when calling the function
// open, high, low, close, volume,
// openinterest, or timestamp
flags: [ 'high', 'low', 'close' ] } ],
// Optional Input Parameters
optInputs:
[ {
// Parameter Name
name: 'optInTimePeriod',
// Parameter Display Label
displayName: 'Time Period',
// Parameter Default Value
defaultValue: 14,
// Parameter Description
hint: 'Number of period',
// Parameter Type
// real_range, real_integer,
// integer_range, or integer_list
type: 'range_integer' } ],
// Output Values
outputs:
[ {
// Value Name
name: 'outReal',
// Value Type
// real or integer
type: 'real',
// Suggested Value Visualization Hint
// line, line_dot, line_dash, dot,
// histogram, pattern_bool, pattern_bull_bear,
// pattern_strength, positive, negative, zero,
// limit_upper, or limit_lower
flags: [ 'line' ] } ] }
Some indicators require or accept a optInMAType flag:
SMA = 0
EMA = 1
WMA = 2
DEMA = 3
TEMA = 4
TRIMA = 5
KAMA = 6
MAMA = 7
T3 = 8
For working examples look in the examples/ directory. You can execute the examples using node.
node examples/adx.js
TypeScript Examples
All examples have been converted to typescript in drorgl/node-talib repository, documentation coming soon or you can look at index.ts for further information
Recent Changes
1.0.0 2017-10-28 (Dror Gluska):
Major overhaul
Update ta-lib to latest (0.4)
create a generic build in binding.gyp, should work with most if not all OSs
Add build for ta-lib tests (under build/Debug/ta_regtest or build/Release/ta_regtest)
Add TypeScript typings
Add funtion definitions
Add async functions
License
Copyright (c) 2012-2017 Mustafa Oransel
This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version.
This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.
Enums
talib › Globals › "index" › MAType
Enumeration: MAType
Moving Average Type
Index
Enumeration members
Enumeration members
Dema
• Dema: = 3
Defined in index.ts:109
Double Exponential
Ema
• Ema: = 1
Defined in index.ts:105
Exponential
Kama
• Kama: = 6
Defined in index.ts:115
Kaufman Adaptive
Mama
• Mama: = 7
Defined in index.ts:117
Mesa Adaptive
Sma
• Sma: = 0
Defined in index.ts:103
Simple
T3
• T3: = 8
Defined in index.ts:119
Triple Exponential T3
Tema
• Tema: = 4
Defined in index.ts:111
Triple Exponential
Trima
• Trima: = 5
Defined in index.ts:113
Triangular
Wma
• Wma: = 2
Defined in index.ts:107
Weighted
talib
Index
Modules
Interfaces
talib › Globals › "index" › IExecute
Interface: IExecute
Hierarchy
- IExecute
Indexable
- [ params: string]: number[] | number | string
Index
Properties
Properties
endIdx
• endIdx: number
Defined in index.ts:67
name
• name: string
Defined in index.ts:65
startIdx
• startIdx: number
Defined in index.ts:66
talib › Globals › "index" › IExecutionResult
Interface: IExecutionResult ‹TResult›
Type parameters
▪ TResult
Hierarchy
- IExecutionResult
Index
Properties
Properties
begIndex
• begIndex: number
Defined in index.ts:72
nbElement
• nbElement: number
Defined in index.ts:73
result
• result: TResult
Defined in index.ts:74
talib › Globals › "index" › IExplainResult
Interface: IExplainResult
function usage explanation
Hierarchy
- IExplainResult
Index
Properties
Properties
group
• group: string
Defined in index.ts:38
function group, i.e. Math Operators Functions, Momentum Indicators Functions etc'
hint
• hint: string
Defined in index.ts:40
function description
inputs
• inputs: IExplanationField[]
Defined in index.ts:42
inputs for the function
name
• name: string
Defined in index.ts:36
name of the function
optInputs
• optInputs: IExplanationOption[]
Defined in index.ts:44
optional inputs for the function
outputs
• outputs: IExplanationField[]
Defined in index.ts:46
outputs for the function execution
talib › Globals › "index" › IExplanationField
Interface: IExplanationField
Hierarchy
- IExplanationField
Index
Properties
Properties
0
• 0: string
Defined in index.ts:19
flags
• flags: any
Defined in index.ts:20
name
• name: string
Defined in index.ts:17
type
• type: string
Defined in index.ts:18
talib › Globals › "index" › IExplanationOption
Interface: IExplanationOption
Hierarchy
- IExplanationOption
Index
Properties
Properties
defaultValue
• defaultValue: number
Defined in index.ts:26
displayName
• displayName: string
Defined in index.ts:25
hint
• hint: string
Defined in index.ts:27
name
• name: string
Defined in index.ts:24
type
• type: string
Defined in index.ts:28
Modules
Module: "index"
module default
Index
Enumerations
Interfaces
Cycle Indicators Functions
Math Operators Functions
Math Transform Functions
Momentum Indicators Functions
- ADX
- ADXR
- APO
- AROON
- AROONOSC
- BOP
- CCI
- CMO
- DX
- MACD
- MACDEXT
- MACDFIX
- MFI
- MINUS_DI
- MINUS_DM
- MOM
- PLUS_DI
- PLUS_DM
- PPO
- ROC
- ROCP
- ROCR
- ROCR100
- RSI
- STOCH
- STOCHF
- STOCHRSI
- TRIX
- ULTOSC
- WILLR
Other Functions
Overlap Studies Functions
Pattern Recognition Functions
- CDL2CROWS
- CDL3BLACKCROWS
- CDL3INSIDE
- CDL3LINESTRIKE
- CDL3OUTSIDE
- CDL3STARSINSOUTH
- CDL3WHITESOLDIERS
- CDLABANDONEDBABY
- CDLADVANCEBLOCK
- CDLBELTHOLD
- CDLBREAKAWAY
- CDLCLOSINGMARUBOZU
- CDLCONCEALBABYSWALL
- CDLCOUNTERATTACK
- CDLDARKCLOUDCOVER
- CDLDOJI
- CDLDOJISTAR
- CDLDRAGONFLYDOJI
- CDLENGULFING
- CDLEVENINGDOJISTAR
- CDLEVENINGSTAR
- CDLGAPSIDESIDEWHITE
- CDLGRAVESTONEDOJI
- CDLHAMMER
- CDLHANGINGMAN
- CDLHARAMI
- CDLHARAMICROSS
- CDLHIGHWAVE
- CDLHIKKAKE
- CDLHIKKAKEMOD
- CDLHOMINGPIGEON
- CDLIDENTICAL3CROWS
- CDLINNECK
- CDLINVERTEDHAMMER
- CDLKICKING
- CDLKICKINGBYLENGTH
- CDLLADDERBOTTOM
- CDLLONGLEGGEDDOJI
- CDLLONGLINE
- CDLMARUBOZU
- CDLMATCHINGLOW
- CDLMATHOLD
- CDLMORNINGDOJISTAR
- CDLMORNINGSTAR
- CDLONNECK
- CDLPIERCING
- CDLRICKSHAWMAN
- CDLRISEFALL3METHODS
- CDLSEPARATINGLINES
- CDLSHOOTINGSTAR
- CDLSHORTLINE
- CDLSPINNINGTOP
- CDLSTALLEDPATTERN
- CDLSTICKSANDWICH
- CDLTAKURI
- CDLTASUKIGAP
- CDLTHRUSTING
- CDLTRISTAR
- CDLUNIQUE3RIVER
- CDLUPSIDEGAP2CROWS
- CDLXSIDEGAP3METHODS
Price Transform Functions
Statistic Functions Functions
Volatility Indicators Functions
Volume Indicators Functions
Cycle Indicators Functions
HT_DCPERIOD
▸ HT_DCPERIOD(inReal: number[]): Promise‹IExecutionResult‹object››
Defined in index.ts:1004
HT_DCPERIOD - Hilbert Transform - Dominant Cycle Period
Parameters:
| Name | Type | Description |
|---|---|---|
inReal |
number[] |
Returns: Promise‹IExecutionResult‹object››
HT_DCPHASE
▸ HT_DCPHASE(inReal: number[]): Promise‹IExecutionResult‹object››
Defined in index.ts:1014
HT_DCPHASE - Hilbert Transform - Dominant Cycle Phase
Parameters:
| Name | Type | Description |
|---|---|---|
inReal |
number[] |
Returns: Promise‹IExecutionResult‹object››
HT_PHASOR
▸ HT_PHASOR(inReal: number[]): Promise‹IExecutionResult‹object››
Defined in index.ts:1023
HT_PHASOR - Hilbert Transform - Phasor Components
Parameters:
| Name | Type | Description |
|---|---|---|
inReal |
number[] |
Returns: Promise‹IExecutionResult‹object››
HT_SINE
▸ HT_SINE(inReal: number[]): Promise‹IExecutionResult‹object››
Defined in index.ts:1033
HT_SINE - Hilbert Transform - SineWave
Parameters:
| Name | Type | Description |
|---|---|---|
inReal |
number[] |
Returns: Promise‹IExecutionResult‹object››
HT_TRENDMODE
▸ HT_TRENDMODE(inReal: number[]): Promise‹IExecutionResult‹object››
Defined in index.ts:1043
HT_TRENDMODE - Hilbert Transform - Trend vs Cycle Mode
Parameters:
| Name | Type | Description |
|---|---|---|
inReal |
number[] |
Returns: Promise‹IExecutionResult‹object››
Math Operators Functions
ADD
▸ ADD(inReal0: number[], inReal1: number[]): Promise‹IExecutionResult‹object››
Defined in index.ts:129
ADD - Vector Arithmetic Add
Parameters:
| Name | Type |
|---|---|
inReal0 |
number[] |
inReal1 |
number[] |
Returns: Promise‹IExecutionResult‹object››
number[]
DIV
▸ DIV(inReal0: number[], inReal1: number[]): Promise‹IExecutionResult‹object››
Defined in index.ts:140
DIV - Vector Arithmetic Div
Parameters:
| Name | Type |
|---|---|
inReal0 |
number[] |
inReal1 |
number[] |
Returns: Promise‹IExecutionResult‹object››
number[]
MAX
▸ MAX(inReal: number[], optInTimePeriod: number): Promise‹IExecutionResult‹object››
Defined in index.ts:150
MAX - Highest value over a specified period
Parameters:
| Name | Type | Default | Description |
|---|---|---|---|
inReal |
number[] | - | - |
optInTimePeriod |
number | 30 | Time Period - Number of period = 30 |
Returns: Promise‹IExecutionResult‹object››
MAXINDEX
▸ MAXINDEX(inReal: number[], optInTimePeriod: number): Promise‹IExecutionResult‹object››
Defined in index.ts:160
MAXINDEX - Index of highest value over a specified period
Parameters:
| Name | Type | Default | Description |
|---|---|---|---|
inReal |
number[] | - | - |
optInTimePeriod |
number | 30 | Time Period - Number of period = 30 |
Returns: Promise‹IExecutionResult‹object››
MIN
▸ MIN(inReal: number[], optInTimePeriod: number): Promise‹IExecutionResult‹object››
Defined in index.ts:170
MIN - Lowest value over a specified period
Parameters:
| Name | Type | Default | Description |
|---|---|---|---|
inReal |
number[] | - | - |
optInTimePeriod |
number | 30 | Time Period - Number of period = 30 |
Returns: Promise‹IExecutionResult‹object››
MININDEX
▸ MININDEX(inReal: number[], optInTimePeriod: number): Promise‹IExecutionResult‹object››
Defined in index.ts:180
MININDEX - Index of lowest value over a specified period
Parameters:
| Name | Type | Default | Description |
|---|---|---|---|
inReal |
number[] | - | - |
optInTimePeriod |
number | 30 | Time Period - Number of period = 30 |
Returns: Promise‹IExecutionResult‹object››
MINMAX
▸ MINMAX(inReal: number[], optInTimePeriod: number): Promise‹IExecutionResult‹object››
Defined in index.ts:189
MINMAX - Lowest and highest values over a specified period
Parameters:
| Name | Type | Default | Description |
|---|---|---|---|
inReal |
number[] | - | - |
optInTimePeriod |
number | 30 | Time Period - Number of period = 30 |
Returns: Promise‹IExecutionResult‹object››
MINMAXINDEX
▸ MINMAXINDEX(inReal: number[], optInTimePeriod: number): Promise‹IExecutionResult‹object››
Defined in index.ts:199
MINMAXINDEX - Indexes of lowest and highest values over a specified period
Parameters:
| Name | Type | Default | Description |
|---|---|---|---|
inReal |
number[] | - | - |
optInTimePeriod |
number | 30 | Time Period - Number of period = 30 |
Returns: Promise‹IExecutionResult‹object››
MULT
▸ MULT(inReal0: number[], inReal1: number[]): Promise‹IExecutionResult‹object››
Defined in index.ts:209
MULT - Vector Arithmetic Mult
Parameters:
| Name | Type | Description |
|---|---|---|
inReal0 |
number[] | - |
inReal1 |
number[] |
Returns: Promise‹IExecutionResult‹object››
SUB
▸ SUB(inReal0: number[], inReal1: number[]): Promise‹IExecutionResult‹object››
Defined in index.ts:219
SUB - Vector Arithmetic Subtraction
Parameters:
| Name | Type | Description |
|---|---|---|
inReal0 |
number[] | - |
inReal1 |
number[] |
Returns: Promise‹IExecutionResult‹object››
SUM
▸ SUM(inReal: number[], optInTimePeriod: number): Promise‹IExecutionResult‹object››
Defined in index.ts:228
SUM - Summation
Parameters:
| Name | Type | Default | Description |
|---|---|---|---|
inReal |
number[] | - | - |
optInTimePeriod |
number | 30 | Time Period - Number of period = 30 |
Returns: Promise‹IExecutionResult‹object››
Math Transform Functions
ACOS
▸ ACOS(inReal: number[]): Promise‹IExecutionResult‹object››
Defined in index.ts:237
ACOS - Vector Trigonometric ACos
Parameters:
| Name | Type | Description |
|---|---|---|
inReal |
number[] |
Returns: Promise‹IExecutionResult‹object››
ASIN
▸ ASIN(inReal: number[]): Promise‹IExecutionResult‹object››
Defined in index.ts:246
ASIN - Vector Trigonometric ASin
Parameters:
| Name | Type | Description |
|---|---|---|
inReal |
number[] |
Returns: Promise‹IExecutionResult‹object››
ATAN
▸ ATAN(inReal: number[]): Promise‹IExecutionResult‹object››
Defined in index.ts:255
ATAN - Vector Trigonometric ATan
Parameters:
| Name | Type | Description |
|---|---|---|
inReal |
number[] |
Returns: Promise‹IExecutionResult‹object››
CEIL
▸ CEIL(inReal: number[]): Promise‹IExecutionResult‹object››
Defined in index.ts:264
CEIL - Vector Ceil
Parameters:
| Name | Type | Description |
|---|---|---|
inReal |
number[] |
Returns: Promise‹IExecutionResult‹object››
COS
▸ COS(inReal: number[]): Promise‹IExecutionResult‹object››
Defined in index.ts:273
COS - Vector Trigonometric Cos
Parameters:
| Name | Type | Description |
|---|---|---|
inReal |
number[] |
Returns: Promise‹IExecutionResult‹object››
COSH
▸ COSH(inReal: number[]): Promise‹IExecutionResult‹object››
Defined in index.ts:281
COSH - Vector Trigonometric Cosh
Parameters:
| Name | Type |
|---|---|
inReal |
number[] |
Returns: Promise‹IExecutionResult‹object››
EXP
▸ EXP(inReal: number[]): Promise‹IExecutionResult‹object››
Defined in index.ts:290
EXP - Vector Arithmetic Exp
Parameters:
| Name | Type | Description |
|---|---|---|
inReal |
number[] |
Returns: Promise‹IExecutionResult‹object››
FLOOR
▸ FLOOR(inReal: number[]): Promise‹IExecutionResult‹object››
Defined in index.ts:300
FLOOR - Vector Floor
Parameters:
| Name | Type | Description |
|---|---|---|
inReal |
number[] |
Returns: Promise‹IExecutionResult‹object››
LN
▸ LN(inReal: number[]): Promise‹IExecutionResult‹object››
Defined in index.ts:310
LN - Vector Log Natural
Parameters:
| Name | Type | Description |
|---|---|---|
inReal |
number[] |
Returns: Promise‹IExecutionResult‹object››
LOG10
▸ LOG10(inReal: number[]): Promise‹IExecutionResult‹object››
Defined in index.ts:320
LOG10 - Vector Log10
Parameters:
| Name | Type | Description |
|---|---|---|
inReal |
number[] |
Returns: Promise‹IExecutionResult‹object››
SIN
▸ SIN(inReal: number[]): Promise‹IExecutionResult‹object››
Defined in index.ts:330
SIN - Vector Trigonometric Sin
Parameters:
| Name | Type | Description |
|---|---|---|
inReal |
number[] |
Returns: Promise‹IExecutionResult‹object››
SINH
▸ SINH(inReal: number[]): Promise‹IExecutionResult‹object››
Defined in index.ts:340
SINH - Vector Trigonometric Sinh
Parameters:
| Name | Type | Description |
|---|---|---|
inReal |
number[] |
Returns: Promise‹IExecutionResult‹object››
SQRT
▸ SQRT(inReal: number[]): Promise‹IExecutionResult‹object››
Defined in index.ts:350
SQRT - Vector Square Root
Parameters:
| Name | Type | Description |
|---|---|---|
inReal |
number[] |
Returns: Promise‹IExecutionResult‹object››
TAN
▸ TAN(inReal: number[]): Promise‹IExecutionResult‹object››
Defined in index.ts:360
TAN - Vector Trigonometric Tan
Parameters:
| Name | Type | Description |
|---|---|---|
inReal |
number[] |
Returns: Promise‹IExecutionResult‹object››
TANH
▸ TANH(inReal: number[]): Promise‹IExecutionResult‹object››
Defined in index.ts:370
TANH - Vector Trigonometric Tanh
Parameters:
| Name | Type | Description |
|---|---|---|
inReal |
number[] |
Returns: Promise‹IExecutionResult‹object››
Momentum Indicators Functions
ADX
▸ ADX(high: number[], low: number[], close: number[], optInTimePeriod: number): Promise‹IExecutionResult‹object››
Defined in index.ts:624
ADX - Average Directional Movement Index
Parameters:
| Name | Type | Default | Description |
|---|---|---|---|
high |
number[] | - | - |
low |
number[] | - | - |
close |
number[] | - | - |
optInTimePeriod |
number | 14 | Time Period - Number of period = 14 |
Returns: Promise‹IExecutionResult‹object››
ADXR
▸ ADXR(high: number[], low: number[], close: number[], optInTimePeriod: number): Promise‹IExecutionResult‹object››
Defined in index.ts:637
ADXR - Average Directional Movement Index Rating
Parameters:
| Name | Type | Default | Description |
|---|---|---|---|
high |
number[] | - | - |
low |
number[] | - | - |
close |
number[] | - | - |
optInTimePeriod |
number | 14 | Time Period - Number of period = 14 |
Returns: Promise‹IExecutionResult‹object››
APO
▸ APO(inReal: number[], optInFastPeriod: number, optInSlowPeriod: number, optInMAType: MAType): Promise‹IExecutionResult‹object››
Defined in index.ts:650
APO - Absolute Price Oscillator
Parameters:
| Name | Type | Default | Description |
|---|---|---|---|
inReal |
number[] | - | - |
optInFastPeriod |
number | 12 | Fast Period - Number of period for the fast MA = 12 |
optInSlowPeriod |
number | 26 | Slow Period - Number of period for the slow MA = 26 |
optInMAType |
MAType | 0 | MA Type - Type of Moving Average = 0 |
Returns: Promise‹IExecutionResult‹object››
AROON
▸ AROON(high: number[], low: number[], optInTimePeriod: number): Promise‹IExecutionResult‹object››
Defined in index.ts:662
AROON - Aroon
Parameters:
| Name | Type | Default | Description |
|---|---|---|---|
high |
number[] | - | - |
low |
number[] | - | - |
optInTimePeriod |
number | 14 | Time Period - Number of period = 14 |
Returns: Promise‹IExecutionResult‹object››
AROONOSC
▸ AROONOSC(high: number[], low: number[], optInTimePeriod: number): Promise‹IExecutionResult‹object››
Defined in index.ts:674
AROONOSC - Aroon Oscillator
Parameters:
| Name | Type | Default | Description |
|---|---|---|---|
high |
number[] | - | - |
low |
number[] | - | - |
optInTimePeriod |
number | 14 | Time Period - Number of period = 14 |
Returns: Promise‹IExecutionResult‹object››
BOP
▸ BOP(open: number[], high: number[], low: number[], close: number[]): Promise‹IExecutionResult‹object››
Defined in index.ts:687
BOP - Balance Of Power
Parameters:
| Name | Type | Description |
|---|---|---|
open |
number[] | - |
high |
number[] | - |
low |
number[] | - |
close |
number[] |
Returns: Promise‹IExecutionResult‹object››
CCI
▸ CCI(high: number[], low: number[], close: number[], optInTimePeriod: number): Promise‹IExecutionResult‹object››
Defined in index.ts:700
CCI - Commodity Channel Index
Parameters:
| Name | Type | Default | Description |
|---|---|---|---|
high |
number[] | - | - |
low |
number[] | - | - |
close |
number[] | - | - |
optInTimePeriod |
number | 14 | Time Period - Number of period = 14 |
Returns: Promise‹IExecutionResult‹object››
CMO
▸ CMO(inReal: number[], optInTimePeriod: number): Promise‹IExecutionResult‹object››
Defined in index.ts:711
CMO - Chande Momentum Oscillator
Parameters:
| Name | Type | Default | Description |
|---|---|---|---|
inReal |
number[] | - | - |
optInTimePeriod |
number | 14 | Time Period - Number of period = 14 |
Returns: Promise‹IExecutionResult‹object››
DX
▸ DX(high: number[], low: number[], close: number[], optInTimePeriod: number): Promise‹IExecutionResult‹object››
Defined in index.ts:724
DX - Directional Movement Index
Parameters:
| Name | Type | Default | Description |
|---|---|---|---|
high |
number[] | - | - |
low |
number[] | - | - |
close |
number[] | - | - |
optInTimePeriod |
number | 14 | Time Period - Number of period = 14 |
Returns: Promise‹IExecutionResult‹object››
MACD
▸ MACD(inReal: number[], optInFastPeriod: number, optInSlowPeriod: number, optInSignalPeriod: number): Promise‹IExecutionResult‹object››
Defined in index.ts:737
MACD - Moving Average Convergence/Divergence
Parameters:
| Name | Type | Default | Description |
|---|---|---|---|
inReal |
number[] | - | - |
optInFastPeriod |
number | 12 | Fast Period - Number of period for the fast MA = 12 |
optInSlowPeriod |
number | 26 | Slow Period - Number of period for the slow MA = 26 |
optInSignalPeriod |
number | 9 | Signal Period - Smoothing for the signal line (nb of period) = 9 |
Returns: Promise‹IExecutionResult‹object››
MACDEXT
▸ MACDEXT(inReal: number[], optInFastPeriod: number, optInFastMAType: MAType, optInSlowPeriod: number, optInSlowMAType: MAType, optInSignalPeriod: number, optInSignalMAType: MAType): Promise‹IExecutionResult‹object››
Defined in index.ts:753
MACDEXT - MACD with controllable MA type
Parameters:
| Name | Type | Default | Description |
|---|---|---|---|
inReal |
number[] | - | - |
optInFastPeriod |
number | 12 | Fast Period - Number of period for the fast MA = 12 |
optInFastMAType |
MAType | 0 | Fast MA - Type of Moving Average for fast MA = 0 |
optInSlowPeriod |
number | 26 | Slow Period - Number of period for the slow MA = 26 |
optInSlowMAType |
MAType | 0 | Slow MA - Type of Moving Average for slow MA = 0 |
optInSignalPeriod |
number | 9 | Signal Period - Smoothing for the signal line (nb of period) = 9 |
optInSignalMAType |
MAType | 0 | Signal MA - Type of Moving Average for signal line = 0 |
Returns: Promise‹IExecutionResult‹object››
MACDFIX
▸ MACDFIX(inReal: number[], optInSignalPeriod: number): Promise‹IExecutionResult‹object››
Defined in index.ts:764
MACDFIX - Moving Average Convergence/Divergence Fix 12/26
Parameters:
| Name | Type | Default | Description |
|---|---|---|---|
inReal |
number[] | - | - |
optInSignalPeriod |
number | 9 | Signal Period - Smoothing for the signal line (nb of period) = 9 |
Returns: Promise‹IExecutionResult‹object››
MFI
▸ MFI(high: number[], low: number[], close: number[], volume: number[], optInTimePeriod: number): Promise‹IExecutionResult‹object››
Defined in index.ts:778
MFI - Money Flow Index
Parameters:
| Name | Type | Default | Description |
|---|---|---|---|
high |
number[] | - | - |
low |
number[] | - | - |
close |
number[] | - | - |
volume |
number[] | - | - |
optInTimePeriod |
number | 14 | Time Period - Number of period = 14 |
Returns: Promise‹IExecutionResult‹object››
MINUS_DI
▸ MINUS_DI(high: number[], low: number[], close: number[], optInTimePeriod: number): Promise‹IExecutionResult‹object››
Defined in index.ts:791
MINUS_DI - Minus Directional Indicator
Parameters:
| Name | Type | Default | Description |
|---|---|---|---|
high |
number[] | - | - |
low |
number[] | - | - |
close |
number[] | - | - |
optInTimePeriod |
number | 14 | Time Period - Number of period = 14 |
Returns: Promise‹IExecutionResult‹object››
MINUS_DM
▸ MINUS_DM(high: number[], low: number[], optInTimePeriod: number): Promise‹IExecutionResult‹object››
Defined in index.ts:803
MINUS_DM - Minus Directional Movement
Parameters:
| Name | Type | Default | Description |
|---|---|---|---|
high |
number[] | - | - |
low |
number[] | - | - |
optInTimePeriod |
number | 14 | Time Period - Number of period = 14 |
Returns: Promise‹IExecutionResult‹object››
MOM
▸ MOM(inReal: number[], optInTimePeriod: number): Promise‹IExecutionResult‹object››
Defined in index.ts:814
MOM - Momentum
Parameters:
| Name | Type | Default | Description |
|---|---|---|---|
inReal |
number[] | - | - |
optInTimePeriod |
number | 10 | Time Period - Number of period = 10 |
Returns: Promise‹IExecutionResult‹object››
PLUS_DI
▸ PLUS_DI(high: number[], low: number[], close: number[], optInTimePeriod: number): Promise‹IExecutionResult‹object››
Defined in index.ts:827
PLUS_DI - Plus Directional Indicator
Parameters:
| Name | Type | Default | Description |
|---|---|---|---|
high |
number[] | - | - |
low |
number[] | - | - |
close |
number[] | - | - |
optInTimePeriod |
number | 14 | Time Period - Number of period = 14 |
Returns: Promise‹IExecutionResult‹object››
PLUS_DM
▸ PLUS_DM(high: number[], low: number[], optInTimePeriod: number): Promise‹IExecutionResult‹object››
Defined in index.ts:839
PLUS_DM - Plus Directional Movement
Parameters:
| Name | Type | Default | Description |
|---|---|---|---|
high |
number[] | - | - |
low |
number[] | - | - |
optInTimePeriod |
number | 14 | Time Period - Number of period = 14 |
Returns: Promise‹IExecutionResult‹object››
PPO
▸ PPO(inReal: number[], optInFastPeriod: number, optInSlowPeriod: number, optInMAType: MAType): Promise‹IExecutionResult‹object››
Defined in index.ts:852
PPO - Percentage Price Oscillator
Parameters:
| Name | Type | Default | Description |
|---|---|---|---|
inReal |
number[] | - | - |
optInFastPeriod |
number | 12 | Fast Period - Number of period for the fast MA = 12 |
optInSlowPeriod |
number | 26 | Slow Period - Number of period for the slow MA = 26 |
optInMAType |
MAType | 0 | MA Type - Type of Moving Average = 0 |
Returns: Promise‹IExecutionResult‹object››
ROC
▸ ROC(inReal: number[], optInTimePeriod: number): Promise‹IExecutionResult‹object››
Defined in index.ts:863
ROC - Rate of change : ((price/prevPrice)-1)*100
Parameters:
| Name | Type | Default | Description |
|---|---|---|---|
inReal |
number[] | - | - |
optInTimePeriod |
number | 10 | Time Period - Number of period = 10 |
Returns: Promise‹IExecutionResult‹object››
ROCP
▸ ROCP(inReal: number[], optInTimePeriod: number): Promise‹IExecutionResult‹object››
Defined in index.ts:874
ROCP - Rate of change Percentage: (price-prevPrice)/prevPrice
Parameters:
| Name | Type | Default | Description |
|---|---|---|---|
inReal |
number[] | - | - |
optInTimePeriod |
number | 10 | Time Period - Number of period = 10 |
Returns: Promise‹IExecutionResult‹object››
ROCR
▸ ROCR(inReal: number[], optInTimePeriod: number): Promise‹IExecutionResult‹object››
Defined in index.ts:885
ROCR - Rate of change ratio: (price/prevPrice)
Parameters:
| Name | Type | Default | Description |
|---|---|---|---|
inReal |
number[] | - | - |
optInTimePeriod |
number | 10 | Time Period - Number of period = 10 |
Returns: Promise‹IExecutionResult‹object››
ROCR100
▸ ROCR100(inReal: number[], optInTimePeriod: number): Promise‹IExecutionResult‹object››
Defined in index.ts:896
ROCR100 - Rate of change ratio 100 scale: (price/prevPrice)*100
Parameters:
| Name | Type | Default | Description |
|---|---|---|---|
inReal |
number[] | - | - |
optInTimePeriod |
number | 10 | Time Period - Number of period = 10 |
Returns: Promise‹IExecutionResult‹object››
RSI
▸ RSI(inReal: number[], optInTimePeriod: number): Promise‹IExecutionResult‹object››
Defined in index.ts:907
RSI - Relative Strength Index
Parameters:
| Name | Type | Default | Description |
|---|---|---|---|
inReal |
number[] | - | - |
optInTimePeriod |
number | 14 | Time Period - Number of period = 14 |
Returns: Promise‹IExecutionResult‹object››
STOCH
▸ STOCH(high: number[], low: number[], close: number[], optInFastK_Period: number, optInSlowK_Period: number, optInSlowK_MAType: MAType, optInSlowD_Period: number, optInSlowD_MAType: MAType): Promise‹IExecutionResult‹object››
Defined in index.ts:924
STOCH - Stochastic
Parameters:
| Name | Type | Default | Description |
|---|---|---|---|
high |
number[] | - | - |
low |
number[] | - | - |
close |
number[] | - | - |
optInFastK_Period |
number | 5 | Fast-K Period - Time period for building the Fast-K line = 5 |
optInSlowK_Period |
number | 3 | Slow-K Period - Smoothing for making the Slow-K line. Usually set to 3 = 3 |
optInSlowK_MAType |
MAType | 0 | Slow-K MA - Type of Moving Average for Slow-K = 0 |
optInSlowD_Period |
number | 3 | Slow-D Period - Smoothing for making the Slow-D line = 3 |
optInSlowD_MAType |
MAType | 0 | Slow-D MA - Type of Moving Average for Slow-D = 0 |
Returns: Promise‹IExecutionResult‹object››
STOCHF
▸ STOCHF(high: number[], low: number[], close: number[], optInFastK_Period: number, optInFastD_Period: number, optInFastD_MAType: MAType): Promise‹IExecutionResult‹object››
Defined in index.ts:941
STOCHF - Stochastic Fast
Parameters:
| Name | Type | Default | Description |
|---|---|---|---|
high |
number[] | - | - |
low |
number[] | - | - |
close |
number[] | - | - |
optInFastK_Period |
number | 5 | Fast-K Period - Time period for building the Fast-K line = 5 |
optInFastD_Period |
number | 3 | Fast-D Period - Smoothing for making the Fast-D line. Usually set to 3 = 3 |
optInFastD_MAType |
MAType | 0 | Fast-D MA - Type of Moving Average for Fast-D = 0 |
Returns: Promise‹IExecutionResult‹object››
STOCHRSI
▸ STOCHRSI(inReal: number[], optInTimePeriod: number, optInFastK_Period: number, optInFastD_Period: number, optInFastD_MAType: MAType): Promise‹IExecutionResult‹object››
Defined in index.ts:955
STOCHRSI - Stochastic Relative Strength Index
Parameters:
| Name | Type | Default | Description |
|---|---|---|---|
inReal |
number[] | - | - |
optInTimePeriod |
number | 14 | Time Period - Number of period = 14 |
optInFastK_Period |
number | 5 | Fast-K Period - Time period for building the Fast-K line = 5 |
optInFastD_Period |
number | 3 | Fast-D Period - Smoothing for making the Fast-D line. Usually set to 3 = 3 |
optInFastD_MAType |
MAType | 0 | Fast-D MA - Type of Moving Average for Fast-D = 0 |
Returns: Promise‹IExecutionResult‹object››
TRIX
▸ TRIX(inReal: number[], optInTimePeriod: number): Promise‹IExecutionResult‹object››
Defined in index.ts:966
TRIX - 1-day Rate-Of-Change (ROC) of a Triple Smooth EMA
Parameters:
| Name | Type | Default | Description |
|---|---|---|---|
inReal |
number[] | - | - |
optInTimePeriod |
number | 30 | Time Period - Number of period = 30 |
Returns: Promise‹IExecutionResult‹object››
ULTOSC
▸ ULTOSC(high: number[], low: number[], close: number[], optInTimePeriod1: number, optInTimePeriod2: number, optInTimePeriod3: number): Promise‹IExecutionResult‹object››
Defined in index.ts:981
ULTOSC - Ultimate Oscillator
Parameters:
| Name | Type | Default | Description |
|---|---|---|---|
high |
number[] | - | - |
low |
number[] | - | - |
close |
number[] | - | - |
optInTimePeriod1 |
number | 7 | First Period - Number of bars for 1st period. = 7 |
optInTimePeriod2 |
number | 14 | Second Period - Number of bars fro 2nd period = 14 |
optInTimePeriod3 |
number | 28 | Third Period - Number of bars for 3rd period = 28 |
Returns: Promise‹IExecutionResult‹object››
WILLR
▸ WILLR(high: number[], low: number[], close: number[], optInTimePeriod: number): Promise‹IExecutionResult‹object››
Defined in index.ts:994
WILLR - Williams' %R
Parameters:
| Name | Type | Default | Description |
|---|---|---|---|
high |
number[] | - | - |
low |
number[] | - | - |
close |
number[] | - | - |
optInTimePeriod |
number | 14 | Time Period - Number of period = 14 |
Returns: Promise‹IExecutionResult‹object››
Other Functions
execute
▸ execute(execute_params: IExecute, results_callback: function): void
Defined in index.ts:82
Execute ta-lib function
Parameters:
▪ execute_params: IExecute
execution parameters
▪ results_callback: function
execution results callback
▸ (err: any, results: IExecutionResult‹object›): void
Parameters:
| Name | Type |
|---|---|
err |
any |
results |
IExecutionResult‹object› |
Returns: void
execute_async
▸ execute_async(execute_params: IExecute): Promise‹IExecutionResult‹object››
Defined in index.ts:86
Parameters:
| Name | Type |
|---|---|
execute_params |
IExecute |
Returns: Promise‹IExecutionResult‹object››
explain
▸ explain(function_name: string): IExplainResult
Defined in index.ts:53
explain function usage
Parameters:
| Name | Type | Description |
|---|---|---|
function_name |
string | function name to explain |
Returns: IExplainResult
functions
▸ functions(): IExplainResult[]
Defined in index.ts:60
List all functions
Returns: IExplainResult[]
version
▸ version(): string
Defined in index.ts:12
Returns the version of ta-lib compiled
Returns: string
Overlap Studies Functions
BBANDS
▸ BBANDS(inReal: number[], optInTimePeriod: number, optInNbDevUp: number, optInNbDevDn: number, optInMAType: MAType): Promise‹IExecutionResult‹object››
Defined in index.ts:383
BBANDS - Bollinger Bands
Parameters:
| Name | Type | Default | Description |
|---|---|---|---|
inReal |
number[] | - | - |
optInTimePeriod |
number | 5 | Time Period - Number of period = 5 |
optInNbDevUp |
number | 2 | Deviations up - Deviation multiplier for upper band = 2 |
optInNbDevDn |
number | 2 | Deviations down - Deviation multiplier for lower band = 2 |
optInMAType |
MAType | 0 | MA Type - Type of Moving Average = 0 |
Returns: Promise‹IExecutionResult‹object››
DEMA
▸ DEMA(inReal: number[], optInTimePeriod: number): Promise‹IExecutionResult‹object››
Defined in index.ts:394
DEMA - Double Exponential Moving Average
Parameters:
| Name | Type | Default | Description |
|---|---|---|---|
inReal |
number[] | - | - |
optInTimePeriod |
number | 30 | Time Period - Number of period = 30 |
Returns: Promise‹IExecutionResult‹object››
EMA
▸ EMA(inReal: number[], optInTimePeriod: number): Promise‹IExecutionResult‹object››
Defined in index.ts:405
EMA - Exponential Moving Average
Parameters:
| Name | Type | Default | Description |
|---|---|---|---|
inReal |
number[] | - | - |
optInTimePeriod |
number | 30 | Time Period - Number of period = 30 |
Returns: Promise‹IExecutionResult‹object››
HT_TRENDLINE
▸ HT_TRENDLINE(inReal: number[]): Promise‹IExecutionResult‹object››
Defined in index.ts:415
HT_TRENDLINE - Hilbert Transform - Instantaneous Trendline
Parameters:
| Name | Type | Description |
|---|---|---|
inReal |
number[] |
Returns: Promise‹IExecutionResult‹object››
KAMA
▸ KAMA(inReal: number[], optInTimePeriod: number): Promise‹IExecutionResult‹object››
Defined in index.ts:426
KAMA - Kaufman Adaptive Moving Average
Parameters:
| Name | Type | Default | Description |
|---|---|---|---|
inReal |
number[] | - | - |
optInTimePeriod |
number | 30 | Time Period - Number of period = 30 |
Returns: Promise‹IExecutionResult‹object››
MA
▸ MA(inReal: number[], optInTimePeriod: number, optInMAType: MAType): Promise‹IExecutionResult‹object››
Defined in index.ts:437
MA - Moving average
Parameters:
| Name | Type | Default | Description |
|---|---|---|---|
inReal |
number[] | - | - |
optInTimePeriod |
number | 30 | Time Period - Number of period = 30 |
optInMAType |
MAType | 0 | MA Type - Type of Moving Average = 0 |
Returns: Promise‹IExecutionResult‹object››
MAMA
▸ MAMA(inReal: number[], optInFastLimit: number, optInSlowLimit: number): Promise‹IExecutionResult‹object››
Defined in index.ts:449
MAMA - MESA Adaptive Moving Average
Parameters:
| Name | Type | Default | Description |
|---|---|---|---|
inReal |
number[] | - | - |
optInFastLimit |
number | 0.5 | Fast Limit - Upper limit use in the adaptive algorithm = 0.5 |
optInSlowLimit |
number | 0.05 | Slow Limit - Lower limit use in the adaptive algorithm = 0.05 |
Returns: Promise‹IExecutionResult‹object››
MAVP
▸ MAVP(inReal: number[], inPeriods: number[], optInMinPeriod: number, optInMaxPeriod: number, optInMAType: MAType): Promise‹IExecutionResult‹object››
Defined in index.ts:463
MAVP - Moving average with variable period
Parameters:
| Name | Type | Default | Description |
|---|---|---|---|
inReal |
number[] | - | - |
inPeriods |
number[] | - | - |
optInMinPeriod |
number | 2 | Minimum Period - Value less than minimum will be changed to Minimum period = 2 |
optInMaxPeriod |
number | 30 | Maximum Period - Value higher than maximum will be changed to Maximum period = 30 |
optInMAType |
MAType | 0 | MA Type - Type of Moving Average = 0 |
Returns: Promise‹IExecutionResult‹object››
MIDPOINT
▸ MIDPOINT(inReal: number[], optInTimePeriod: number): Promise‹IExecutionResult‹object››
Defined in index.ts:474
MIDPOINT - MidPoint over period
Parameters:
| Name | Type | Default | Description |
|---|---|---|---|
inReal |
number[] | - | - |
optInTimePeriod |
number | 14 | Time Period - Number of period = 14 |
Returns: Promise‹IExecutionResult‹object››
MIDPRICE
▸ MIDPRICE(high: number[], low: number[], optInTimePeriod: number): Promise‹IExecutionResult‹object››
Defined in index.ts:486
MIDPRICE - Midpoint Price over period
Parameters:
| Name | Type | Default | Description |
|---|---|---|---|
high |
number[] | - | - |
low |
number[] | - | - |
optInTimePeriod |
number | 14 | Time Period - Number of period = 14 |
Returns: Promise‹IExecutionResult‹object››
SAR
▸ SAR(high: number[], low: number[], optInAcceleration: number, optInMaximum: number): Promise‹IExecutionResult‹object››
Defined in index.ts:499
SAR - Parabolic SAR
Parameters:
| Name | Type | Default | Description |
|---|---|---|---|
high |
number[] | - | - |
low |
number[] | - | - |
optInAcceleration |
number | 0.02 | Acceleration Factor - Acceleration Factor used up to the Maximum value = 0.02 |
optInMaximum |
number | 0.2 | AF Maximum - Acceleration Factor Maximum value = 0.2 |
Returns: Promise‹IExecutionResult‹object››
SAREXT
▸ SAREXT(high: number[], low: number[], optInStartValue: number, optInOffsetOnReverse: number, optInAccelerationInitLong: number, optInAccelerationLong: number, optInAccelerationMaxLong: number, optInAccelerationInitShort: number, optInAccelerationShort: number, optInAccelerationMaxShort: number): Promise‹IExecutionResult‹object››
Defined in index.ts:517
SAREXT - Parabolic SAR - Extended
Parameters:
| Name | Type | Default | Description |
|---|---|---|---|
high |
number[] | - | - |
low |
number[] | - | - |
optInStartValue |
number | 0 | Start Value - Start value and direction. 0 for Auto, >0 for Long, <0 for Short = 0 |
optInOffsetOnReverse |
number | 0 | Offset on Reverse - Percent offset added/removed to initial stop on short/long reversal = 0 |
optInAccelerationInitLong |
number | 0.02 | AF Init Long - Acceleration Factor initial value for the Long direction = 0.02 |
optInAccelerationLong |
number | 0.02 | AF Long - Acceleration Factor for the Long direction = 0.02 |
optInAccelerationMaxLong |
number | 0.2 | AF Max Long - Acceleration Factor maximum value for the Long direction = 0.2 |
optInAccelerationInitShort |
number | 0.02 | AF Init Short - Acceleration Factor initial value for the Short direction = 0.02 |
optInAccelerationShort |
number | 0.02 | AF Short - Acceleration Factor for the Short direction = 0.02 |
optInAccelerationMaxShort |
number | 0.2 | AF Max Short - Acceleration Factor maximum value for the Short direction = 0.2 |
Returns: Promise‹IExecutionResult‹object››
SMA
▸ SMA(inReal: number[], optInTimePeriod: number): Promise‹IExecutionResult‹object››
Defined in index.ts:528
SMA - Simple Moving Average
Parameters:
| Name | Type | Default | Description |
|---|---|---|---|
inReal |
number[] | - | - |
optInTimePeriod |
number | 30 | Time Period - Number of period = 30 |
Returns: Promise‹IExecutionResult‹object››
T3
▸ T3(inReal: number[], optInTimePeriod: number, optInVFactor: number): Promise‹IExecutionResult‹object››
Defined in index.ts:540
T3 - Triple Exponential Moving Average
Parameters:
| Name | Type | Default | Description |
|---|---|---|---|
inReal |
number[] | - | - |
optInTimePeriod |
number | 5 | Time Period - Number of period = 5 |
optInVFactor |
number | 0.7 | Volume Factor - Volume Factor = 0.7 |
Returns: Promise‹IExecutionResult‹object››
TEMA
▸ TEMA(inReal: number[], optInTimePeriod: number): Promise‹IExecutionResult‹object››
Defined in index.ts:551
TEMA - Triple Exponential Moving Average
Parameters:
| Name | Type | Default | Description |
|---|---|---|---|
inReal |
number[] | - | - |
optInTimePeriod |
number | 30 | Time Period - Number of period = 30 |
Returns: Promise‹IExecutionResult‹object››
TRIMA
▸ TRIMA(inReal: number[], optInTimePeriod: number): Promise‹IExecutionResult‹object››
Defined in index.ts:562
TRIMA - Triangular Moving Average
Parameters:
| Name | Type | Default | Description |
|---|---|---|---|
inReal |
number[] | - | - |
optInTimePeriod |
number | 30 | Time Period - Number of period = 30 |
Returns: Promise‹IExecutionResult‹object››
WMA
▸ WMA(inReal: number[], optInTimePeriod: number): Promise‹IExecutionResult‹object››
Defined in index.ts:573
WMA - Weighted Moving Average
Parameters:
| Name | Type | Default | Description |
|---|---|---|---|
inReal |
number[] | - | - |
optInTimePeriod |
number | 30 | Time Period - Number of period = 30 |
Returns: Promise‹IExecutionResult‹object››
Pattern Recognition Functions
CDL2CROWS
▸ CDL2CROWS(open: number[], high: number[], low: number[], close: number[]): Promise‹IExecutionResult‹object››
Defined in index.ts:1095
CDL2CROWS - Two Crows
Parameters:
| Name | Type | Description |
|---|---|---|
open |
number[] | - |
high |
number[] | - |
low |
number[] | - |
close |
number[] |
Returns: Promise‹IExecutionResult‹object››
CDL3BLACKCROWS
▸ CDL3BLACKCROWS(open: number[], high: number[], low: number[], close: number[]): Promise‹IExecutionResult‹object››
Defined in index.ts:1108
CDL3BLACKCROWS - Three Black Crows
Parameters:
| Name | Type | Description |
|---|---|---|
open |
number[] | - |
high |
number[] | - |
low |
number[] | - |
close |
number[] |
Returns: Promise‹IExecutionResult‹object››
CDL3INSIDE
▸ CDL3INSIDE(open: number[], high: number[], low: number[], close: number[]): Promise‹IExecutionResult‹object››
Defined in index.ts:1121
CDL3INSIDE - Three Inside Up/Down
Parameters:
| Name | Type | Description |
|---|---|---|
open |
number[] | - |
high |
number[] | - |
low |
number[] | - |
close |
number[] |
Returns: Promise‹IExecutionResult‹object››
CDL3LINESTRIKE
▸ CDL3LINESTRIKE(open: number[], high: number[], low: number[], close: number[]): Promise‹IExecutionResult‹object››
Defined in index.ts:1134
CDL3LINESTRIKE - Three-Line Strike
Parameters:
| Name | Type | Description |
|---|---|---|
open |
number[] | - |
high |
number[] | - |
low |
number[] | - |
close |
number[] |
Returns: Promise‹IExecutionResult‹object››
CDL3OUTSIDE
▸ CDL3OUTSIDE(open: number[], high: number[], low: number[], close: number[]): Promise‹IExecutionResult‹object››
Defined in index.ts:1147
CDL3OUTSIDE - Three Outside Up/Down
Parameters:
| Name | Type | Description |
|---|---|---|
open |
number[] | - |
high |
number[] | - |
low |
number[] | - |
close |
number[] |
Returns: Promise‹IExecutionResult‹object››
CDL3STARSINSOUTH
▸ CDL3STARSINSOUTH(open: number[], high: number[], low: number[], close: number[]): Promise‹IExecutionResult‹object››
Defined in index.ts:1160
CDL3STARSINSOUTH - Three Stars In The South
Parameters:
| Name | Type | Description |
|---|---|---|
open |
number[] | - |
high |
number[] | - |
low |
number[] | - |
close |
number[] |
Returns: Promise‹IExecutionResult‹object››
CDL3WHITESOLDIERS
▸ CDL3WHITESOLDIERS(open: number[], high: number[], low: number[], close: number[]): Promise‹IExecutionResult‹object››
Defined in index.ts:1173
CDL3WHITESOLDIERS - Three Advancing White Soldiers
Parameters:
| Name | Type | Description |
|---|---|---|
open |
number[] | - |
high |
number[] | - |
low |
number[] | - |
close |
number[] |
Returns: Promise‹IExecutionResult‹object››
CDLABANDONEDBABY
▸ CDLABANDONEDBABY(open: number[], high: number[], low: number[], close: number[], optInPenetration: number): Promise‹IExecutionResult‹object››
Defined in index.ts:1187
CDLABANDONEDBABY - Abandoned Baby
Parameters:
| Name | Type | Default | Description |
|---|---|---|---|
open |
number[] | - | - |
high |
number[] | - | - |
low |
number[] | - | - |
close |
number[] | - | - |
optInPenetration |
number | 0.3 | Penetration - Percentage of penetration of a candle within another candle = 0.3 |
Returns: Promise‹IExecutionResult‹object››
CDLADVANCEBLOCK
▸ CDLADVANCEBLOCK(open: number[], high: number[], low: number[], close: number[]): Promise‹IExecutionResult‹object››
Defined in index.ts:1200
CDLADVANCEBLOCK - Advance Block
Parameters:
| Name | Type | Description |
|---|---|---|
open |
number[] | - |
high |
number[] | - |
low |
number[] | - |
close |
number[] |
Returns: Promise‹IExecutionResult‹object››
CDLBELTHOLD
▸ CDLBELTHOLD(open: number[], high: number[], low: number[], close: number[]): Promise‹IExecutionResult‹object››
Defined in index.ts:1213
CDLBELTHOLD - Belt-hold
Parameters:
| Name | Type | Description |
|---|---|---|
open |
number[] | - |
high |
number[] | - |
low |
number[] | - |
close |
number[] |
Returns: Promise‹IExecutionResult‹object››
CDLBREAKAWAY
▸ CDLBREAKAWAY(open: number[], high: number[], low: number[], close: number[]): Promise‹IExecutionResult‹object››
Defined in index.ts:1226
CDLBREAKAWAY - Breakaway
Parameters:
| Name | Type | Description |
|---|---|---|
open |
number[] | - |
high |
number[] | - |
low |
number[] | - |
close |
number[] |
Returns: Promise‹IExecutionResult‹object››
CDLCLOSINGMARUBOZU
▸ CDLCLOSINGMARUBOZU(open: number[], high: number[], low: number[], close: number[]): Promise‹IExecutionResult‹object››
Defined in index.ts:1239
CDLCLOSINGMARUBOZU - Closing Marubozu
Parameters:
| Name | Type | Description |
|---|---|---|
open |
number[] | - |
high |
number[] | - |
low |
number[] | - |
close |
number[] |
Returns: Promise‹IExecutionResult‹object››
CDLCONCEALBABYSWALL
▸ CDLCONCEALBABYSWALL(open: number[], high: number[], low: number[], close: number[]): Promise‹IExecutionResult‹object››
Defined in index.ts:1252
CDLCONCEALBABYSWALL - Concealing Baby Swallow
Parameters:
| Name | Type | Description |
|---|---|---|
open |
number[] | - |
high |
number[] | - |
low |
number[] | - |
close |
number[] |
Returns: Promise‹IExecutionResult‹object››
CDLCOUNTERATTACK
▸ CDLCOUNTERATTACK(open: number[], high: number[], low: number[], close: number[]): Promise‹IExecutionResult‹object››
Defined in index.ts:1265
CDLCOUNTERATTACK - Counterattack
Parameters:
| Name | Type | Description |
|---|---|---|
open |
number[] | - |
high |
number[] | - |
low |
number[] | - |
close |
number[] |
Returns: Promise‹IExecutionResult‹object››
CDLDARKCLOUDCOVER
▸ CDLDARKCLOUDCOVER(open: number[], high: number[], low: number[], close: number[], optInPenetration: number): Promise‹IExecutionResult‹object››
Defined in index.ts:1279
CDLDARKCLOUDCOVER - Dark Cloud Cover
Parameters:
| Name | Type | Default | Description |
|---|---|---|---|
open |
number[] | - | - |
high |
number[] | - | - |
low |
number[] | - | - |
close |
number[] | - | - |
optInPenetration |
number | 0.5 | Penetration - Percentage of penetration of a candle within another candle = 0.5 |
Returns: Promise‹IExecutionResult‹object››
CDLDOJI
▸ CDLDOJI(open: number[], high: number[], low: number[], close: number[]): Promise‹IExecutionResult‹object››
Defined in index.ts:1292
CDLDOJI - Doji
Parameters:
| Name | Type | Description |
|---|---|---|
open |
number[] | - |
high |
number[] | - |
low |
number[] | - |
close |
number[] |
Returns: Promise‹IExecutionResult‹object››
CDLDOJISTAR
▸ CDLDOJISTAR(open: number[], high: number[], low: number[], close: number[]): Promise‹IExecutionResult‹object››
Defined in index.ts:1305
CDLDOJISTAR - Doji Star
Parameters:
| Name | Type | Description |
|---|---|---|
open |
number[] | - |
high |
number[] | - |
low |
number[] | - |
close |
number[] |
Returns: Promise‹IExecutionResult‹object››
CDLDRAGONFLYDOJI
▸ CDLDRAGONFLYDOJI(open: number[], high: number[], low: number[], close: number[]): Promise‹IExecutionResult‹object››
Defined in index.ts:1318
CDLDRAGONFLYDOJI - Dragonfly Doji
Parameters:
| Name | Type | Description |
|---|---|---|
open |
number[] | - |
high |
number[] | - |
low |
number[] | - |
close |
number[] |
Returns: Promise‹IExecutionResult‹object››
CDLENGULFING
▸ CDLENGULFING(open: number[], high: number[], low: number[], close: number[]): Promise‹IExecutionResult‹object››
Defined in index.ts:1331
CDLENGULFING - Engulfing Pattern
Parameters:
| Name | Type | Description |
|---|---|---|
open |
number[] | - |
high |
number[] | - |
low |
number[] | - |
close |
number[] |
Returns: Promise‹IExecutionResult‹object››
CDLEVENINGDOJISTAR
▸ CDLEVENINGDOJISTAR(open: number[], high: number[], low: number[], close: number[], optInPenetration: number): Promise‹IExecutionResult‹object››
Defined in index.ts:1344
CDLEVENINGDOJISTAR - Evening Doji Star
Parameters:
| Name | Type | Default | Description |
|---|---|---|---|
open |
number[] | - | - |
high |
number[] | - | - |
low |
number[] | - | - |
close |
number[] | - | - |
optInPenetration |
number | 0.3 | Penetration - Percentage of penetration of a candle within another candle = 0.3 |
Returns: Promise‹IExecutionResult‹object››
CDLEVENINGSTAR
▸ CDLEVENINGSTAR(open: number[], high: number[], low: number[], close: number[], optInPenetration: number): Promise‹IExecutionResult‹object››
Defined in index.ts:1358
CDLEVENINGSTAR - Evening Star
Parameters:
| Name | Type | Default | Description |
|---|---|---|---|
open |
number[] | - | - |
high |
number[] | - | - |
low |
number[] | - | - |
close |
number[] | - | - |
optInPenetration |
number | 0.3 | Penetration - Percentage of penetration of a candle within another candle = 0.3 |
Returns: Promise‹IExecutionResult‹object››
CDLGAPSIDESIDEWHITE
▸ CDLGAPSIDESIDEWHITE(open: number[], high: number[], low: number[], close: number[]): Promise‹IExecutionResult‹object››
Defined in index.ts:1371
CDLGAPSIDESIDEWHITE - Up/Down-gap side-by-side white lines
Parameters:
| Name | Type | Description |
|---|---|---|
open |
number[] | - |
high |
number[] | - |
low |
number[] | - |
close |
number[] |
Returns: Promise‹IExecutionResult‹object››
CDLGRAVESTONEDOJI
▸ CDLGRAVESTONEDOJI(open: number[], high: number[], low: number[], close: number[]): Promise‹IExecutionResult‹object››
Defined in index.ts:1384
CDLGRAVESTONEDOJI - Gravestone Doji
Parameters:
| Name | Type | Description |
|---|---|---|
open |
number[] | - |
high |
number[] | - |
low |
number[] | - |
close |
number[] |
Returns: Promise‹IExecutionResult‹object››
CDLHAMMER
▸ CDLHAMMER(open: number[], high: number[], low: number[], close: number[]): Promise‹IExecutionResult‹object››
Defined in index.ts:1397
CDLHAMMER - Hammer
Parameters:
| Name | Type | Description |
|---|---|---|
open |
number[] | - |
high |
number[] | - |
low |
number[] | - |
close |
number[] |
Returns: Promise‹IExecutionResult‹object››
CDLHANGINGMAN
▸ CDLHANGINGMAN(open: number[], high: number[], low: number[], close: number[]): Promise‹IExecutionResult‹object››
Defined in index.ts:1409
CDLHANGINGMAN - Hanging Man
Parameters:
| Name | Type | Description |
|---|---|---|
open |
number[] | - |
high |
number[] | - |
low |
number[] | - |
close |
number[] |
Returns: Promise‹IExecutionResult‹object››
CDLHARAMI
▸ CDLHARAMI(open: number[], high: number[], low: number[], close: number[]): Promise‹IExecutionResult‹object››
Defined in index.ts:1421
CDLHARAMI - Harami Pattern
Parameters:
| Name | Type | Description |
|---|---|---|
open |
number[] | - |
high |
number[] | - |
low |
number[] | - |
close |
number[] |
Returns: Promise‹IExecutionResult‹object››
CDLHARAMICROSS
▸ CDLHARAMICROSS(open: number[], high: number[], low: number[], close: number[]): Promise‹IExecutionResult‹object››
Defined in index.ts:1433
CDLHARAMICROSS - Harami Cross Pattern
Parameters:
| Name | Type | Description |
|---|---|---|
open |
number[] | - |
high |
number[] | - |
low |
number[] | - |
close |
number[] |
Returns: Promise‹IExecutionResult‹object››
CDLHIGHWAVE
▸ CDLHIGHWAVE(open: number[], high: number[], low: number[], close: number[]): Promise‹IExecutionResult‹object››
Defined in index.ts:1445
CDLHIGHWAVE - High-Wave Candle
Parameters:
| Name | Type | Description |
|---|---|---|
open |
number[] | - |
high |
number[] | - |
low |
number[] | - |
close |
number[] |
Returns: Promise‹IExecutionResult‹object››
CDLHIKKAKE
▸ CDLHIKKAKE(open: number[], high: number[], low: number[], close: number[]): Promise‹IExecutionResult‹object››
Defined in index.ts:1458
CDLHIKKAKE - Hikkake Pattern
Parameters:
| Name | Type | Description |
|---|---|---|
open |
number[] | - |
high |
number[] | - |
low |
number[] | - |
close |
number[] |
Returns: Promise‹IExecutionResult‹object››
CDLHIKKAKEMOD
▸ CDLHIKKAKEMOD(open: number[], high: number[], low: number[], close: number[]): Promise‹IExecutionResult‹object››
Defined in index.ts:1470
CDLHIKKAKEMOD - Modified Hikkake Pattern
Parameters:
| Name | Type | Description |
|---|---|---|
open |
number[] | - |
high |
number[] | - |
low |
number[] | - |
close |
number[] |
Returns: Promise‹IExecutionResult‹object››
CDLHOMINGPIGEON
▸ CDLHOMINGPIGEON(open: number[], high: number[], low: number[], close: number[]): Promise‹IExecutionResult‹object››
Defined in index.ts:1483
CDLHOMINGPIGEON - Homing Pigeon
Parameters:
| Name | Type | Description |
|---|---|---|
open |
number[] | - |
high |
number[] | - |
low |
number[] | - |
close |
number[] |
Returns: Promise‹IExecutionResult‹object››
CDLIDENTICAL3CROWS
▸ CDLIDENTICAL3CROWS(open: number[], high: number[], low: number[], close: number[]): Promise‹IExecutionResult‹object››
Defined in index.ts:1495
CDLIDENTICAL3CROWS - Identical Three Crows
Parameters:
| Name | Type | Description |
|---|---|---|
open |
number[] | - |
high |
number[] | - |
low |
number[] | - |
close |
number[] |
Returns: Promise‹IExecutionResult‹object››
CDLINNECK
▸ CDLINNECK(open: number[], high: number[], low: number[], close: number[]): Promise‹IExecutionResult‹object››
Defined in index.ts:1507
CDLINNECK - In-Neck Pattern
Parameters:
| Name | Type | Description |
|---|---|---|
open |
number[] | - |
high |
number[] | - |
low |
number[] | - |
close |
number[] |
Returns: Promise‹IExecutionResult‹object››
CDLINVERTEDHAMMER
▸ CDLINVERTEDHAMMER(open: number[], high: number[], low: number[], close: number[]): Promise‹IExecutionResult‹object››
Defined in index.ts:1519
CDLINVERTEDHAMMER - Inverted Hammer
Parameters:
| Name | Type | Description |
|---|---|---|
open |
number[] | - |
high |
number[] | - |
low |
number[] | - |
close |
number[] |
Returns: Promise‹IExecutionResult‹object››
CDLKICKING
▸ CDLKICKING(open: number[], high: number[], low: number[], close: number[]): Promise‹IExecutionResult‹object››
Defined in index.ts:1531
CDLKICKING - Kicking
Parameters:
| Name | Type | Description |
|---|---|---|
open |
number[] | - |
high |
number[] | - |
low |
number[] | - |
close |
number[] |
Returns: Promise‹IExecutionResult‹object››
CDLKICKINGBYLENGTH
▸ CDLKICKINGBYLENGTH(open: number[], high: number[], low: number[], close: number[]): Promise‹IExecutionResult‹object››
Defined in index.ts:1543
CDLKICKINGBYLENGTH - Kicking - bull/bear determined by the longer marubozu
Parameters:
| Name | Type | Description |
|---|---|---|
open |
number[] | - |
high |
number[] | - |
low |
number[] | - |
close |
number[] |
Returns: Promise‹IExecutionResult‹object››
CDLLADDERBOTTOM
▸ CDLLADDERBOTTOM(open: number[], high: number[], low: number[], close: number[]): Promise‹IExecutionResult‹object››
Defined in index.ts:1555
CDLLADDERBOTTOM - Ladder Bottom
Parameters:
| Name | Type | Description |
|---|---|---|
open |
number[] | - |
high |
number[] | - |
low |
number[] | - |
close |
number[] |
Returns: Promise‹IExecutionResult‹object››
CDLLONGLEGGEDDOJI
▸ CDLLONGLEGGEDDOJI(open: number[], high: number[], low: number[], close: number[]): Promise‹IExecutionResult‹object››
Defined in index.ts:1567
CDLLONGLEGGEDDOJI - Long Legged Doji
Parameters:
| Name | Type | Description |
|---|---|---|
open |
number[] | - |
high |
number[] | - |
low |
number[] | - |
close |
number[] |
Returns: Promise‹IExecutionResult‹object››
CDLLONGLINE
▸ CDLLONGLINE(open: number[], high: number[], low: number[], close: number[]): Promise‹IExecutionResult‹object››
Defined in index.ts:1579
CDLLONGLINE - Long Line Candle
Parameters:
| Name | Type | Description |
|---|---|---|
open |
number[] | - |
high |
number[] | - |
low |
number[] | - |
close |
number[] |
Returns: Promise‹IExecutionResult‹object››
CDLMARUBOZU
▸ CDLMARUBOZU(open: number[], high: number[], low: number[], close: number[]): Promise‹IExecutionResult‹object››
Defined in index.ts:1591
CDLMARUBOZU - Marubozu
Parameters:
| Name | Type | Description |
|---|---|---|
open |
number[] | - |
high |
number[] | - |
low |
number[] | - |
close |
number[] |
Returns: Promise‹IExecutionResult‹object››
CDLMATCHINGLOW
▸ CDLMATCHINGLOW(open: number[], high: number[], low: number[], close: number[]): Promise‹IExecutionResult‹object››
Defined in index.ts:1603
CDLMATCHINGLOW - Matching Low
Parameters:
| Name | Type | Description |
|---|---|---|
open |
number[] | - |
high |
number[] | - |
low |
number[] | - |
close |
number[] |
Returns: Promise‹IExecutionResult‹object››
CDLMATHOLD
▸ CDLMATHOLD(open: number[], high: number[], low: number[], close: number[], optInPenetration: number): Promise‹IExecutionResult‹object››
Defined in index.ts:1617
CDLMATHOLD - Mat Hold
Parameters:
| Name | Type | Default | Description |
|---|---|---|---|
open |
number[] | - | - |
high |
number[] | - | - |
low |
number[] | - | - |
close |
number[] | - | - |
optInPenetration |
number | 0.5 | Penetration - Percentage of penetration of a candle within another candle = 0.5 |
Returns: Promise‹IExecutionResult‹object››
CDLMORNINGDOJISTAR
▸ CDLMORNINGDOJISTAR(open: number[], high: number[], low: number[], close: number[], optInPenetration: number): Promise‹IExecutionResult‹object››
Defined in index.ts:1630
CDLMORNINGDOJISTAR - Morning Doji Star
Parameters:
| Name | Type | Default | Description |
|---|---|---|---|
open |
number[] | - | - |
high |
number[] | - | - |
low |
number[] | - | - |
close |
number[] | - | - |
optInPenetration |
number | 0.3 | Penetration - Percentage of penetration of a candle within another candle = 0.3 |
Returns: Promise‹IExecutionResult‹object››
CDLMORNINGSTAR
▸ CDLMORNINGSTAR(open: number[], high: number[], low: number[], close: number[], optInPenetration: number): Promise‹IExecutionResult‹object››
Defined in index.ts:1643
CDLMORNINGSTAR - Morning Star
Parameters:
| Name | Type | Default | Description |
|---|---|---|---|
open |
number[] | - | - |
high |
number[] | - | - |
low |
number[] | - | - |
close |
number[] | - | - |
optInPenetration |
number | 0.3 | Penetration - Percentage of penetration of a candle within another candle = 0.3 |
Returns: Promise‹IExecutionResult‹object››
CDLONNECK
▸ CDLONNECK(open: number[], high: number[], low: number[], close: number[]): Promise‹IExecutionResult‹object››
Defined in index.ts:1655
CDLONNECK - On-Neck Pattern
Parameters:
| Name | Type | Description |
|---|---|---|
open |
number[] | - |
high |
number[] | - |
low |
number[] | - |
close |
number[] |
Returns: Promise‹IExecutionResult‹object››
CDLPIERCING
▸ CDLPIERCING(open: number[], high: number[], low: number[], close: number[]): Promise‹IExecutionResult‹object››
Defined in index.ts:1667
CDLPIERCING - Piercing Pattern
Parameters:
| Name | Type | Description |
|---|---|---|
open |
number[] | - |
high |
number[] | - |
low |
number[] | - |
close |
number[] |
Returns: Promise‹IExecutionResult‹object››
CDLRICKSHAWMAN
▸ CDLRICKSHAWMAN(open: number[], high: number[], low: number[], close: number[]): Promise‹IExecutionResult‹object››
Defined in index.ts:1679
CDLRICKSHAWMAN - Rickshaw Man
Parameters:
| Name | Type | Description |
|---|---|---|
open |
number[] | - |
high |
number[] | - |
low |
number[] | - |
close |
number[] |
Returns: Promise‹IExecutionResult‹object››
CDLRISEFALL3METHODS
▸ CDLRISEFALL3METHODS(open: number[], high: number[], low: number[], close: number[]): Promise‹IExecutionResult‹object››
Defined in index.ts:1691
CDLRISEFALL3METHODS - Rising/Falling Three Methods
Parameters:
| Name | Type | Description |
|---|---|---|
open |
number[] | - |
high |
number[] | - |
low |
number[] | - |
close |
number[] |
Returns: Promise‹IExecutionResult‹object››
CDLSEPARATINGLINES
▸ CDLSEPARATINGLINES(open: number[], high: number[], low: number[], close: number[]): Promise‹IExecutionResult‹object››
Defined in index.ts:1703
CDLSEPARATINGLINES - Separating Lines
Parameters:
| Name | Type | Description |
|---|---|---|
open |
number[] | - |
high |
number[] | - |
low |
number[] | - |
close |
number[] |
Returns: Promise‹IExecutionResult‹object››
CDLSHOOTINGSTAR
▸ CDLSHOOTINGSTAR(open: number[], high: number[], low: number[], close: number[]): Promise‹IExecutionResult‹object››
Defined in index.ts:1715
CDLSHOOTINGSTAR - Shooting Star
Parameters:
| Name | Type | Description |
|---|---|---|
open |
number[] | - |
high |
number[] | - |
low |
number[] | - |
close |
number[] |
Returns: Promise‹IExecutionResult‹object››
CDLSHORTLINE
▸ CDLSHORTLINE(open: number[], high: number[], low: number[], close: number[]): Promise‹IExecutionResult‹object››
Defined in index.ts:1727
CDLSHORTLINE - Short Line Candle
Parameters:
| Name | Type | Description |
|---|---|---|
open |
number[] | - |
high |
number[] | - |
low |
number[] | - |
close |
number[] |
Returns: Promise‹IExecutionResult‹object››
CDLSPINNINGTOP
▸ CDLSPINNINGTOP(open: number[], high: number[], low: number[], close: number[]): Promise‹IExecutionResult‹object››
Defined in index.ts:1739
CDLSPINNINGTOP - Spinning Top
Parameters:
| Name | Type | Description |
|---|---|---|
open |
number[] | - |
high |
number[] | - |
low |
number[] | - |
close |
number[] |
Returns: Promise‹IExecutionResult‹object››
CDLSTALLEDPATTERN
▸ CDLSTALLEDPATTERN(open: number[], high: number[], low: number[], close: number[]): Promise‹IExecutionResult‹object››
Defined in index.ts:1751
CDLSTALLEDPATTERN - Stalled Pattern
Parameters:
| Name | Type | Description |
|---|---|---|
open |
number[] | - |
high |
number[] | - |
low |
number[] | - |
close |
number[] |
Returns: Promise‹IExecutionResult‹object››
CDLSTICKSANDWICH
▸ CDLSTICKSANDWICH(open: number[], high: number[], low: number[], close: number[]): Promise‹IExecutionResult‹object››
Defined in index.ts:1763
CDLSTICKSANDWICH - Stick Sandwich
Parameters:
| Name | Type | Description |
|---|---|---|
open |
number[] | - |
high |
number[] | - |
low |
number[] | - |
close |
number[] |
Returns: Promise‹IExecutionResult‹object››
CDLTAKURI
▸ CDLTAKURI(open: number[], high: number[], low: number[], close: number[]): Promise‹IExecutionResult‹object››
Defined in index.ts:1775
CDLTAKURI - Takuri (Dragonfly Doji with very long lower shadow)
Parameters:
| Name | Type | Description |
|---|---|---|
open |
number[] | - |
high |
number[] | - |
low |
number[] | - |
close |
number[] |
Returns: Promise‹IExecutionResult‹object››
CDLTASUKIGAP
▸ CDLTASUKIGAP(open: number[], high: number[], low: number[], close: number[]): Promise‹IExecutionResult‹object››
Defined in index.ts:1787
CDLTASUKIGAP - Tasuki Gap
Parameters:
| Name | Type | Description |
|---|---|---|
open |
number[] | - |
high |
number[] | - |
low |
number[] | - |
close |
number[] |
Returns: Promise‹IExecutionResult‹object››
CDLTHRUSTING
▸ CDLTHRUSTING(open: number[], high: number[], low: number[], close: number[]): Promise‹IExecutionResult‹object››
Defined in index.ts:1799
CDLTHRUSTING - Thrusting Pattern
Parameters:
| Name | Type | Description |
|---|---|---|
open |
number[] | - |
high |
number[] | - |
low |
number[] | - |
close |
number[] |
Returns: Promise‹IExecutionResult‹object››
CDLTRISTAR
▸ CDLTRISTAR(open: number[], high: number[], low: number[], close: number[]): Promise‹IExecutionResult‹object››
Defined in index.ts:1811
CDLTRISTAR - Tristar Pattern
Parameters:
| Name | Type | Description |
|---|---|---|
open |
number[] | - |
high |
number[] | - |
low |
number[] | - |
close |
number[] |
Returns: Promise‹IExecutionResult‹object››
CDLUNIQUE3RIVER
▸ CDLUNIQUE3RIVER(open: number[], high: number[], low: number[], close: number[]): Promise‹IExecutionResult‹object››
Defined in index.ts:1823
CDLUNIQUE3RIVER - Unique 3 River
Parameters:
| Name | Type | Description |
|---|---|---|
open |
number[] | - |
high |
number[] | - |
low |
number[] | - |
close |
number[] |
Returns: Promise‹IExecutionResult‹object››
CDLUPSIDEGAP2CROWS
▸ CDLUPSIDEGAP2CROWS(open: number[], high: number[], low: number[], close: number[]): Promise‹IExecutionResult‹object››
Defined in index.ts:1835
CDLUPSIDEGAP2CROWS - Upside Gap Two Crows
Parameters:
| Name | Type | Description |
|---|---|---|
open |
number[] | - |
high |
number[] | - |
low |
number[] | - |
close |
number[] |
Returns: Promise‹IExecutionResult‹object››
CDLXSIDEGAP3METHODS
▸ CDLXSIDEGAP3METHODS(open: number[], high: number[], low: number[], close: number[]): Promise‹IExecutionResult‹object››
Defined in index.ts:1848
CDLXSIDEGAP3METHODS - Upside/Downside Gap Three Methods
Parameters:
| Name | Type | Description |
|---|---|---|
open |
number[] | - |
high |
number[] | - |
low |
number[] | - |
close |
number[] |
Returns: Promise‹IExecutionResult‹object››
Price Transform Functions
AVGPRICE
▸ AVGPRICE(open: number[], high: number[], low: number[], close: number[]): Promise‹IExecutionResult‹object››
Defined in index.ts:1951
AVGPRICE - Average Price
Parameters:
| Name | Type |
|---|---|
open |
number[] |
high |
number[] |
low |
number[] |
close |
number[] |
Returns: Promise‹IExecutionResult‹object››
MEDPRICE
▸ MEDPRICE(high: number[], low: number[]): Promise‹IExecutionResult‹object››
Defined in index.ts:1961
MEDPRICE - Median Price
Parameters:
| Name | Type | Description |
|---|---|---|
high |
number[] | - |
low |
number[] |
Returns: Promise‹IExecutionResult‹object››
TYPPRICE
▸ TYPPRICE(high: number[], low: number[], close: number[]): Promise‹IExecutionResult‹object››
Defined in index.ts:1969
TYPPRICE - Typical Price
Parameters:
| Name | Type |
|---|---|
high |
number[] |
low |
number[] |
close |
number[] |
Returns: Promise‹IExecutionResult‹object››
WCLPRICE
▸ WCLPRICE(high: number[], low: number[], close: number[]): Promise‹IExecutionResult‹object››
Defined in index.ts:1977
WCLPRICE - Weighted Close Price
Parameters:
| Name | Type |
|---|---|
high |
number[] |
low |
number[] |
close |
number[] |
Returns: Promise‹IExecutionResult‹object››
Statistic Functions Functions
BETA
▸ BETA(inReal0: number[], inReal1: number[], optInTimePeriod: number): Promise‹IExecutionResult‹object››
Defined in index.ts:1859
BETA - Beta
Parameters:
| Name | Type | Default | Description |
|---|---|---|---|
inReal0 |
number[] | - | - |
inReal1 |
number[] | - | - |
optInTimePeriod |
number | 5 | Time Period - Number of period = 5 |
Returns: Promise‹IExecutionResult‹object››
CORREL
▸ CORREL(inReal0: number[], inReal1: number[], optInTimePeriod: number): Promise‹IExecutionResult‹object››
Defined in index.ts:1870
CORREL - Pearson's Correlation Coefficient (r)
Parameters:
| Name | Type | Default | Description |
|---|---|---|---|
inReal0 |
number[] | - | - |
inReal1 |
number[] | - | - |
optInTimePeriod |
number | 30 | Time Period - Number of period = 30 |
Returns: Promise‹IExecutionResult‹object››
LINEARREG
▸ LINEARREG(inReal: number[], optInTimePeriod: number): Promise‹IExecutionResult‹object››
Defined in index.ts:1881
LINEARREG - Linear Regression
Parameters:
| Name | Type | Default | Description |
|---|---|---|---|
inReal |
number[] | - | - |
optInTimePeriod |
number | 14 | Time Period - Number of period = 14 |
Returns: Promise‹IExecutionResult‹object››
LINEARREG_ANGLE
▸ LINEARREG_ANGLE(inReal: number[], optInTimePeriod: number): Promise‹IExecutionResult‹object››
Defined in index.ts:1891
LINEARREG_ANGLE - Linear Regression Angle
Parameters:
| Name | Type | Default | Description |
|---|---|---|---|
inReal |
number[] | - | - |
optInTimePeriod |
number | 14 | Time Period - Number of period = 14 |
Returns: Promise‹IExecutionResult‹object››
LINEARREG_INTERCEPT
▸ LINEARREG_INTERCEPT(inReal: number[], optInTimePeriod: number): Promise‹IExecutionResult‹object››
Defined in index.ts:1901
LINEARREG_INTERCEPT - Linear Regression Intercept
Parameters:
| Name | Type | Default | Description |
|---|---|---|---|
inReal |
number[] | - | - |
optInTimePeriod |
number | 14 | Time Period - Number of period = 14 |
Returns: Promise‹IExecutionResult‹object››
LINEARREG_SLOPE
▸ LINEARREG_SLOPE(inReal: number[], optInTimePeriod: number): Promise‹IExecutionResult‹object››
Defined in index.ts:1912
LINEARREG_SLOPE - Linear Regression Slope
Parameters:
| Name | Type | Default | Description |
|---|---|---|---|
inReal |
number[] | - | - |
optInTimePeriod |
number | 14 | Time Period - Number of period = 14 |
Returns: Promise‹IExecutionResult‹object››
STDDEV
▸ STDDEV(inReal: number[], optInTimePeriod: number, optInNbDev: number): Promise‹IExecutionResult‹object››
Defined in index.ts:1923
STDDEV - Standard Deviation
Parameters:
| Name | Type | Default | Description |
|---|---|---|---|
inReal |
number[] | - | - |
optInTimePeriod |
number | 5 | Time Period - Number of period = 5 |
optInNbDev |
number | 1 | Deviations - Nb of deviations = 1 |
Returns: Promise‹IExecutionResult‹object››
TSF
▸ TSF(inReal: number[], optInTimePeriod: number): Promise‹IExecutionResult‹object››
Defined in index.ts:1932
TSF - Time Series Forecast
Parameters:
| Name | Type | Default | Description |
|---|---|---|---|
inReal |
number[] | - | - |
optInTimePeriod |
number | 14 | Time Period - Number of period = 14 |
Returns: Promise‹IExecutionResult‹object››
VAR
▸ VAR(inReal: number[], optInTimePeriod: number, optInNbDev: number): Promise‹IExecutionResult‹object››
Defined in index.ts:1943
VAR - Variance
Parameters:
| Name | Type | Default | Description |
|---|---|---|---|
inReal |
number[] | - | - |
optInTimePeriod |
number | 5 | Time Period - Number of period = 5 |
optInNbDev |
number | 1 | Deviations - Nb of deviations = 1 |
Returns: Promise‹IExecutionResult‹object››
Volatility Indicators Functions
ATR
▸ ATR(high: number[], low: number[], close: number[], optInTimePeriod: number): Promise‹IExecutionResult‹object››
Defined in index.ts:586
ATR - Average True Range
Parameters:
| Name | Type | Default | Description |
|---|---|---|---|
high |
number[] | - | - |
low |
number[] | - | - |
close |
number[] | - | - |
optInTimePeriod |
number | 14 | Time Period - Number of period = 14 |
Returns: Promise‹IExecutionResult‹object››
NATR
▸ NATR(high: number[], low: number[], close: number[], optInTimePeriod: number): Promise‹IExecutionResult‹object››
Defined in index.ts:599
NATR - Normalized Average True Range
Parameters:
| Name | Type | Default | Description |
|---|---|---|---|
high |
number[] | - | - |
low |
number[] | - | - |
close |
number[] | - | - |
optInTimePeriod |
number | 14 | Time Period - Number of period = 14 |
Returns: Promise‹IExecutionResult‹object››
TRANGE
▸ TRANGE(high: number[], low: number[], close: number[]): Promise‹IExecutionResult‹object››
Defined in index.ts:611
TRANGE - True Range
Parameters:
| Name | Type | Description |
|---|---|---|
high |
number[] | - |
low |
number[] | - |
close |
number[] |
Returns: Promise‹IExecutionResult‹object››
Volume Indicators Functions
AD
▸ AD(high: number[], low: number[], close: number[], volume: number[]): Promise‹IExecutionResult‹object››
Defined in index.ts:1056
AD - Chaikin A/D Line
Parameters:
| Name | Type | Description |
|---|---|---|
high |
number[] | - |
low |
number[] | - |
close |
number[] | - |
volume |
number[] |
Returns: Promise‹IExecutionResult‹object››
ADOSC
▸ ADOSC(high: number[], low: number[], close: number[], volume: number[], optInFastPeriod: number, optInSlowPeriod: number): Promise‹IExecutionResult‹object››
Defined in index.ts:1071
ADOSC - Chaikin A/D Oscillator
Parameters:
| Name | Type | Default | Description |
|---|---|---|---|
high |
number[] | - | - |
low |
number[] | - | - |
close |
number[] | - | - |
volume |
number[] | - | - |
optInFastPeriod |
number | 3 | Fast Period - Number of period for the fast MA = 3 |
optInSlowPeriod |
number | 10 | Slow Period - Number of period for the slow MA = 10 |
Returns: Promise‹IExecutionResult‹object››
OBV
▸ OBV(inReal: number[], volume: number[]): Promise‹IExecutionResult‹object››
Defined in index.ts:1082
OBV - On Balance Volume
Parameters:
| Name | Type | Description |
|---|---|---|
inReal |
number[] | - |
volume |
number[] |
Returns: Promise‹IExecutionResult‹object››