@mathieuc/tradingview 2.0.91 → 3.2.0

package/.eslintrc.js

@@ -1,16 +1,18 @@
-module.exports = {
-  env: {
-    commonjs: true,
-    es2021: true,
-    node: true,
-  },
-  extends: [
-    'airbnb-base',
-  ],
-  parserOptions: {
-    ecmaVersion: 12,
-  },
-  rules: {
-    'no-console': 'off',
-  },
-};
+module.exports = {
+  env: {
+    commonjs: true,
+    es2021: true,
+    node: true,
+  },
+  extends: [
+    'airbnb-base',
+  ],
+  parser: '@babel/eslint-parser',
+  parserOptions: {
+    ecmaVersion: 12,
+    requireConfigFile: false,
+  },
+  rules: {
+    'no-console': 'off',
+  },
+};

package/README.md

@@ -1,20 +1,29 @@
-# Tradingview API
+# 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/)
+
+[![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)
+[![GitHub latest commit](https://img.shields.io/github/last-commit/Mathieu2301/TradingView-API)](https://GitHub.com/Mathieu2301/TradingView-API/commit/)
+[![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
 - [x] Works with invite-only indicators
 - [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
 - [ ] Get Hotlists
 - [ ] Get Calendar
-- IF YOU WANT A FEATURE, ASK ME !!
+- IF YOU WANT A FEATURE, ASK ME !
 
 ## Possibilities
 - Trading bot
@@ -26,106 +35,18 @@ Get realtime market prices and indicator values from Tradingview !
 ___
 ## Installation
 
-```
+Stable version:
+```ruby
 npm i @mathieuc/tradingview
 ```
-
-## Examples (./tests/)
-
-```javascript
-/*
-  ./tests/prices.js
-  Search for Bitcoin and Ethereum and get real time prices
-*/
-
-const marketAPI = require('tradingview');
-
-(async () => {
-  const market = marketAPI();
-
-  market.on('logged', async () => {
-    console.log('API LOGGED');
-
-    const searchBTC = (await market.search('bitcoin euro', 'crypto'))[0];
-    console.log('Found Bitcoin / Euro:', searchBTC);
-    market.subscribe(searchBTC.id);
-  });
-
-  market.on('price', (data) => {
-    console.log(data.symbol, '=>', data.price);
-  });
-
-  const searchETH = (await market.search('ethereum euro', 'crypto'))[0];
-  console.log('Found Ethereum / Euro:', searchETH);
-
-  setTimeout(() => {
-    console.log('Subscribe to', searchETH.id);
-    market.subscribe(searchETH.id);
-  }, 10000);
-
-  setTimeout(() => {
-    console.log('Unsubscribe from', searchETH.id);
-    market.unsubscribe(searchETH.id);
-  }, 20000);
-})();
-```
-
-```javascript
-/*
-  ./tests/analysis.js
-  Search for Bitcoin and get the Technical Analysis in all timeframes
-*/
-
-const marketAPI = require('tradingview');
-
-(async () => {
-  const market = marketAPI(false);
-
-  const searchBTC = (await market.search('bitcoin euro', 'crypto'))[0];
-  console.log('Found Bitcoin / Euro:', searchBTC);
-
-  const TA = await searchBTC.getTA();
-  console.log('Full technical analysis for Bitcoin:', TA);
-
-  // You can also use this way: await market.getTA('crypto', 'BINANCE:BTCEUR');
-})();
+Last version:
+```ruby
+npm i github:Mathieu2301/TradingView-API
 ```
 
-```javascript
-/*
-  ./tests/indicator.js
-  Get indicator values
-*/
-
-const marketAPI = require('tradingview');
+## Examples
+You can find all the examples and snippets in `./examples` folder.
 
-const market = marketAPI(false); // 'false' for chart-only mode
-
-market.on('logged', () => {
-  market.initChart({
-    symbol: 'COINBASE:BTCEUR',
-    period: '240',
-    range: 50,
-    indicators: [
-      { name: 'ACCU_DISTRIB', id: 'STD;Accumulation_Distribution', version: '25' },
-      { name: 'CIPHER_A', id: 'PUB;vrOJcNRPULteowIsuP6iHn3GIxBJdXwT', version: '1.0' },
-      { name: 'CIPHER_B', id: 'PUB;uA35GeckoTA2EfgI63SD2WCSmca4njxp', version: '15.0' },
-      // Color Changing moving average
-      { name: 'CCMA', id: 'PUB;5nawr3gCESvSHQfOhrLPqQqT4zM23w3X', version: '6.0' },
-    ],
-  }, (periods) => {
-    if (!periods[0].CIPHER_B) return;
-    if (!periods[0].CCMA) return;
-
-    console.log('Last period:', {
-      price: periods[0].$prices.close,
-      moneyFlow: (periods[0].CIPHER_B.RSIMFIArea >= 0) ? 'POSITIVE' : 'NEGATIVE',
-      VWAP: periods[0].CIPHER_B.VWAP,
-      MA: (periods[0].CCMA.Plot <= periods[0].$prices.close) ? 'ABOVE' : 'UNDER',
-    });
-  });
-});
-```
 ___
 ## Problems
  If you have errors in console or unwanted behavior,

package/examples/AllPrivateIndicators.js

@@ -0,0 +1,35 @@
+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');
+
+const client = new TradingView.Client({
+  token: process.argv[2],
+});
+
+const chart = new client.Session.Chart();
+chart.setMarket('BINANCE:BTCEUR', {
+  timeframe: 'D',
+});
+
+TradingView.getPrivateIndicators(process.argv[2]).then((indicList) => {
+  indicList.forEach(async (indic) => {
+    const privateIndic = await indic.get();
+    console.log('Loading indicator', indic.name, '...');
+
+    const indicator = new chart.Study(privateIndic);
+
+    indicator.onReady(() => {
+      console.log('Indicator', indic.name, 'loaded !');
+    });
+
+    indicator.onUpdate(() => {
+      console.log('Plot values', indicator.periods);
+      console.log('Strategy report', indicator.strategyReport);
+    });
+  });
+});

package/examples/BuiltInIndicator.js

@@ -0,0 +1,41 @@
+const TradingView = require('../main');
+
+/*
+  This example tests built-in indicators
+  like volume-based indicators
+*/
+
+const volumeProfile = new TradingView.BuiltInIndicator('VbPFixed@tv-basicstudies-139!');
+
+if (!process.argv[2] && volumeProfile.type !== 'VbPFixed@tv-basicstudies-139!') {
+  throw Error('Please specify your \'sessionid\' cookie');
+}
+
+const client = new TradingView.Client({
+  token: process.argv[2],
+});
+
+const chart = new client.Session.Chart();
+chart.setMarket('BINANCE:BTCEUR', {
+  timeframe: '60',
+  range: 1,
+});
+
+/* Required or not, depending on the indicator */
+volumeProfile.setOption('first_bar_time', Date.now() - 10 ** 8);
+// volumeProfile.setOption('first_visible_bar_time', Date.now() - 10 ** 8);
+
+const VOL = new chart.Study(volumeProfile);
+VOL.onUpdate(() => {
+  VOL.graphic.horizHists
+    .filter((h) => h.lastBarTime === 0) // We only keep recent volume infos
+    .sort((a, b) => b.priceHigh - a.priceHigh)
+    .forEach((h) => {
+      console.log(
+        `~ ${Math.round((h.priceHigh + h.priceLow) / 2)} € :`,
+        `${'_'.repeat(h.rate[0] / 3)}${'_'.repeat(h.rate[1] / 3)}`,
+      );
+    });
+
+  client.end();
+});

package/examples/CurrentTimeframe.js

@@ -0,0 +1,34 @@
+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/CustomChartType.js

@@ -0,0 +1,122 @@
+const TradingView = require('../main');
+
+/*
+  This example creates charts of custom
+  types such as 'HeikinAshi', 'Renko',
+  'LineBreak', 'Kagi', 'PointAndFigure',
+  and 'Range' with default settings
+*/
+
+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],
+});
+
+const chart = new client.Session.Chart();
+
+chart.onError((...err) => {
+  console.log('Chart error:', ...err);
+  process.exit(1);
+});
+
+chart.onUpdate(() => {
+  if (!chart.periods[0]) return;
+  console.log('Last period', chart.periods[0]);
+});
+
+/* (0s) Heikin Ashi chart */
+setTimeout(() => {
+  console.log('\nSetting chart type to: HeikinAshi');
+
+  chart.setMarket('BINANCE:BTCEUR', {
+    type: 'HeikinAshi',
+    timeframe: 'D',
+  });
+}, 0);
+
+/* (5s) Renko chart */
+setTimeout(() => {
+  console.log('\nSetting chart type to: Renko');
+
+  chart.setMarket('BINANCE:BTCEUR', {
+    type: 'Renko',
+    timeframe: 'D',
+    inputs: {
+      source: 'close',
+      sources: 'Close',
+      boxSize: 3,
+      style: 'ATR',
+      atrLength: 14,
+      wicks: true,
+    },
+  });
+}, 5000);
+
+/* (10s) Line Break chart */
+setTimeout(() => {
+  console.log('\nSetting chart type to: LineBreak');
+
+  chart.setMarket('BINANCE:BTCEUR', {
+    type: 'LineBreak',
+    timeframe: 'D',
+    inputs: {
+      source: 'close',
+      lb: 3,
+    },
+  });
+}, 10000);
+
+/* (15s) Kagi chart */
+setTimeout(() => {
+  console.log('\nSetting chart type to: Kagi');
+
+  chart.setMarket('BINANCE:BTCEUR', {
+    type: 'Kagi',
+    timeframe: 'D',
+    inputs: {
+      source: 'close',
+      style: 'ATR',
+      atrLength: 14,
+      reversalAmount: 1,
+    },
+  });
+}, 15000);
+
+/* (20s) Point & Figure chart */
+setTimeout(() => {
+  console.log('\nSetting chart type to: PointAndFigure');
+
+  chart.setMarket('BINANCE:BTCEUR', {
+    type: 'PointAndFigure',
+    timeframe: 'D',
+    inputs: {
+      sources: 'Close',
+      reversalAmount: 3,
+      boxSize: 1,
+      style: 'ATR',
+      atrLength: 14,
+      oneStepBackBuilding: false,
+    },
+  });
+}, 20000);
+
+/* (25s) Range chart */
+setTimeout(() => {
+  console.log('\nSetting chart type to: Range');
+
+  chart.setMarket('BINANCE:BTCEUR', {
+    type: 'Range',
+    timeframe: 'D',
+    inputs: {
+      range: 1,
+      phantomBars: false,
+    },
+  });
+}, 25000);
+
+/* (30s) Delete chart, close client */
+setTimeout(() => {
+  console.log('\nClosing client...');
+  client.end();
+}, 30000);

package/examples/CustomTimeframe.js

@@ -0,0 +1,29 @@
+const TradingView = require('../main');
+
+/*
+  This example tests custom
+  timeframes like 1 second
+*/
+
+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.setTimezone('Europe/Paris');
+
+chart.setMarket('CAPITALCOM:US100', {
+  timeframe: '1S',
+  range: 10,
+});
+
+chart.onSymbolLoaded(() => {
+  console.log(chart.infos.name, 'loaded !');
+});
+
+chart.onUpdate(() => {
+  console.log('OK', chart.periods);
+  client.end();
+});

package/examples/Errors.js

@@ -0,0 +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 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();
+  });
+});