@mathieuc/tradingview 3.0.0 → 3.3.0

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,7 +1,16 @@
-# TradingView API
+# 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)
+[![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
@@ -9,7 +18,8 @@ Get realtime market prices and indicator values from Tradingview !
 - [x] Unlimited simultaneous indicators
 - [x] Realtime
 - [x] Get TradingView's technical analysis
-- [ ] Get values from a specific date range
+- [x] Replay mode + Fake Replay mode (for free plan)
+- [x] Get values from a specific date range
 - [ ] TradingView socket server emulation
 - [ ] Interract with public chats
 - [ ] Get Screener top values
@@ -18,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
@@ -25,16 +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/AllPrivateIndicators.js

@@ -5,10 +5,10 @@ const TradingView = require('../main');
   all user's private indicators
 */
 
+if (!process.argv[2]) throw Error('Please specify your \'sessionid\' cookie');
+
 const client = new TradingView.Client({
-  /* Token is only needed if at least one indicator is
-    PRIVATE (if you have a paid TradingView account) */
-  token: 'YOUR_SESSION_ID_COOKIE',
+  token: process.argv[2],
 });
 
 const chart = new client.Session.Chart();
@@ -16,7 +16,7 @@ chart.setMarket('BINANCE:BTCEUR', {
   timeframe: 'D',
 });
 
-TradingView.getPrivateIndicators('YOUR_SESSION_ID_COOKIE').then((indicList) => {
+TradingView.getPrivateIndicators(process.argv[2]).then((indicList) => {
   indicList.forEach(async (indic) => {
     const privateIndic = await indic.get();
     console.log('Loading indicator', indic.name, '...');

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/CustomChartType.js

@@ -17,6 +17,7 @@ const chart = new client.Session.Chart();
 
 chart.onError((...err) => {
   console.log('Chart error:', ...err);
+  process.exit(1);
 });
 
 chart.onUpdate(() => {

package/examples/Errors.js

@@ -1,153 +1,147 @@
-const TradingView = require('../main');
-
-/*
-  This example tests many types of errors
-*/
-
-const client = new TradingView.Client(); // Creates a websocket client
-
-const tests = [
-  (next) => { /* Testing "Credentials error" */
-    console.info('\nTesting "Credentials error" error:');
-
-    const client2 = new TradingView.Client({
-      token: 'FAKE_CREDENTIALS', // Set wrong credentials
-    });
-
-    client2.onError((...err) => {
-      console.error(' => Client error:', err);
-      client2.end();
-      next();
-    });
-  },
-
-  (next) => { /* Testing "Invalid symbol" */
-    console.info('\nTesting "Invalid symbol" error:');
-
-    const chart = new client.Session.Chart();
-    chart.onError((...err) => { // Listen for errors
-      console.error(' => Chart error:', err);
-      chart.delete();
-      next();
-    });
-
-    chart.setMarket('XXXXX'); // Set a wrong market
-  },
-
-  (next) => { /* Testing "Invalid timezone" */
-    console.info('\nTesting "Invalid timezone" error:');
-
-    const chart = new client.Session.Chart();
-    chart.onError((...err) => { // Listen for errors
-      console.error(' => Chart error:', err);
-      next();
-    });
-
-    chart.setMarket('BINANCE:BTCEUR'); // Set a market
-    chart.setTimezone('Nowhere/Nowhere'); // Set a fake timezone
-  },
-
-  (next) => { /* Testing "Custom timeframe" */
-    console.info('\nTesting "Custom timeframe" error:');
-
-    const chart = new client.Session.Chart();
-    chart.onError((...err) => { // Listen for errors
-      console.error(' => Chart error:', err);
-      chart.delete();
-      next();
-    });
-
-    chart.setMarket('BINANCE:BTCEUR', { // Set a market
-      timeframe: '20', // Set a custom timeframe
-      /*
-        Timeframe '20' isn't available because we are
-        not logged in as a premium TradingView user
-      */
-    });
-  },
-
-  (next) => { /* Testing "Invalid timeframe" */
-    console.info('\nTesting "Invalid timeframe" error:');
-
-    const chart = new client.Session.Chart();
-    chart.onError((...err) => { // Listen for errors
-      console.error(' => Chart error:', err);
-      next();
-    });
-
-    chart.setMarket('BINANCE:BTCEUR', { // Set a market
-      timeframe: 'XX', // Set a wrong timeframe
-    });
-  },
-
-  (next) => { /* Testing "Study not auth" */
-    console.info('\nTesting "Study not auth" error:');
-
-    const chart = new client.Session.Chart();
-    chart.onError((...err) => { // Listen for errors
-      console.error(' => Chart error:', err);
-      next();
-    });
-
-    chart.setMarket('BINANCE:BTCEUR', { // Set a market
-      timeframe: '15',
-      type: 'Renko',
-    });
-
-    chart.onUpdate(() => {
-      console.log('DATA', chart.periods[0]);
-    });
-  },
-
-  (next) => { /* Testing "Set the market before" */
-    console.info('\nTesting "Set the market before..." error:');
-
-    const chart = new client.Session.Chart();
-    chart.onError((...err) => { // Listen for errors
-      console.error(' => Chart error:', err);
-      chart.delete();
-      next();
-    });
-
-    chart.setSeries('15'); // Set series before setting the market
-  },
-
-  (next) => { /* Testing "Inexistent indicator" */
-    console.info('\nTesting "Inexistent indicator" error:');
-
-    TradingView.getIndicator('STD;XXXXXXX')
-      .catch((err) => {
-        console.error(' => API error:', [err.message]);
-        next();
-      });
-  },
-
-  async (next) => { /* Testing "Invalid value" */
-    console.info('\nTesting "Invalid value" error:');
-
-    const chart = new client.Session.Chart();
-    chart.setMarket('BINANCE:BTCEUR'); // Set a market
-
-    const ST = await TradingView.getIndicator('STD;Supertrend');
-    ST.setOption('Factor', -1); // This will cause an error
-
-    const Supertrend = new chart.Study(ST);
-    Supertrend.onError((...err) => {
-      console.error(' => Study error:', err);
-      chart.delete();
-      next();
-    });
-  },
-];
-
-let i = 0;
-const execTest = () => {
-  if (tests[i + 1]) {
-    tests[(i += 1) - 1](execTest);
-  } else {
-    tests[(i += 1) - 1](() => {
-      console.log(`\nTests ${i}/${i} done !`);
-    });
-  }
-};
-execTest();
+const TradingView = require('../main');
+
+/*
+  This example tests many types of errors
+*/
+
+const client = new TradingView.Client(); // Creates a websocket client
+
+const tests = [
+  (next) => { /* Testing "Credentials error" */
+    console.info('\nTesting "Credentials error" error:');
+
+    const client2 = new TradingView.Client({
+      token: 'FAKE_CREDENTIALS', // Set wrong credentials
+    });
+
+    client2.onError((...err) => {
+      console.error(' => Client error:', err);
+      client2.end();
+      next();
+    });
+  },
+
+  (next) => { /* Testing "Invalid symbol" */
+    console.info('\nTesting "Invalid symbol" error:');
+
+    const chart = new client.Session.Chart();
+    chart.onError((...err) => { // Listen for errors
+      console.error(' => Chart error:', err);
+      chart.delete();
+      next();
+    });
+
+    chart.setMarket('XXXXX'); // Set a wrong market
+  },
+
+  (next) => { /* Testing "Invalid timezone" */
+    console.info('\nTesting "Invalid timezone" error:');
+
+    const chart = new client.Session.Chart();
+    chart.onError((...err) => { // Listen for errors
+      console.error(' => Chart error:', err);
+      next();
+    });
+
+    chart.setMarket('BINANCE:BTCEUR'); // Set a market
+    chart.setTimezone('Nowhere/Nowhere'); // Set a fake timezone
+  },
+
+  (next) => { /* Testing "Custom timeframe" */
+    console.info('\nTesting "Custom timeframe" error:');
+
+    const chart = new client.Session.Chart();
+    chart.onError((...err) => { // Listen for errors
+      console.error(' => Chart error:', err);
+      chart.delete();
+      next();
+    });
+
+    chart.setMarket('BINANCE:BTCEUR', { // Set a market
+      timeframe: '20', // Set a custom timeframe
+      /*
+        Timeframe '20' isn't available because we are
+        not logged in as a premium TradingView account
+      */
+    });
+  },
+
+  (next) => { /* Testing "Invalid timeframe" */
+    console.info('\nTesting "Invalid timeframe" error:');
+
+    const chart = new client.Session.Chart();
+    chart.onError((...err) => { // Listen for errors
+      console.error(' => Chart error:', err);
+      next();
+    });
+
+    chart.setMarket('BINANCE:BTCEUR', { // Set a market
+      timeframe: 'XX', // Set a wrong timeframe
+    });
+  },
+
+  (next) => { /* Testing "Study not auth" */
+    console.info('\nTesting "Study not auth" error:');
+
+    const chart = new client.Session.Chart();
+    chart.onError((...err) => { // Listen for errors
+      console.error(' => Chart error:', err);
+      next();
+    });
+
+    chart.setMarket('BINANCE:BTCEUR', { // Set a market
+      timeframe: '15',
+      type: 'Renko',
+    });
+
+    chart.onUpdate(() => {
+      console.log('DATA', chart.periods[0]);
+    });
+  },
+
+  (next) => { /* Testing "Set the market before" */
+    console.info('\nTesting "Set the market before..." error:');
+
+    const chart = new client.Session.Chart();
+    chart.onError((...err) => { // Listen for errors
+      console.error(' => Chart error:', err);
+      chart.delete();
+      next();
+    });
+
+    chart.setSeries('15'); // Set series before setting the market
+  },
+
+  (next) => { /* Testing "Inexistent indicator" */
+    console.info('\nTesting "Inexistent indicator" error:');
+
+    TradingView.getIndicator('STD;XXXXXXX')
+      .catch((err) => {
+        console.error(' => API error:', [err.message]);
+        next();
+      });
+  },
+
+  async (next) => { /* Testing "Invalid value" */
+    console.info('\nTesting "Invalid value" error:');
+
+    const chart = new client.Session.Chart();
+    chart.setMarket('BINANCE:BTCEUR'); // Set a market
+
+    const ST = await TradingView.getIndicator('STD;Supertrend');
+    ST.setOption('Factor', -1); // This will cause an error
+
+    const Supertrend = new chart.Study(ST);
+    Supertrend.onError((...err) => {
+      console.error(' => Study error:', err);
+      chart.delete();
+      next();
+    });
+  },
+];
+
+(async () => {
+  // eslint-disable-next-line no-restricted-syntax, no-await-in-loop
+  for (const t of tests) await new Promise(t);
+  console.log(`\nTests ${tests.length}/${tests.length} done !`);
+})();

package/examples/FakeReplayMode.js

@@ -0,0 +1,41 @@
+const { Client } = require('../main');
+
+/*
+  This example tests the fake
+  replay mode which works in
+  intraday even with free plan
+*/
+
+console.log('----- Testing FakeReplayMode: -----');
+
+const client = new Client();
+const chart = new client.Session.Chart();
+
+chart.setMarket('BINANCE:BTCEUR', {
+  timeframe: 'D',
+  range: -1, // Range is negative, so 'to' means 'from'
+  to: Math.round(Date.now() / 1000) - 86400 * 7, // Seven days before now
+  // to: 1600000000,
+});
+
+let interval = NaN;
+
+chart.onUpdate(async () => {
+  const times = chart.periods.map((p) => p.time);
+
+  const intrval = times[0] - times[1];
+  if (Number.isNaN(interval) && times.length >= 2) interval = intrval;
+
+  if (!Number.isNaN(interval) && interval !== intrval) {
+    throw new Error(`Wrong interval: ${intrval} (should be ${interval})`);
+  }
+
+  console.log('Next ->', times[0]);
+
+  if ((times[0] + 86400) * 1000 > Date.now()) {
+    await client.end();
+    console.log('Done !', times.length);
+  }
+
+  chart.fetchMore(-1);
+});

package/examples/FromToData.js

@@ -0,0 +1,29 @@
+const TradingView = require('../main');
+
+/*
+  This example tests fetching chart
+  data of a number of candles before
+  or after a timestamp
+*/
+
+const client = new TradingView.Client();
+
+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,
+});
+
+// This works with indicators
+
+TradingView.getIndicator('STD;Supertrend').then(async (indic) => {
+  console.log(`Loading '${indic.description}' study...`);
+  const SUPERTREND = new chart.Study(indic);
+
+  SUPERTREND.onUpdate(() => {
+    console.log('Prices periods:', chart.periods);
+    console.log('Study periods:', SUPERTREND.periods);
+    client.end();
+  });
+});

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/GraphicIndicator.js

@@ -10,23 +10,25 @@ const client = new TradingView.Client();
 
 const chart = new client.Session.Chart();
 chart.setMarket('BINANCE:BTCEUR', {
-  timeframe: 'W',
+  timeframe: '5',
+  range: 10000,
 });
 
 // TradingView.getIndicator('USER;01efac32df544348810bc843a7515f36').then((indic) => {
-TradingView.getIndicator('PUB;5xi4DbWeuIQrU0Fx6ZKiI2odDvIW9q2j').then((indic) => {
+// TradingView.getIndicator('PUB;5xi4DbWeuIQrU0Fx6ZKiI2odDvIW9q2j').then((indic) => {
+TradingView.getIndicator('STD;Zig_Zag').then((indic) => {
   const STD = new chart.Study(indic);
 
   STD.onError((...err) => {
-    console.log('Chart error:', ...err);
+    console.log('Study error:', ...err);
   });
 
   STD.onReady(() => {
-    console.log('STD Loaded !');
+    console.log(`STD '${STD.instance.description}' Loaded !`);
   });
 
   STD.onUpdate(() => {
-    console.log(STD.graphic);
+    console.log('Graphic data:', STD.graphic);
     // console.log('Tables:', changes, STD.graphic.tables);
     // console.log('Cells', STD.graphic.tables[0].cells());
     client.end();

package/examples/PinePermManage.js

@@ -0,0 +1,57 @@
+const { PinePermManager } = require('../main');
+
+/*
+  This example creates a pine
+  permission manager and tests
+  all the available functions
+*/
+
+const sessionid = process.argv[2];
+const pineid = process.argv[3];
+
+const manager = new PinePermManager(sessionid, pineid);
+
+(async () => {
+  console.log('Users:', await manager.getUsers());
+
+  console.log('Adding user \'TradingView\'...');
+
+  switch (await manager.addUser('TradingView')) {
+    case 'ok':
+      console.log('Done !');
+      break;
+    case 'exists':
+      console.log('This user is already authorized');
+      break;
+    default:
+      console.error('Unknown error...');
+      break;
+  }
+
+  console.log('Users:', await manager.getUsers());
+
+  console.log('Modifying expiration date...');
+
+  const newDate = new Date(Date.now() + 24 * 3600000); // Add one day
+  if (await manager.modifyExpiration('TradingView', newDate) === 'ok') {
+    console.log('Done !');
+  } else console.error('Unknown error...');
+
+  console.log('Users:', await manager.getUsers());
+
+  console.log('Removing expiration date...');
+
+  if (await manager.modifyExpiration('TradingView') === 'ok') {
+    console.log('Done !');
+  } else console.error('Unknown error...');
+
+  console.log('Users:', await manager.getUsers());
+
+  console.log('Removing user \'TradingView\'...');
+
+  if (await manager.removeUser('TradingView') === 'ok') {
+    console.log('Done !');
+  } else console.error('Unknown error...');
+
+  console.log('Users:', await manager.getUsers());
+})();