@mathieuc/tradingview 3.0.0 → 3.0.1

package/README.md

@@ -9,7 +9,7 @@ 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] Get values from a specific date range
 - [ ] TradingView socket server emulation
 - [ ] Interract with public chats
 - [ ] Get Screener top values

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/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/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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mathieuc/tradingview",
-  "version": "3.0.0",
+  "version": "3.0.1",
   "description": "Tradingview instant stocks API, indicator alerts, trading bot, and more !",
   "main": "main.js",
   "scripts": {

package/src/chart/session.js

@@ -53,15 +53,16 @@ const ChartTypes = {
  * @prop {number} close Period close value
  * @prop {number} max Period max value
  * @prop {number} min Period min value
- * @prop {number} change Period change absolute value
+ * @prop {number} volume Period volume value
  */
 
 /**
  * @typedef {Object} Subsession
  * @prop {string} id Subsession ID (ex: 'regular')
  * @prop {string} description Subsession description (ex: 'Regular')
- * @prop {string} privat If private
+ * @prop {boolean} private If private
  * @prop {string} session Session (ex: '24x7')
+ * @prop {string} session-correction Session correction
  * @prop {string} session-display Session display (ex: '24x7')
  *
  * @typedef {Object} MarketInfos
@@ -91,7 +92,7 @@ const ChartTypes = {
  * @prop {number} minmove2             Minimum move value 2
  * @prop {string} timezone             Used timezone
  * @prop {boolean} is_replayable       If the replay mode is available
- * @prop {boolean} has_adjustment      If the adjustment mode is enabled ????
+ * @prop {boolean} has_adjustment      If the adjustment mode is enabled
  * @prop {boolean} has_extended_hours  Has extended hours
  * @prop {string} bar_source           Bar source
  * @prop {string} bar_transform        Bar transform
@@ -200,7 +201,7 @@ module.exports = (client) => class ChartSession {
                   close: p.v[4],
                   max: p.v[2],
                   min: p.v[3],
-                  change: Math.round(p.v[5] * 100) / 100,
+                  volume: Math.round(p.v[5] * 100) / 100,
                 };
               });
 
@@ -241,13 +242,16 @@ module.exports = (client) => class ChartSession {
   /**
    * @param {import('../types').TimeFrame} timeframe Chart period timeframe
    * @param {number} [range] Number of loaded periods/candles (Default: 100)
+   * @param {number} [reference] Reference candle timestamp (Default is now)
    */
-  setSeries(timeframe = '240', range = 100) {
+  setSeries(timeframe = '240', range = 100, reference = null) {
     if (!this.#currentSeries) {
       this.#handleError('Please set the market before setting series');
       return;
     }
 
+    const calcRange = !reference ? range : ['bar_count', reference, range];
+
     this.#periods = {};
 
     this.#client.send(`${this.#seriesCreated ? 'modify' : 'create'}_series`, [
@@ -256,7 +260,7 @@ module.exports = (client) => class ChartSession {
       's1',
       `ser_${this.#currentSeries}`,
       timeframe,
-      this.#seriesCreated ? '' : range,
+      this.#seriesCreated ? '' : calcRange,
     ]);
 
     this.#seriesCreated = true;
@@ -268,6 +272,7 @@ module.exports = (client) => class ChartSession {
    * @param {Object} [options] Chart options
    * @param {import('../types').TimeFrame} [options.timeframe] Chart period timeframe
    * @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 {'regular' | 'extended'} [options.session] Chart session
    * @param {'EUR' | 'USD' | string} [options.currency] Chart currency
@@ -302,7 +307,7 @@ module.exports = (client) => class ChartSession {
       `=${JSON.stringify(chartInit)}`,
     ]);
 
-    this.setSeries(options.timeframe, options.range);
+    this.setSeries(options.timeframe, options.range, options.to);
   }
 
   /**

package/src/classes/BuiltInIndicator.js

@@ -1,5 +1,6 @@
 /**
- * @typedef {'VbPFixed@tv-basicstudies-139!'
+ * @typedef {'Volume@tv-basicstudies-144'
+ *  | 'VbPFixed@tv-basicstudies-139!'
  *  | 'VbPFixed@tv-volumebyprice-53!'
  *  | 'VbPSessions@tv-volumebyprice-53'
  *  | 'VbPSessionsRough@tv-volumebyprice-53!'
@@ -16,6 +17,10 @@
  */
 
 const defaultValues = {
+  'Volume@tv-basicstudies-144': {
+    length: 20,
+    col_prev_close: false,
+  },
   'VbPFixed@tv-basicstudies-139!': {
     rowsLayout: 'Number Of Rows',
     rows: 24,