@mathieuc/tradingview 3.4.6 → 3.5.0

package/.env.sample

@@ -0,0 +1,2 @@
+SESSION=... # Your sessionid cookie
+SIGNATURE=... # Your signature cookie

package/examples/AllPrivateIndicators.js

@@ -4,12 +4,13 @@ const TradingView = require('../main');
  * This example creates a chart with all user's private indicators
  */
 
-if (!process.argv[2]) throw Error('Please specify your \'sessionid\' cookie');
-if (!process.argv[3]) throw Error('Please specify your \'signature\' cookie');
+if (!process.env.SESSION || !process.env.SIGNATURE) {
+  throw Error('Please set your sessionid and signature cookies');
+}
 
 const client = new TradingView.Client({
-  token: process.argv[2],
-  signature: process.argv[3],
+  token: process.env.SESSION,
+  signature: process.env.SIGNATURE,
 });
 
 const chart = new client.Session.Chart();
@@ -17,8 +18,15 @@ chart.setMarket('BINANCE:BTCEUR', {
   timeframe: 'D',
 });
 
-TradingView.getPrivateIndicators(process.argv[2]).then((indicList) => {
-  indicList.forEach(async (indic) => {
+(async () => {
+  const indicList = await TradingView.getPrivateIndicators(process.argv[2]);
+
+  if (!indicList.length) {
+    console.error('Your account has no private indicators');
+    process.exit(0);
+  }
+
+  for (const indic of indicList) {
     const privateIndic = await indic.get();
     console.log('Loading indicator', indic.name, '...');
 
@@ -32,5 +40,5 @@ TradingView.getPrivateIndicators(process.argv[2]).then((indicList) => {
       console.log('Plot values', indicator.periods);
       console.log('Strategy report', indicator.strategyReport);
     });
-  });
-});
+  }
+})();

package/examples/BuiltInIndicator.js

@@ -6,19 +6,24 @@ const TradingView = require('../main');
 
 const volumeProfile = new TradingView.BuiltInIndicator('VbPFixed@tv-basicstudies-241!');
 
-const AUTHENTICATED_INDICATORS = [
+const needAuth = ![
   'VbPFixed@tv-basicstudies-241',
   'VbPFixed@tv-basicstudies-241!',
   'Volume@tv-basicstudies-241',
-];
+].includes(volumeProfile.type);
 
-if (!process.argv[2] && !AUTHENTICATED_INDICATORS.includes(volumeProfile.type)) {
-  throw Error('Please specify your \'sessionid\' cookie');
+if (needAuth && (!process.env.SESSION || !process.env.SIGNATURE)) {
+  throw Error('Please set your sessionid and signature cookies');
 }
 
-const client = new TradingView.Client({
-  token: process.argv[2],
-});
+const client = new TradingView.Client(
+  needAuth
+    ? {
+      token: process.env.SESSION,
+      signature: process.env.SIGNATURE,
+    }
+    : {},
+);
 
 const chart = new client.Session.Chart();
 chart.setMarket('BINANCE:BTCEUR', {

package/examples/CustomChartType.js

@@ -6,9 +6,12 @@ const TradingView = require('../main');
  */
 
 const client = new TradingView.Client({
-  /* Token is only required if you want to use intraday
-    timeframes (if you have a paid TradingView account) */
-  token: process.argv[2],
+  /*
+    Token and signature are only required if you want to use
+    intraday timeframes (if you have a paid TradingView account)
+  */
+  token: process.env.SESSION,
+  signature: process.env.SIGNATURE,
 });
 
 const chart = new client.Session.Chart();

package/examples/CustomTimeframe.js

@@ -4,10 +4,13 @@ const TradingView = require('../main');
  * This example tests custom timeframes like 1 second
  */
 
-if (!process.argv[2]) throw Error('Please specify your \'sessionid\' cookie');
+if (!process.env.SESSION || !process.env.SIGNATURE) {
+  throw Error('Please set your sessionid and signature cookies');
+}
 
 const client = new TradingView.Client({
-  token: process.argv[2],
+  token: process.env.SESSION,
+  signature: process.env.SIGNATURE,
 });
 
 const chart = new client.Session.Chart();

package/examples/Errors.js

@@ -4,7 +4,15 @@ const TradingView = require('../main');
  * This example tests many types of errors
  */
 
-const client = new TradingView.Client(); // Creates a websocket client
+if (!process.env.SESSION || !process.env.SIGNATURE) {
+  throw Error('Please set your sessionid and signature cookies');
+}
+
+// Creates a websocket client
+const client = new TradingView.Client({
+  token: process.env.SESSION,
+  signature: process.env.SIGNATURE,
+});
 
 const tests = [
   (next) => { /* Testing "Credentials error" */

package/examples/FakeReplayMode.js

@@ -11,7 +11,7 @@ const client = new Client();
 const chart = new client.Session.Chart();
 
 chart.setMarket('BINANCE:BTCEUR', {
-  timeframe: 'D',
+  timeframe: '240',
   range: -1, // Range is negative, so 'to' means 'from'
   to: Math.round(Date.now() / 1000) - 86400 * 7, // Seven days before now
   // to: 1600000000,
@@ -31,10 +31,10 @@ chart.onUpdate(async () => {
 
   console.log('Next ->', times[0]);
 
-  if ((times[0] + 86400) * 1000 > Date.now()) {
+  if (times[0] > ((Date.now() / 1000) - 86400 * 1)) {
     await client.end();
     console.log('Done !', times.length);
   }
 
-  chart.fetchMore(-1);
+  chart.fetchMore(-2);
 });

package/examples/FromToData.js

@@ -5,13 +5,20 @@ const TradingView = require('../main');
  * of candles before or after a timestamp
  */
 
-const client = new TradingView.Client();
+if (!process.env.SESSION || !process.env.SIGNATURE) {
+  throw Error('Please set your sessionid and signature cookies');
+}
+
+const client = new TradingView.Client({
+  token: process.env.SESSION,
+  signature: process.env.SIGNATURE,
+});
 
 const chart = new client.Session.Chart();
 chart.setMarket('BINANCE:BTCEUR', {
   timeframe: '240',
   range: 2, // Can be positive to get before or negative to get after
-  to: 1600000000,
+  to: 1700000000,
 });
 
 // This works with indicators

package/examples/GetDrawings.js

@@ -5,14 +5,16 @@ const TradingView = require('../main');
  */
 
 // 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 the layout is private:
+// - Second parameter must be the userid (you can use getUser function)
+// - You should provide your sessionid and signature cookies in .env file
 
 if (!process.argv[2]) throw Error('Please specify a layoutID');
 
 TradingView.getDrawings(process.argv[2], null, {
-  session: process.argv[3],
-  id: process.argv[4],
+  session: process.env.SESSION,
+  signature: process.env.SIGNATURE,
+  id: process.argv[3],
 }).then((drawings) => {
   console.log(`Found ${drawings.length} drawings:`, drawings.map((d) => ({
     id: d.id,

package/examples/GraphicIndicator.js

@@ -5,7 +5,14 @@ const TradingView = require('../main');
  * as 'lines', 'labels', 'boxes', 'tables', 'polygons', etc...
  */
 
-const client = new TradingView.Client();
+if (!process.env.SESSION || !process.env.SIGNATURE) {
+  throw Error('Please set your sessionid and signature cookies');
+}
+
+const client = new TradingView.Client({
+  token: process.env.SESSION,
+  signature: process.env.SIGNATURE,
+});
 
 const chart = new client.Session.Chart();
 chart.setMarket('BINANCE:BTCEUR', {
@@ -29,7 +36,7 @@ TradingView.getIndicator('STD;Zig_Zag').then((indic) => {
   STD.onUpdate(() => {
     console.log('Graphic data:', STD.graphic);
     // console.log('Tables:', changes, STD.graphic.tables);
-    // console.log('Cells', STD.graphic.tables[0].cells());
+    // console.log('Cells:', STD.graphic.tables[0].cells());
     client.end();
   });
 });

package/examples/MultipleSyncFetch.js

@@ -4,16 +4,23 @@ const TradingView = require('../main');
  * This examples synchronously fetches data from 3 indicators
  */
 
-const client = new TradingView.Client();
-const chart = new client.Session.Chart();
-chart.setMarket('BINANCE:DOTUSDT');
+if (!process.env.SESSION || !process.env.SIGNATURE) {
+  throw Error('Please set your sessionid and signature cookies');
+}
+
+const client = new TradingView.Client({
+  token: process.env.SESSION,
+  signature: process.env.SIGNATURE,
+});
 
 function getIndicData(indicator) {
-  return new Promise((res) => {
-    const STD = new chart.Study(indicator);
+  const chart = new client.Session.Chart();
+  chart.setMarket('BINANCE:DOTUSDT');
+  const STD = new chart.Study(indicator);
 
-    console.log(`Getting "${indicator.description}"...`);
+  console.log(`Getting "${indicator.description}"...`);
 
+  return new Promise((res) => {
     STD.onUpdate(() => {
       res(STD.periods);
       console.log(`"${indicator.description}" done !`);

package/examples/PinePermManage.js

@@ -5,11 +5,21 @@ const { PinePermManager } = require('../main');
  * and tests all the available functions
  */
 
-const sessionid = process.argv[2];
-const signature = process.argv[3];
-const pineid = process.argv[4];
+if (!process.env.SESSION || !process.env.SIGNATURE) {
+  throw Error('Please set your sessionid and signature cookies');
+}
 
-const manager = new PinePermManager(sessionid, signature, pineid);
+const pineid = process.argv[2];
+
+if (!pineid) throw Error('Please specify a pine id as first argument');
+
+console.log('Pine ID:', pineid);
+
+const manager = new PinePermManager(
+  process.env.SESSION,
+  process.env.SIGNATURE,
+  pineid,
+);
 
 (async () => {
   console.log('Users:', await manager.getUsers());

package/examples/ReplayMode.js

@@ -5,6 +5,18 @@ const TradingView = require('../main');
  * indicator data and stores it in a 'periods' variable
  */
 
+if (!process.env.SESSION || !process.env.SIGNATURE) {
+  throw Error('Please set your sessionid and signature cookies');
+}
+
+console.log('----- Testing ReplayMode: -----');
+
+const client = new TradingView.Client({
+  token: process.env.SESSION,
+  signature: process.env.SIGNATURE,
+});
+const chart = new client.Session.Chart();
+
 const config = {
   symbol: 'BINANCE:BTCEUR',
   timeframe: 'D',
@@ -12,11 +24,6 @@ const config = {
   // startFrom: 1600000000,
 };
 
-console.log('----- Testing ReplayMode: -----');
-
-const client = new TradingView.Client();
-const chart = new client.Session.Chart();
-
 chart.setMarket(config.symbol, {
   timeframe: config.timeframe,
   replay: config.startFrom,

package/examples/Search.js

@@ -2,10 +2,10 @@ const TradingView = require('../main');
 
 /**
  * This example tests the searching functions such
- * as 'searchMarket' and 'searchIndicator'
+ * as 'searchMarketV3' and 'searchIndicator'
  */
 
-TradingView.searchMarket('BINANCE:').then((rs) => {
+TradingView.searchMarketV3('BINANCE:').then((rs) => {
   console.log('Found Markets:', rs);
 });
 

package/package.json

@@ -1,10 +1,12 @@
 {
   "name": "@mathieuc/tradingview",
-  "version": "3.4.6",
+  "version": "3.5.0",
   "description": "Tradingview instant stocks API, indicator alerts, trading bot, and more !",
   "main": "main.js",
   "scripts": {
-    "test": "vitest"
+    "test": "vitest",
+    "example": "node --env-file=.env",
+    "example:dev": "nodemon --env-file=.env"
   },
   "repository": {
     "type": "git",
@@ -37,6 +39,6 @@
     "eslint": "^7.25.0",
     "eslint-config-airbnb-base": "^14.2.1",
     "eslint-plugin-import": "^2.22.1",
-    "vitest": "^0.31.1"
+    "vitest": "^0.31.4"
   }
 }

package/src/chart/session.js

@@ -331,6 +331,7 @@ module.exports = (client) => class ChartSession {
    * @param {number} [options.range] Number of loaded periods/candles (Default: 100)
    * @param {number} [options.to] Last candle timestamp (Default is now)
    * @param {'splits' | 'dividends'} [options.adjustment] Market adjustment
+   * @param {boolean} [options.backadjustment] Market backadjustment of futures contracts
    * @param {'regular' | 'extended'} [options.session] Chart session
    * @param {'EUR' | 'USD' | string} [options.currency] Chart currency
    * @param {ChartType} [options.type] Chart custom type
@@ -350,12 +351,15 @@ module.exports = (client) => class ChartSession {
       adjustment: options.adjustment || 'splits',
     };
 
+    if (options.backadjustment) symbolInit.backadjustment = 'default';
     if (options.session) symbolInit.session = options.session;
     if (options.currency) symbolInit['currency-id'] = options.currency;
 
     if (options.replay) {
-      this.#replayMode = true;
-      this.#client.send('replay_create_session', [this.#replaySessionID]);
+      if (!this.#replayMode) {
+        this.#replayMode = true;
+        this.#client.send('replay_create_session', [this.#replaySessionID]);
+      }
 
       this.#client.send('replay_add_series', [
         this.#replaySessionID,
@@ -543,6 +547,7 @@ module.exports = (client) => class ChartSession {
     if (this.#replayMode) this.#client.send('replay_delete_session', [this.#replaySessionID]);
     this.#client.send('chart_delete_session', [this.#chartSessionID]);
     delete this.#client.sessions[this.#chartSessionID];
+    delete this.#client.sessions[this.#replaySessionID];
     this.#replayMode = false;
   }
 };

package/src/classes/PinePermManager.js

@@ -40,7 +40,7 @@ class PinePermManager {
    * | 'expiration,user__username'
    * | '-expiration,user__username'
    * } order Fetching order
-   * @returns {AuthorizationUser[]}
+   * @returns {Promise<AuthorizationUser[]>}
    */
   async getUsers(limit = 10, order = '-created') {
     try {
@@ -66,7 +66,7 @@ class PinePermManager {
    * Adds an user to the authorized list
    * @param {string} username User's username
    * @param {Date} [expiration] Expiration date
-   * @returns {'ok' | 'exists' | null}
+   * @returns {Promise<'ok' | 'exists' | null>}
    */
   async addUser(username, expiration = null) {
     try {
@@ -100,7 +100,7 @@ class PinePermManager {
    * Modify an authorization expiration date
    * @param {string} username User's username
    * @param {Date} [expiration] New expiration date
-   * @returns {'ok' | null}
+   * @returns {Promise<'ok' | null>}
    */
   async modifyExpiration(username, expiration = null) {
     try {
@@ -133,7 +133,7 @@ class PinePermManager {
   /**
    * Removes an user to the authorized list
    * @param {string} username User's username
-   * @returns {'ok' | null}
+   * @returns {Promise<'ok' | null>}
    */
   async removeUser(username) {
     try {

package/src/client.js

@@ -217,23 +217,26 @@ module.exports = class Client {
    * @prop {string} [signature] User auth token signature (in 'sessionid_sign' cookie)
    * @prop {boolean} [DEBUG] Enable debug mode
    * @prop {'data' | 'prodata' | 'widgetdata'} [server] Server type
+   * @prop {string} [location] Auth page location (For france: https://fr.tradingview.com/)
    */
 
-  /** Client object
+  /**
+   * Client object
    * @param {ClientOptions} clientOptions TradingView client options
    */
   constructor(clientOptions = {}) {
     if (clientOptions.DEBUG) global.TW_DEBUG = clientOptions.DEBUG;
 
     const server = clientOptions.server || 'data';
-    this.#ws = new WebSocket(`wss://${server}.tradingview.com/socket.io/websocket?&type=chart`, {
-      origin: 'https://s.tradingview.com',
+    this.#ws = new WebSocket(`wss://${server}.tradingview.com/socket.io/websocket?type=chart`, {
+      origin: 'https://www.tradingview.com',
     });
 
     if (clientOptions.token) {
       misc.getUser(
         clientOptions.token,
         clientOptions.signature ? clientOptions.signature : '',
+        clientOptions.location ? clientOptions.location : 'https://tradingview.com',
       ).then((user) => {
         this.#sendQueue.unshift(protocol.formatWSPacket({
           m: 'set_auth_token',

package/vite.config.js

@@ -1,6 +1,7 @@
 module.exports = {
   test: {
     testTimeout: 10000,
+    retry: 3,
     setupFiles: 'dotenv/config',
   },
 };