README

dukascopy-node

Download historical market tick data for 800+ instruments (Stocks / Commodities / Bonds / Currencies / CFDs / ETFs / Crypto) via Node.js

Installation

NPM:

npm install dukascopy-node --save

yarn:

yarn add dukascopy-node

Usage (try it live)

const { getHistoricRates } = require('dukascopy-node');

(async () => {
  try {
    const data = await getHistoricRates({
      instrument: 'btcusd',
      dates: {
        from: new Date('2018-01-01'),
        to: new Date('2019-01-01')
      },
      timeframe: 'd1',
      format: 'json'
    });

    console.log(data);
  } catch (error) {
    console.log('error', error);
  }
})();

Detailed examples

Config object

|Name|Type|Required|Default|Description| |-|-|-|-|-| |instrument|String|true||An id of the trading instrument. Supported values: see list| |dates|Object|true||An object with a date range| |dates.from|

Date

String

Number

|true||Date representing the start of the time range. Can be of Date type, string (e.g. 2021-03-04 or 2021-03-04T00:00:00.000Z), or timestamp integer (e.g. 1614816000000)| |dates.to|

Date

String

Number

|true||Date representing the end of the time range Can be of Date type, string (e.g. 2021-03-04 or 2021-03-04T00:00:00.000Z), or timestamp integer (e.g. 1614816000000)| |timeframe|String|false|d1|Granularity of aggregation of OHLC (open, high, low, close) data. Supported values:

tick (every single tick/price change)
m1 (1 minute)
m5 (5 minutes)
m15 (15 minutes)
m30 (30 minutes)
h1 (1 hour)
h4 (4 hours)
d1 (1 day)
mn1 (1 month)

bid
ask

array
json
csv

Example of a full config object

{
  instrument: 'btcusd',
  dates: {
    from: '2018-01-01', // or 2018-01-01T00:00:00.000Z
    to: '2019-01-01', // or 2019-01-01T00:00:00.000Z
  },
  timeframe: 'd1',
  priceType: 'ask',
  format: 'json',
  utcOffset: 0,
  volumes: true,
  ignoreFlats: true,
  batchSize: 10,
  pauseBetweenBatchesMs: 1000,
  useCache: true,
  cacheFolderPath: '.dukascopy-cache',
  retryCount: 5,
  pauseBetweenRetriesMs: 250
}

Instruments

Bonds 📊 (3)
Crypto assets ₿ (19)
Agricultural commodities ☕ (6)
Energy commodities ⚡ (4)
Metals commodities ⚙️ (1)
Germany ETFs 🇩🇪📈 (1)
France ETFs 🇫🇷📈 (3)
Hong Kong ETFs 🇭🇰📈 (4)
United States ETFs 🇺🇸📈 (43)
Forex currencies 💱 (54)
Forex major currencies 💶 (7)
Forex metals 🥇 (2)
America 🌎 (5)
Asia 🌏 (6)
Europe 🌍 (8)
Austria 🇦🇹 (3)
Belgium 🇧🇪 (7)
Denmark 🇩🇰 (8)
Finland 🇫🇮 (7)
France 🇫🇷 (35)
Germany 🇩🇪 (35)
Hong Kong 🇭🇰 (27)
Ireland 🇮🇪 (5)
Italy 🇮🇹 (48)
Japan 🇯🇵 (55)
Netherlands 🇳🇱 (16)
Norway 🇳🇴 (6)
Portugal 🇵🇹 (2)
Spain 🇪🇸 (18)
Sweden 🇸🇪 (20)
Switzerland 🇨🇭 (20)
United Kingdom 🇬🇧 (80)
United States 🇺🇸 (258)

Bonds 📊

Crypto assets ₿

Agricultural commodities ☕

Energy commodities ⚡

Metals commodities ⚙️

|Instrument|id|Earliset tick data (UTC)|Earliset minute data (UTC)|Earliset hour data (UTC)|Earliset day data (UTC)| |-|-|-|-|-|-| |High Grade Copper|coppercmdusd|Mar 2, 2012, 12:00:07 AM|Mar 2, 2012, 12:00 AM|Mar 2, 2012, 12 AM|Mar 2, 2012|

Germany ETFs 🇩🇪📈

|Instrument|id|Earliset tick data (UTC)|Earliset minute data (UTC)|Earliset hour data (UTC)|Earliset day data (UTC)| |-|-|-|-|-|-| |iShares TecDAX UCITS DE ETF|tecdaxedeeur|Sep 22, 2020, 7:00:00 AM|Sep 22, 2020, 7:00 AM|Sep 22, 2020, 6 AM|Sep 22, 2020|

France ETFs 🇫🇷📈

Hong Kong ETFs 🇭🇰📈

United States ETFs 🇺🇸📈

Forex currencies 💱

Forex major currencies 💶

Forex metals 🥇

America 🌎

Asia 🌏

Europe 🌍

Austria 🇦🇹

Belgium 🇧🇪

Denmark 🇩🇰

Finland 🇫🇮

France 🇫🇷

Germany 🇩🇪

Hong Kong 🇭🇰

Ireland 🇮🇪

Italy 🇮🇹

Japan 🇯🇵

Netherlands 🇳🇱

Norway 🇳🇴

Portugal 🇵🇹

Spain 🇪🇸

Sweden 🇸🇪

Switzerland 🇨🇭

United Kingdom 🇬🇧

Usage no npm install needed!