@mathieuc/tradingview 3.2.0 → 3.3.2

package/.eslintrc.js

@@ -14,5 +14,11 @@ module.exports = {
   },
   rules: {
     'no-console': 'off',
+    'import/no-extraneous-dependencies': [
+      'error',
+      {
+        devDependencies: ['./test.js', './tests/**'],
+      },
+    ],
   },
 };

package/README.md

@@ -1,14 +1,16 @@
-# TradingView API [![Open in Visual Studio Code](https://open.vscode.dev/badges/open-in-vscode.svg)](https://open.vscode.dev/Mathieu2301/TradingView-API) [![GitHub stars](https://img.shields.io/github/stars/Mathieu2301/TradingView-API.svg?style=social&label=Star&maxAge=2592000)](https://GitHub.com/Mathieu2301/TradingView-API/stargazers/)
+# TradingView API [![GitHub stars](https://img.shields.io/github/stars/Mathieu2301/TradingView-API.svg?style=social&label=Star&maxAge=2592000)](https://GitHub.com/Mathieu2301/TradingView-API/stargazers/)
 
 [![Tests](https://github.com/Mathieu2301/TradingView-API/actions/workflows/node.js.yml/badge.svg)](https://github.com/Mathieu2301/TradingView-API/actions/workflows/node.js.yml)
-[![Minimum node.js version](https://badgen.net/npm/node/@mathieuc/tradingview)](https://npmjs.com/@mathieuc/tradingview)
-[![Npm package yearly downloads](https://badgen.net/npm/dt/@mathieuc/tradingview)](https://npmjs.com/@mathieuc/tradingview)
+[![CodeFactor](https://www.codefactor.io/repository/github/mathieu2301/tradingview-api/badge/main)](https://www.codefactor.io/repository/github/mathieu2301/tradingview-api/overview/main)
 [![GitHub latest commit](https://img.shields.io/github/last-commit/Mathieu2301/TradingView-API)](https://GitHub.com/Mathieu2301/TradingView-API/commit/)
+[![Npm package yearly downloads](https://badgen.net/npm/dt/@mathieuc/tradingview)](https://npmjs.com/@mathieuc/tradingview)
+[![Minimum node.js version](https://badgen.net/npm/node/@mathieuc/tradingview)](https://npmjs.com/@mathieuc/tradingview)
 [![Npm package version](https://badgen.net/npm/v/@mathieuc/tradingview)](https://npmjs.com/package/@mathieuc/tradingview)
 
 Get realtime market prices and indicator values from Tradingview !
 
 ## Features
+
 - [x] Premium features
 - [x] Automatically backtest many strategies and try many settings in a very little time
 - [x] Get drawings you made on your chart
@@ -26,6 +28,7 @@ Get realtime market prices and indicator values from Tradingview !
 - IF YOU WANT A FEATURE, ASK ME !
 
 ## Possibilities
+
 - Trading bot
 - Discord alerts
 - Hard backtest
@@ -33,21 +36,31 @@ Get realtime market prices and indicator values from Tradingview !
 - Free replay mode for all timeframes
 
 ___
+
 ## Installation
 
 Stable version:
+
 ```ruby
 npm i @mathieuc/tradingview
 ```
+
 Last version:
+
 ```ruby
 npm i github:Mathieu2301/TradingView-API
 ```
 
 ## Examples
+
 You can find all the examples and snippets in `./examples` folder.
 
+## Before opening an issue
+
+Please look at examples and previously resolved issues before opening a new one. I can't help everyone (especially for questions that are not library related but JavaScript related). Thank you for your understanding.
 ___
+
 ## Problems
+
  If you have errors in console or unwanted behavior,
  please create an issue [here](https://github.com/Mathieu2301/Tradingview-API/issues).

package/docs/DOCS.md

@@ -0,0 +1,3 @@
+# Documentation
+
+### All the project is now JSDoc-ed :)

package/examples/BuiltInIndicator.js

@@ -7,7 +7,7 @@ const TradingView = require('../main');
 
 const volumeProfile = new TradingView.BuiltInIndicator('VbPFixed@tv-basicstudies-139!');
 
-if (!process.argv[2] && volumeProfile.type !== 'VbPFixed@tv-basicstudies-139!') {
+if (!process.argv[2] && !['VbPFixed@tv-basicstudies-139!', 'Volume@tv-basicstudies-144'].includes(volumeProfile.type)) {
   throw Error('Please specify your \'sessionid\' cookie');
 }
 

package/examples/GetDrawings.js

@@ -0,0 +1,26 @@
+const TradingView = require('../main');
+
+/*
+  This example tests the
+  getDrawings function
+*/
+
+// First parameter must be the layoutID
+// (if the layout is private) Second parameter must be the sessionid cookie
+// (if the layout is private) Third parameter must be the userid (you can use getUser function)
+
+if (!process.argv[2]) throw Error('Please specify a layoutID');
+
+TradingView.getDrawings(process.argv[2], null, {
+  session: process.argv[3],
+  id: process.argv[4],
+}).then((drawings) => {
+  console.log(`Found ${drawings.length} drawings:`, drawings.map((d) => ({
+    id: d.id,
+    symbol: d.symbol,
+    type: d.type,
+    text: d.state.text,
+  })));
+}).catch((err) => {
+  console.error('Error:', err.message);
+});

package/examples/UserLogin.js

@@ -0,0 +1,16 @@
+const TradingView = require('../main');
+
+/*
+  This example tests the
+  user login function
+*/
+
+if (!process.argv[2]) throw Error('Please specify your username/email');
+if (!process.argv[3]) throw Error('Please specify your password');
+
+TradingView.loginUser(process.argv[2], process.argv[3], false).then((user) => {
+  console.log('User:', user);
+  console.log('Sessionid:', user.session);
+}).catch((err) => {
+  console.error('Login error:', err.message);
+});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mathieuc/tradingview",
-  "version": "3.2.0",
+  "version": "3.3.2",
   "description": "Tradingview instant stocks API, indicator alerts, trading bot, and more !",
   "main": "main.js",
   "scripts": {
@@ -34,7 +34,6 @@
     "@mathieuc/console": "^1.0.1",
     "eslint": "^7.25.0",
     "eslint-config-airbnb-base": "^14.2.1",
-    "eslint-plugin-import": "^2.22.1",
-    "jsdoc-to-markdown": "^7.1.0"
+    "eslint-plugin-import": "^2.22.1"
   }
 }

package/src/FormData.js

@@ -1,3 +1,4 @@
+/** @class */
 class FormData {
   #string = '';
 

package/src/chart/session.js

@@ -64,7 +64,9 @@ const ChartTypes = {
  * @prop {string} session Session (ex: '24x7')
  * @prop {string} session-correction Session correction
  * @prop {string} session-display Session display (ex: '24x7')
- *
+ */
+
+/**
  * @typedef {Object} MarketInfos
  * @prop {string} series_id            Used series (ex: 'ser_1')
  * @prop {string} base_currency        Base currency (ex: 'BTC')
@@ -120,7 +122,7 @@ module.exports = (client) => class ChartSession {
   #replayMode = false;
 
   /** @type {Object<string, (): any>} */
-  #replayOKCB = {}
+  #replayOKCB = {};
 
   /** Parent client */
   #client = client;

package/src/chart/study.js

@@ -16,11 +16,11 @@ function getInputs(options) {
     if (options.pineId) pineInputs.pineId = options.pineId;
     if (options.pineVersion) pineInputs.pineVersion = options.pineVersion;
 
-    Object.keys(options.inputs).forEach((inputID) => {
+    Object.keys(options.inputs).forEach((inputID, n) => {
       const input = options.inputs[inputID];
 
       pineInputs[inputID] = {
-        v: input.value,
+        v: (input.type !== 'color') ? input.value : n,
         f: input.isFake,
         t: input.type,
       };
@@ -35,80 +35,80 @@ function getInputs(options) {
 /**
  * @typedef {Object} TradeReport Trade report
 
- * @property {Object} entry Trade entry
- * @property {string} entry.name Trade name
- * @property {'long' | 'short'} entry.type Entry type (long/short)
- * @property {number} entry.value Entry price value
- * @property {number} entry.time Entry timestamp
-
- * @property {Object} exit Trade exit
- * @property {'' | string} exit.name Trade name ('' if false exit)
- * @property {number} exit.value Exit price value
- * @property {number} exit.time Exit timestamp
-
- * @property {number} quantity Trade quantity
- * @property {RelAbsValue} profit Trade profit
- * @property {RelAbsValue} cumulative Trade cummulative profit
- * @property {RelAbsValue} runup Trade run-up
- * @property {RelAbsValue} drawdown Trade drawdown
+ * @prop {Object} entry Trade entry
+ * @prop {string} entry.name Trade name
+ * @prop {'long' | 'short'} entry.type Entry type (long/short)
+ * @prop {number} entry.value Entry price value
+ * @prop {number} entry.time Entry timestamp
+
+ * @prop {Object} exit Trade exit
+ * @prop {'' | string} exit.name Trade name ('' if false exit)
+ * @prop {number} exit.value Exit price value
+ * @prop {number} exit.time Exit timestamp
+
+ * @prop {number} quantity Trade quantity
+ * @prop {RelAbsValue} profit Trade profit
+ * @prop {RelAbsValue} cumulative Trade cummulative profit
+ * @prop {RelAbsValue} runup Trade run-up
+ * @prop {RelAbsValue} drawdown Trade drawdown
  */
 
 /**
  * @typedef {Object} PerfReport
- * @property {number} avgBarsInTrade Average bars in trade
- * @property {number} avgBarsInWinTrade Average bars in winning trade
- * @property {number} avgBarsInLossTrade Average bars in losing trade
- * @property {number} avgTrade Average trade gain
- * @property {number} avgTradePercent Average trade performace
- * @property {number} avgLosTrade Average losing trade gain
- * @property {number} avgLosTradePercent Average losing trade performace
- * @property {number} avgWinTrade Average winning trade gain
- * @property {number} avgWinTradePercent Average winning trade performace
- * @property {number} commissionPaid Commission paid
- * @property {number} grossLoss Gross loss value
- * @property {number} grossLossPercent Gross loss percent
- * @property {number} grossProfit Gross profit
- * @property {number} grossProfitPercent Gross profit percent
- * @property {number} largestLosTrade Largest losing trade gain
- * @property {number} largestLosTradePercent Largent losing trade performance (percentage)
- * @property {number} largestWinTrade Largest winning trade gain
- * @property {number} largestWinTradePercent Largest winning trade performance (percentage)
- * @property {number} marginCalls Margin calls
- * @property {number} maxContractsHeld Max Contracts Held
- * @property {number} netProfit Net profit
- * @property {number} netProfitPercent Net performance (percentage)
- * @property {number} numberOfLosingTrades Number of losing trades
- * @property {number} numberOfWiningTrades Number of winning trades
- * @property {number} percentProfitable Strategy winrate
- * @property {number} profitFactor Profit factor
- * @property {number} ratioAvgWinAvgLoss Ratio Average Win / Average Loss
- * @property {number} totalOpenTrades Total open trades
- * @property {number} totalTrades Total trades
+ * @prop {number} avgBarsInTrade Average bars in trade
+ * @prop {number} avgBarsInWinTrade Average bars in winning trade
+ * @prop {number} avgBarsInLossTrade Average bars in losing trade
+ * @prop {number} avgTrade Average trade gain
+ * @prop {number} avgTradePercent Average trade performace
+ * @prop {number} avgLosTrade Average losing trade gain
+ * @prop {number} avgLosTradePercent Average losing trade performace
+ * @prop {number} avgWinTrade Average winning trade gain
+ * @prop {number} avgWinTradePercent Average winning trade performace
+ * @prop {number} commissionPaid Commission paid
+ * @prop {number} grossLoss Gross loss value
+ * @prop {number} grossLossPercent Gross loss percent
+ * @prop {number} grossProfit Gross profit
+ * @prop {number} grossProfitPercent Gross profit percent
+ * @prop {number} largestLosTrade Largest losing trade gain
+ * @prop {number} largestLosTradePercent Largent losing trade performance (percentage)
+ * @prop {number} largestWinTrade Largest winning trade gain
+ * @prop {number} largestWinTradePercent Largest winning trade performance (percentage)
+ * @prop {number} marginCalls Margin calls
+ * @prop {number} maxContractsHeld Max Contracts Held
+ * @prop {number} netProfit Net profit
+ * @prop {number} netProfitPercent Net performance (percentage)
+ * @prop {number} numberOfLosingTrades Number of losing trades
+ * @prop {number} numberOfWiningTrades Number of winning trades
+ * @prop {number} percentProfitable Strategy winrate
+ * @prop {number} profitFactor Profit factor
+ * @prop {number} ratioAvgWinAvgLoss Ratio Average Win / Average Loss
+ * @prop {number} totalOpenTrades Total open trades
+ * @prop {number} totalTrades Total trades
 */
 
 /**
  * @typedef {Object} StrategyReport
- * @property {'EUR' | 'USD' | 'JPY' | '' | 'CHF'} [currency] Selected currency
- * @property {TradeReport[]} trades Trade list starting by the last
- * @property {Object} history History Chart value
- * @property {number[]} [history.buyHold] Buy hold values
- * @property {number[]} [history.buyHoldPercent] Buy hold percent values
- * @property {number[]} [history.drawDown] Drawdown values
- * @property {number[]} [history.drawDownPercent] Drawdown percent values
- * @property {number[]} [history.equity] Equity values
- * @property {number[]} [history.equityPercent] Equity percent values
- * @property {Object} performance Strategy performance
- * @property {PerfReport} [performance.all] Strategy long/short performances
- * @property {PerfReport} [performance.long] Strategy long performances
- * @property {PerfReport} [performance.short] Strategy short performances
- * @property {number} [performance.buyHoldReturn] Strategy Buy & Hold Return
- * @property {number} [performance.buyHoldReturnPercent] Strategy Buy & Hold Return percent
- * @property {number} [performance.maxDrawDown] Strategy max drawdown
- * @property {number} [performance.maxDrawDownPercent] Strategy max drawdown percent
- * @property {number} [performance.openPL] Strategy Open P&L (Profit And Loss)
- * @property {number} [performance.openPLPercent] Strategy Open P&L (Profit And Loss) percent
- * @property {number} [performance.sharpeRatio] Strategy Sharpe Ratio
- * @property {number} [performance.sortinoRatio] Strategy Sortino Ratio
+ * @prop {'EUR' | 'USD' | 'JPY' | '' | 'CHF'} [currency] Selected currency
+ * @prop {TradeReport[]} trades Trade list starting by the last
+ * @prop {Object} history History Chart value
+ * @prop {number[]} [history.buyHold] Buy hold values
+ * @prop {number[]} [history.buyHoldPercent] Buy hold percent values
+ * @prop {number[]} [history.drawDown] Drawdown values
+ * @prop {number[]} [history.drawDownPercent] Drawdown percent values
+ * @prop {number[]} [history.equity] Equity values
+ * @prop {number[]} [history.equityPercent] Equity percent values
+ * @prop {Object} performance Strategy performance
+ * @prop {PerfReport} [performance.all] Strategy long/short performances
+ * @prop {PerfReport} [performance.long] Strategy long performances
+ * @prop {PerfReport} [performance.short] Strategy short performances
+ * @prop {number} [performance.buyHoldReturn] Strategy Buy & Hold Return
+ * @prop {number} [performance.buyHoldReturnPercent] Strategy Buy & Hold Return percent
+ * @prop {number} [performance.maxDrawDown] Strategy max drawdown
+ * @prop {number} [performance.maxDrawDownPercent] Strategy max drawdown percent
+ * @prop {number} [performance.openPL] Strategy Open P&L (Profit And Loss)
+ * @prop {number} [performance.openPLPercent] Strategy Open P&L (Profit And Loss) percent
+ * @prop {number} [performance.sharpeRatio] Strategy Sharpe Ratio
+ * @prop {number} [performance.sortinoRatio] Strategy Sortino Ratio
  */
 
 /**
@@ -280,6 +280,16 @@ module.exports = (chartSession) => class ChartStudy {
             changes.push('perfReport');
           }
 
+          if (parsed.data && parsed.data.report && parsed.data.report.trades) {
+            this.#strategyReport.trades = parsed.data.report.trades;
+            changes.push('tradesReport');
+          }
+
+          if (parsed.data && parsed.data.report && parsed.data.report.history) {
+            this.#strategyReport.history = parsed.data.report.history;
+            changes.push('historyReport');
+          }
+
           if (parsed.dataCompressed) {
             const parsedC = await parseCompressed(parsed.dataCompressed);
 
@@ -372,7 +382,11 @@ module.exports = (chartSession) => class ChartStudy {
     this.#callbacks.studyCompleted.push(cb);
   }
 
-  /** @typedef {'plots' | 'perfReport' | 'fullReport'} UpdateChangeType */
+  /**
+   * @typedef {
+   *  'plots' | 'perfReport' | 'tradesReport' | 'historyReport' | 'fullReport'
+   * } UpdateChangeType
+   */
 
   /**
    * When an indicator update happens

package/src/classes/BuiltInIndicator.js

@@ -68,6 +68,7 @@ const defaultValues = {
   },
 };
 
+/** @class */
 module.exports = class BuiltInIndicator {
   /** @type {BuiltInIndicatorType} */
   #type;

package/src/classes/PineIndicator.js

@@ -4,7 +4,9 @@
  * @property {string} inline Input inline name
  * @property {string} [internalID] Input internal ID
  * @property {string} [tooltip] Input tooltip
- * @property {'text' | 'source' | 'integer' | 'float' | 'resolution' | 'bool'} type Input type
+ * @property {'text' | 'source' | 'integer'
+ *  | 'float' | 'resolution' | 'bool' | 'color'
+ * } type Input type
  * @property {string | number | boolean} value Input default value
  * @property {boolean} isHidden If the input is hidden
  * @property {boolean} isFake If the input is fake
@@ -26,6 +28,8 @@
  * @typedef {'Script@tv-scripting-101!'
  *  | 'StrategyScript@tv-scripting-101!'} IndicatorType Indicator type
  */
+
+/** @class */
 module.exports = class PineIndicator {
   #options;
 
@@ -113,12 +117,8 @@ module.exports = class PineIndicator {
         text: 'String',
       };
 
-      if (
-        (input.type === 'bool' && typeof value !== 'boolean')
-        || (input.type === 'integer' && typeof value !== 'number')
-        || (input.type === 'float' && typeof value !== 'number')
-        || (input.type === 'text' && typeof value !== 'string')
-      ) {
+      // eslint-disable-next-line valid-typeof
+      if (types[input.type] && typeof value !== types[input.type].toLowerCase()) {
         throw new Error(`Input '${input.name}' (${propI}) must be a ${types[input.type]} !`);
       }
 

package/src/classes/PinePermManager.js

@@ -10,6 +10,7 @@ const FormData = require('../FormData');
  * @prop {string} created Authorization creation date
  */
 
+/** @class */
 class PinePermManager {
   sessionId;
 
@@ -39,7 +40,7 @@ class PinePermManager {
    * @returns {AuthorizationUser[]}
    */
   async getUsers(limit = 10, order = '-created') {
-    const data = await request({
+    const { data } = await request({
       method: 'POST',
       host: 'www.tradingview.com',
       path: `/pine_perm/list_users/?limit=${limit}&order_by=${order}`,
@@ -69,7 +70,7 @@ class PinePermManager {
       formData.append('expiration', expiration.toString());
     }
 
-    const data = await request({
+    const { data } = await request({
       method: 'POST',
       host: 'www.tradingview.com',
       path: '/pine_perm/add/',
@@ -98,7 +99,7 @@ class PinePermManager {
       formData.append('expiration', expiration.toISOString());
     }
 
-    const data = await request({
+    const { data } = await request({
       method: 'POST',
       host: 'www.tradingview.com',
       path: '/pine_perm/modify_user_expiration/',
@@ -123,7 +124,7 @@ class PinePermManager {
     formData.append('pine_id', this.pineId);
     formData.append('username_recip', username);
 
-    const data = await request({
+    const { data } = await request({
       method: 'POST',
       host: 'www.tradingview.com',
       path: '/pine_perm/remove/',

package/src/client.js

@@ -15,9 +15,10 @@ const chartSessionGenerator = require('./chart/session');
 /** @typedef {Object<string, Session>} SessionList Session list */
 
 /**
- * @typedef {(t: string, p: []) => null} SendPacket Send a custom packet
+ * @callback SendPacket Send a custom packet
  * @param {string} t Packet type
  * @param {string[]} p Packet data
+ * @returns {void}
 */
 
 /**
@@ -33,6 +34,7 @@ const chartSessionGenerator = require('./chart/session');
  * } ClientEvent
  */
 
+/** @class */
 module.exports = class Client {
   #ws;
 
@@ -79,7 +81,7 @@ module.exports = class Client {
   /**
    * When client is connected
    * @param {() => void} cb Callback
-   * @event
+   * @event onConnected
    */
   onConnected(cb) {
     this.#callbacks.connected.push(cb);
@@ -88,7 +90,7 @@ module.exports = class Client {
   /**
    * When client is disconnected
    * @param {() => void} cb Callback
-   * @event
+   * @event onDisconnected
    */
   onDisconnected(cb) {
     this.#callbacks.disconnected.push(cb);
@@ -105,10 +107,12 @@ module.exports = class Client {
    * @prop {string} javastudies Javastudies
    * @prop {number} auth_scheme_vsn Auth scheme type
    * @prop {string} via Socket IP
+   */
 
+  /**
    * When client is logged
    * @param {(SocketSession: SocketSession) => void} cb Callback
-   * @event
+   * @event onLogged
    */
   onLogged(cb) {
     this.#callbacks.logged.push(cb);
@@ -117,7 +121,7 @@ module.exports = class Client {
   /**
    * When server is pinging the client
    * @param {(i: number) => void} cb Callback
-   * @event
+   * @event onPing
    */
   onPing(cb) {
     this.#callbacks.ping.push(cb);
@@ -126,7 +130,7 @@ module.exports = class Client {
   /**
    * When unparsed data is received
    * @param {(...{}) => void} cb Callback
-   * @event
+   * @event onData
    */
   onData(cb) {
     this.#callbacks.data.push(cb);
@@ -135,7 +139,7 @@ module.exports = class Client {
   /**
    * When a client error happens
    * @param {(...{}) => void} cb Callback
-   * @event
+   * @event onError
    */
   onError(cb) {
     this.#callbacks.error.push(cb);
@@ -144,7 +148,7 @@ module.exports = class Client {
   /**
    * When a client event happens
    * @param {(...{}) => void} cb Callback
-   * @event
+   * @event onEvent
    */
   onEvent(cb) {
     this.#callbacks.event.push(cb);
@@ -203,6 +207,7 @@ module.exports = class Client {
     while (this.isOpen && this.#logged && this.#sendQueue.length > 0) {
       const packet = this.#sendQueue.shift();
       this.#ws.send(packet);
+      if (global.TW_DEBUG) console.log('§90§30§107 > §0', packet);
     }
   }
 
@@ -210,6 +215,7 @@ module.exports = class Client {
    * @typedef {Object} ClientOptions
    * @prop {string} [token] User auth token (in 'sessionid' cookie)
    * @prop {boolean} [DEBUG] Enable debug mode
+   * @prop {'data' | 'prodata' | 'widgetdata'} [server] Server type
    */
 
   /** Client object
@@ -218,7 +224,8 @@ module.exports = class Client {
   constructor(clientOptions = {}) {
     if (clientOptions.DEBUG) global.TW_DEBUG = clientOptions.DEBUG;
 
-    this.#ws = new WebSocket('wss://widgetdata.tradingview.com/socket.io/websocket', {
+    const server = clientOptions.server || 'data';
+    this.#ws = new WebSocket(`wss://${server}.tradingview.com/socket.io/websocket`, {
       origin: 'https://s.tradingview.com',
     });
 

package/src/miscRequests.js

@@ -1,5 +1,7 @@
+const os = require('os');
 const https = require('https');
 const request = require('./request');
+const FormData = require('./FormData');
 
 const PinePermManager = require('./classes/PinePermManager');
 const PineIndicator = require('./classes/PineIndicator');
@@ -8,7 +10,7 @@ const indicators = ['Recommend.Other', 'Recommend.All', 'Recommend.MA'];
 const builtInIndicList = [];
 
 async function fetchScanData(tickers = [], type = '', columns = []) {
-  let data = await request({
+  let { data } = await request({
     method: 'POST',
     hostname: 'scanner.tradingview.com',
     path: `/${type}/scan`,
@@ -28,11 +30,17 @@ async function fetchScanData(tickers = [], type = '', columns = []) {
   return data;
 }
 
+/** @typedef {number} advice */
+
+/**
+ * @typedef {{
+ *   Other: advice,
+ *   All: advice,
+ *   MA: advice
+ * }} Period
+ */
+
 /**
- * @typedef {number} advice
- *
- * @typedef {{ Other: advice, All: advice, MA: advice }} Period
- *
  * @typedef {{
  *  '1': Period,
  *  '5': Period,
@@ -41,21 +49,25 @@ async function fetchScanData(tickers = [], type = '', columns = []) {
  *  '240': Period,
  *  '1D': Period,
  *  '1W': Period,
- *  '1M': Period,
+ *  '1M': Period
  * }} Periods
- *
+ */
+
+/**
  * @typedef {string | 'forex' | 'crypto'
  * | 'america' | 'australia' | 'canada' | 'egypt'
  * | 'germany' | 'india' | 'israel' | 'italy'
  * | 'luxembourg' | 'poland' | 'sweden' | 'turkey'
- * | 'uk' | 'vietnam'} screener
+ * | 'uk' | 'vietnam'} Screener
  * You can use `getScreener(exchange)` function for non-forex and non-crypto markets.
  */
 
 module.exports = {
   /**
+   * Get a screener from an exchange
+   * @function getScreener
    * @param {string} exchange Example: BINANCE, EURONEXT, NASDAQ
-   * @returns {screener}
+   * @returns {Screener}
   */
   getScreener(exchange) {
     const e = exchange.toUpperCase();
@@ -78,7 +90,8 @@ module.exports = {
 
   /**
    * Get technical analysis
-   * @param {screener} screener
+   * @function getTA
+   * @param {Screener} screener Market screener
    * @param {string} id Full market id (Example: COINBASE:BTCEUR)
    * @returns {Promise<Periods>} results
    */
@@ -104,24 +117,28 @@ module.exports = {
 
   /**
    * @typedef {Object} SearchMarketResult
-   * @property {string} id
-   * @property {string} exchange
-   * @property {string} fullExchange
-   * @property {string} screener
-   * @property {string} symbol
-   * @property {string} description
-   * @property {string} type
-   * @property {() => Promise<Periods>} getTA
+   * @prop {string} id Market full symbol
+   * @prop {string} exchange Market exchange name
+   * @prop {string} fullExchange Market exchange full name
+   * @prop {Screener | 'forex' | 'crypto'} screener Market screener
+   * @prop {string} symbol Market symbol
+   * @prop {string} description Market name
+   * @prop {string} type Market type
+   * @prop {() => Promise<Periods>} getTA Get market technical analysis
    */
 
   /**
    * Find a symbol
+   * @function searchMarket
    * @param {string} search Keywords
-   * @param {'stock' | 'futures' | 'forex' | 'cfd' | 'crypto' | 'index' | 'economic'} [filter]
+   * @param {'stock'
+   *  | 'futures' | 'forex' | 'cfd'
+   *  | 'crypto' | 'index' | 'economic'
+   * } [filter] Caterogy filter
    * @returns {Promise<SearchMarketResult[]>} Search results
    */
   async searchMarket(search, filter = '') {
-    const data = await request({
+    const { data } = await request({
       host: 'symbol-search.tradingview.com',
       path: `/symbol_search/?text=${search.replace(/ /g, '%20')}&type=${filter}`,
       origin: 'https://www.tradingview.com',
@@ -151,34 +168,35 @@ module.exports = {
 
   /**
    * @typedef {Object} SearchIndicatorResult
-   * @property {string} id Script ID
-   * @property {string} version Script version
-   * @property {string} name Script complete name
-   * @property {{ id: number, username: string }} author Author user ID
-   * @property {string} image Image ID https://tradingview.com/i/${image}
-   * @property {string | ''} source Script source (if available)
-   * @property {'study' | 'strategy'} type Script type (study / strategy)
-   * @property {'open_source' | 'closed_source' | 'invite_only'
+   * @prop {string} id Script ID
+   * @prop {string} version Script version
+   * @prop {string} name Script complete name
+   * @prop {{ id: number, username: string }} author Author user ID
+   * @prop {string} image Image ID https://tradingview.com/i/${image}
+   * @prop {string | ''} source Script source (if available)
+   * @prop {'study' | 'strategy'} type Script type (study / strategy)
+   * @prop {'open_source' | 'closed_source' | 'invite_only'
    *  | 'private' | 'other'} access Script access type
-   * @property {() => Promise<PineIndicator>} get Get the full indicator informations
+   * @prop {() => Promise<PineIndicator>} get Get the full indicator informations
    */
 
   /**
    * Find an indicator
+   * @function searchIndicator
    * @param {string} search Keywords
    * @returns {Promise<SearchIndicatorResult[]>} Search results
    */
   async searchIndicator(search = '') {
     if (!builtInIndicList.length) {
       await Promise.all(['standard', 'candlestick', 'fundamental'].map(async (type) => {
-        builtInIndicList.push(...await request({
+        builtInIndicList.push(...(await request({
           host: 'pine-facade.tradingview.com',
           path: `/pine-facade/list/?filter=${type}`,
-        }));
+        })).data);
       }));
     }
 
-    const data = await request({
+    const { data } = await request({
       host: 'www.tradingview.com',
       path: `/pubscripts-suggest-json/?search=${search.replace(/ /g, '%20')}`,
     });
@@ -229,6 +247,7 @@ module.exports = {
 
   /**
    * Get an indicator
+   * @function getIndicator
    * @param {string} id Indicator ID (Like: PUB;XXXXXXXXXXXXXXXXXXXXX)
    * @param {'last' | string} [version] Wanted version of the indicator
    * @returns {Promise<PineIndicator>} Indicator
@@ -236,7 +255,7 @@ module.exports = {
   async getIndicator(id, version = 'last') {
     const indicID = id.replace(/ |%/g, '%25');
 
-    let data = await request({
+    let { data } = await request({
       host: 'pine-facade.tradingview.com',
       path: `/pine-facade/translate/${indicID}/${version}`,
     }, true);
@@ -256,10 +275,12 @@ module.exports = {
     data.result.metaInfo.inputs.forEach((input) => {
       if (['text', 'pineId', 'pineVersion'].includes(input.id)) return;
 
+      const inlineName = input.name.replace(/ /g, '_').replace(/[^a-zA-Z0-9_]/g, '');
+
       inputs[input.id] = {
         name: input.name,
-        inline: input.inline || input.name.replace(/ /g, '_').replace(/[^a-zA-Z0-9_]/g, ''),
-        internalID: input.internalID,
+        inline: input.inline || inlineName,
+        internalID: input.internalID || inlineName,
         tooltip: input.tooltip,
 
         type: input.type,
@@ -309,25 +330,74 @@ module.exports = {
 
   /**
    * @typedef {Object} User Instance of User
-   * @property {number} id User ID
-   * @property {string} username User username
-   * @property {string} firstName User first name
-   * @property {string} lastName User last name
-   * @property {number} reputation User reputation
-   * @property {number} following Number of following accounts
-   * @property {number} followers Number of followers
-   * @property {Object} notifications User's notifications
-   * @property {number} notifications.user User notifications
-   * @property {number} notifications.following Notification from following accounts
-   * @property {string} session User session
-   * @property {string} sessionHash User session hash
-   * @property {string} privateChannel User private channel
-   * @property {string} authToken User auth token
-   * @property {Date} joinDate Account creation date
+   * @prop {number} id User ID
+   * @prop {string} username User username
+   * @prop {string} firstName User first name
+   * @prop {string} lastName User last name
+   * @prop {number} reputation User reputation
+   * @prop {number} following Number of following accounts
+   * @prop {number} followers Number of followers
+   * @prop {Object} notifications User's notifications
+   * @prop {number} notifications.user User notifications
+   * @prop {number} notifications.following Notification from following accounts
+   * @prop {string} session User session
+   * @prop {string} sessionHash User session hash
+   * @prop {string} privateChannel User private channel
+   * @prop {string} authToken User auth token
+   * @prop {Date} joinDate Account creation date
    */
 
   /**
-   * Get a token for an user from a 'sessionid' cookie
+   * Get user and sessionid from username/email and password
+   * @function loginUser
+   * @param {string} username User username/email
+   * @param {string} password User password
+   * @param {boolean} [remember] Remember the session (default: false)
+   * @param {string} [UA] Custom UserAgent
+   * @returns {Promise<User>} Token
+   */
+  async loginUser(username, password, remember = true, UA = 'TWAPI/3.0') {
+    const formData = new FormData();
+    formData.append('username', username);
+    formData.append('password', password);
+    if (remember) formData.append('remember', 'on');
+
+    const { data, cookies } = await request({
+      method: 'POST',
+      host: 'www.tradingview.com',
+      path: '/accounts/signin/',
+      headers: {
+        referer: 'https://www.tradingview.com',
+        'Content-Type': `multipart/form-data; boundary=${formData.boundary}`,
+        'User-agent': `${UA} (${os.version()}; ${os.platform()}; ${os.arch()})`,
+      },
+    }, false, formData.toString());
+
+    if (data.error) throw new Error(data.error);
+
+    const cookie = cookies.find((c) => c.includes('sessionid='));
+    const session = (cookie.match(/sessionid=(.*?);/) ?? [])[1];
+
+    return {
+      id: data.user.id,
+      username: data.user.username,
+      firstName: data.user.first_name,
+      lastName: data.user.last_name,
+      reputation: data.user.reputation,
+      following: data.user.following,
+      followers: data.user.followers,
+      notifications: data.user.notification_count,
+      session,
+      sessionHash: data.user.session_hash,
+      privateChannel: data.user.private_channel,
+      authToken: data.user.auth_token,
+      joinDate: new Date(data.user.date_joined),
+    };
+  },
+
+  /**
+   * Get user from 'sessionid' cookie
+   * @function getUser
    * @param {string} session User 'sessionid' cookie
    * @param {string} [location] Auth page location (For france: https://fr.tradingview.com/)
    * @returns {Promise<User>} Token
@@ -373,6 +443,7 @@ module.exports = {
 
   /**
    * Get user's private indicators from a 'sessionid' cookie
+   * @function getPrivateIndicators
    * @param {string} session User 'sessionid' cookie
    * @returns {Promise<SearchIndicatorResult[]>} Search results
    */
@@ -420,12 +491,13 @@ module.exports = {
   /**
    * User credentials
    * @typedef {Object} UserCredentials
-   * @property {number} id User ID
-   * @property {string} session User session ('sessionid' cookie)
+   * @prop {number} id User ID
+   * @prop {string} session User session ('sessionid' cookie)
    */
 
   /**
    * Get a chart token from a layout ID and the user credentials if the layout is not public
+   * @function getChartToken
    * @param {string} layout The layout ID found in the layout URL (Like: 'XXXXXXXX')
    * @param {UserCredentials} [credentials] User credentials (id + session)
    * @returns {Promise<string>} Token
@@ -435,7 +507,7 @@ module.exports = {
     const userID = creds ? credentials.id : -1;
     const session = creds ? credentials.session : null;
 
-    const data = await request({
+    const { data } = await request({
       host: 'www.tradingview.com',
       path: `/chart-token/?image_url=${layout}&user_id=${userID}`,
       headers: { cookie: session ? `sessionid=${session}` : '' },
@@ -448,32 +520,33 @@ module.exports = {
 
   /**
    * @typedef {Object} DrawingPoint Drawing poitn
-   * @property {number} time_t Point X time position
-   * @property {number} price Point Y price position
-   * @property {number} offset Point offset
+   * @prop {number} time_t Point X time position
+   * @prop {number} price Point Y price position
+   * @prop {number} offset Point offset
    */
 
   /**
    * @typedef {Object} Drawing
-   * @property {string} id Drawing ID (Like: 'XXXXXX')
-   * @property {string} symbol Layout market symbol (Like: 'BINANCE:BUCEUR')
-   * @property {string} ownerSource Owner user ID (Like: 'XXXXXX')
-   * @property {string} serverUpdateTime Drawing last update timestamp
-   * @property {string} currencyId Currency ID (Like: 'EUR')
-   * @property {any} unitId Unit ID
-   * @property {string} type Drawing type
-   * @property {DrawingPoint[]} points List of drawing points
-   * @property {number} zorder Drawing Z order
-   * @property {string} linkKey Drawing link key
-   * @property {Object} state Drawing state
+   * @prop {string} id Drawing ID (Like: 'XXXXXX')
+   * @prop {string} symbol Layout market symbol (Like: 'BINANCE:BUCEUR')
+   * @prop {string} ownerSource Owner user ID (Like: 'XXXXXX')
+   * @prop {string} serverUpdateTime Drawing last update timestamp
+   * @prop {string} currencyId Currency ID (Like: 'EUR')
+   * @prop {any} unitId Unit ID
+   * @prop {string} type Drawing type
+   * @prop {DrawingPoint[]} points List of drawing points
+   * @prop {number} zorder Drawing Z order
+   * @prop {string} linkKey Drawing link key
+   * @prop {Object} state Drawing state
    */
 
   /**
    * Get a chart token from a layout ID and the user credentials if the layout is not public
+   * @function getDrawings
    * @param {string} layout The layout ID found in the layout URL (Like: 'XXXXXXXX')
    * @param {string | ''} [symbol] Market filter (Like: 'BINANCE:BTCEUR')
    * @param {UserCredentials} [credentials] User credentials (id + session)
-   * @param {number} [chartID = 1] Chart ID
+   * @param {number} [chartID] Chart ID
    * @returns {Promise<Drawing[]>} Drawings
    */
   async getDrawings(layout, symbol = '', credentials = {}, chartID = 1) {
@@ -481,7 +554,7 @@ module.exports = {
     const creds = credentials.id && credentials.session;
     const session = creds ? credentials.session : null;
 
-    const data = await request({
+    const { data } = await request({
       host: 'charts-storage.tradingview.com',
       path: `/charts-storage/layout/${layout}/sources?chart_id=${chartID
       }&jwt=${chartToken}${symbol ? `&symbol=${symbol}` : ''}`,

package/src/protocol.js

@@ -6,14 +6,18 @@ const JSZip = require('jszip');
  * @prop {[session: string, {}]} [p] Packet data
  */
 
+const cleanerRgx = /~h~/g;
+const splitterRgx = /~m~[0-9]{1,}~m~/g;
+
 module.exports = {
   /**
    * Parse websocket packet
+   * @function parseWSPacket
    * @param {string} str Websocket raw data
    * @returns {TWPacket[]} TradingView packets
    */
   parseWSPacket(str) {
-    return str.replace(/~h~/g, '').split(/~m~[0-9]{1,}~m~/g)
+    return str.replace(cleanerRgx, '').split(splitterRgx)
       .map((p) => {
         if (!p) return false;
         try {
@@ -28,6 +32,7 @@ module.exports = {
 
   /**
    * Format websocket packet
+   * @function formatWSPacket
    * @param {TWPacket} packet TradingView packet
    * @returns {string} Websocket raw data
    */
@@ -40,6 +45,7 @@ module.exports = {
 
   /**
    * Parse compressed data
+   * @function parseCompressed
    * @param {string} data Compressed data
    * @returns {Promise<{}>} Parsed data
    */

package/src/request.js

@@ -1,37 +1,37 @@
-const https = require('https');
-
-/**
- * @param {https.RequestOptions} options HTTPS Request options
- * @param {boolean} [raw] Get raw or JSON data
- * @param {string} [content] Request body content
- * @returns {Promise<string | object | array>} Result
- */
-function request(options = {}, raw = false, content = '') {
-  return new Promise((cb, err) => {
-    const req = https.request(options, (res) => {
-      let data = '';
-      res.on('data', (c) => { data += c; });
-      res.on('end', () => {
-        if (raw) {
-          cb(data);
-          return;
-        }
-
-        try {
-          data = JSON.parse(data);
-        } catch (error) {
-          console.log(data);
-          err(new Error('Can\'t parse server response'));
-          return;
-        }
-
-        cb(data);
-      });
-    });
-
-    req.on('error', err);
-    req.end(content);
-  });
-}
-
-module.exports = request;
+const https = require('https');
+
+/**
+ * @param {https.RequestOptions} options HTTPS Request options
+ * @param {boolean} [raw] Get raw or JSON data
+ * @param {string} [content] Request body content
+ * @returns {Promise<{ data: (string | object | array), cookies: string[] }>} Result
+ */
+function request(options = {}, raw = false, content = '') {
+  return new Promise((cb, err) => {
+    const req = https.request(options, (res) => {
+      let data = '';
+      res.on('data', (c) => { data += c; });
+      res.on('end', () => {
+        if (raw) {
+          cb({ data, cookies: res.headers['set-cookie'] });
+          return;
+        }
+
+        try {
+          data = JSON.parse(data);
+        } catch (error) {
+          console.log(data);
+          err(new Error('Can\'t parse server response'));
+          return;
+        }
+
+        cb({ data, cookies: res.headers['set-cookie'] });
+      });
+    });
+
+    req.on('error', err);
+    req.end(content);
+  });
+}
+
+module.exports = request;

package/src/types.js

@@ -1,6 +1,8 @@
 /**
  * @typedef {string} MarketSymbol Market symbol (like: 'BTCEUR' or 'KRAKEN:BTCEUR')
- *
+ */
+
+/**
  * @typedef {'Etc/UTC' | 'exchange'
  * | 'Pacific/Honolulu' | 'America/Juneau' | 'America/Los_Angeles'
  * | 'America/Phoenix' | 'America/Vancouver' | 'US/Mountain'
@@ -23,7 +25,9 @@
  * | 'Asia/Taipei' | 'Asia/Seoul' | 'Asia/Tokyo' | 'Australia/Brisbane'
  * | 'Australia/Adelaide' | 'Australia/Sydney' | 'Pacific/Norfolk'
  * | 'Pacific/Auckland' | 'Pacific/Fakaofo' | 'Pacific/Chatham'} Timezone (Chart) timezone
- *
+ */
+
+/**
  * @typedef {'1' | '3' | '5' | '15' | '30'
  * | '45' | '60' | '120' | '180' | '240'
  * | '1D' | '1W' | '1M' | 'D' | 'W' | 'M'} TimeFrame

package/src/utils.js

@@ -1,4 +1,10 @@
 module.exports = {
+  /**
+   * Generates a session id
+   * @function genSessionID
+   * @param {String} type Session type
+   * @returns {string}
+   */
   genSessionID(type = 'xs') {
     let r = '';
     const c = 'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789';

package/test.js

@@ -1,3 +1,4 @@
+/* eslint-disable no-continue */
 /* eslint-disable no-await-in-loop */
 /* eslint-disable import/no-dynamic-require */
 /* eslint-disable no-restricted-syntax */
@@ -37,6 +38,7 @@ function success() {
   console.info('§90§30§104 ==== Starting tests ==== §0');
 
   for (const file of fs.readdirSync('./tests').filter((f) => f.endsWith('.js'))) {
+    if (process.argv[2] && !file.startsWith(process.argv[2])) continue;
     const test = require(`./tests/${file}`);
     const name = file.replace(/\.js/g, '');
     TESTS[name] = { errors: 0, warnings: 0 };

package/tests/4. Indicators.js

@@ -65,9 +65,10 @@ module.exports = async (log, success, warn, err, cb) => {
 
       QTY += 10;
       log('TRY WITH', QTY, '%');
-      indicator.setOption('default_qty_value', QTY);
-
-      SuperTrend.setIndicator(indicator);
+      setTimeout(() => {
+        indicator.setOption('default_qty_value', QTY);
+        SuperTrend.setIndicator(indicator);
+      }, 1000);
     });
   });
 

package/examples/CurrentTimeframe.js

@@ -1,34 +0,0 @@
-const TradingView = require('../main');
-
-/*
-  This example tests an indicator that sends
-  graphic data such as 'lines', 'labels',
-  'boxes', 'tables', 'polygons', etc...
-*/
-
-const client = new TradingView.Client();
-
-const chart = new client.Session.Chart();
-
-let wantedTimeframe = '5';
-let timeframe = null;
-
-chart.setMarket('BINANCE:BTCEUR', {
-  timeframe: wantedTimeframe,
-});
-
-chart.onSymbolLoaded(() => {
-  timeframe = wantedTimeframe;
-  console.log(`Timeframe is now '${timeframe}'`);
-});
-
-chart.onUpdate(() => {
-  console.log(`Received data on '${timeframe}' timeframe`);
-});
-
-setTimeout(() => {
-  wantedTimeframe = '240';
-  chart.setMarket('BINANCE:BTCEUR', {
-    timeframe: wantedTimeframe,
-  });
-}, 3000);

package/examples/_RenkoIndicator.js

@@ -1,41 +0,0 @@
-const TradingView = require('../main');
-
-if (!process.argv[2]) throw Error('Please specify your \'sessionid\' cookie');
-
-const client = new TradingView.Client({
-  token: process.argv[2],
-});
-
-const chart = new client.Session.Chart();
-chart.setMarket('NASDAQ:AAPL', {
-  type: 'Renko',
-  timeframe: '1',
-  inputs: {
-    source: 'close',
-    sources: 'Close',
-    boxSize: 3,
-    style: 'Traditional',
-    atrLength: 14,
-    wicks: true,
-  },
-});
-
-TradingView.searchIndicator('CM_Ultimate_MA_MTF_V2').then(async (indicator) => {
-  console.log(
-    '*** Indicator information\n',
-    indicator[0].id,
-  );
-  const pineIndicator = await indicator[0].get();
-  const study = new chart.Study(pineIndicator);
-  study.onUpdate(() => {
-    console.log(
-      '\n*** Chart time and close:\n',
-      chart.periods[0].time,
-      chart.periods[0].close,
-    );
-    console.log(
-      '\n*** Indicator values:\n',
-      study.periods[0].MultiTimeframe_Moving_Avg,
-    );
-  });
-});

package/tests/disabled/x. Template.js

@@ -1,24 +0,0 @@
-const TradingView = require('../main');
-
-module.exports = async (log, success, warn, err, cb) => {
-  const client = new TradingView.Client();
-
-  client.onError((...error) => {
-    err('Client error', error);
-    throw new Error('Client error');
-  });
-
-  const chart = new client.Session.Chart();
-  chart.setMarket('BINANCE:BTCEUR', {
-    timeframe: '60',
-  });
-
-  chart.onError((...error) => {
-    err('Chart error', error);
-    throw new Error('Chart error');
-  });
-
-  chart.delete();
-  await client.end();
-  cb();
-};