Dukascopy Node

https://github.com/leo4815162342/dukascopy-node
Admin
Node.js library for downloading free historical and real-time market tick data for stocks, crypto,...
Tokens:8,985
Snippets:146
Trust Score:8.5
License:MIT
Update:1 month ago
Show doc for...
Tokens:
Raw
### Example URL generation structure

Source: https://github.com/leo4815162342/dukascopy-node/blob/master/examples/with-custom-batching/README.md

Represents the list of API URLs generated for a month of daily data.

```javascript
[
  `/candles/minute/EUR-USD/BID/2019/6/1`,
  `/candles/minute/EUR-USD/BID/2019/6/2`,
  // ...
  `/candles/minute/EUR-USD/BID/2019/6/30`
]
```

--------------------------------

### Fetch Historical Rates as JSON

Source: https://github.com/leo4815162342/dukascopy-node/wiki/Basic-usage-of-dukascopy-node

This example retrieves historical trading data formatted as a JSON array of objects. The 'dukascopy-node' library must be installed.

```javascript
const { getHistoricalRates } = require('dukascopy-node');

(async () => {
  try {
    const data = await getHistoricalRates({
      instrument: 'eurusd',
      dates: {
        from: new Date('2021-02-01'),
        to: new Date('2021-03-01')
      },
      timeframe: 'd1',
      format: 'json'
    });

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

```bash
npx dukascopy-cli -i eurusd -from 2021-02-01 -to 2021-03-01 -t d1 -f json
```

--------------------------------

### Install dukascopy-node

Source: https://github.com/leo4815162342/dukascopy-node/blob/master/README.md

Commands to add the dukascopy-node package to your project using common Node.js package managers.

```bash
npm install dukascopy-node --save
```

```bash
yarn add dukascopy-node
```

```bash
pnpm add dukascopy-node
```

--------------------------------

### Fetch Historical Rates (Array Format)

Source: https://github.com/leo4815162342/dukascopy-node/wiki/Usage-with-typescript

This example demonstrates fetching historical rates in an array format for a non-tick timeframe. The `format` property in the `Config` object should be set to `Format.array`.

```typescript
import { getHistoricalRates, Config, Instrument, Timeframe, Format } from 'dukascopy-node';

const config: Config = {
  instrument: Instrument.eurusd,
  dates: {
    from: new Date('2021-03-30'),
    to: new Date('2021-03-31')
  },
  timeframe: Timeframe.d1,
  format: Format.array,
  priceType: Price.bid
};

getHistoricalRates(config).then(data => console.log(data));

```

--------------------------------

### Fetch Historical Rates as JSON

Source: https://github.com/leo4815162342/dukascopy-node/blob/master/examples/basic/README.md

This example shows how to fetch historical trading data formatted as a JSON object. The output includes timestamp, open, high, low, close, and volume for each period.

```javascript
const { getHistoricalRates } = require('dukascopy-node');

(async () => {
  try {
    const data = await getHistoricalRates({
      instrument: 'eurusd',
      dates: {
        from: new Date('2021-02-01'),
        to: new Date('2021-03-01')
      },
      timeframe: 'd1',
      format: 'json'
    });

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

```bash
npx dukascopy-node -i eurusd -from 2021-02-01 -to 2021-03-01 -t d1 -f json
```

--------------------------------

### Fetch Historical Rates as Array

Source: https://github.com/leo4815162342/dukascopy-node/wiki/Basic-usage-of-dukascopy-node

Use this snippet to get historical trading data in a simple array format. Ensure the 'dukascopy-node' library is installed.

```javascript
const { getHistoricalRates } = require('dukascopy-node');

(async () => {
  try {
    const data = await getHistoricalRates({
      instrument: 'eurusd',
      dates: {
        from: new Date('2021-02-01'),
        to: new Date('2021-03-01')
      },
      timeframe: 'd1',
      format: 'array'
    });

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

```bash
npx dukascopy-cli -i eurusd -from 2021-02-01 -to 2021-03-01 -t d1 -f array
```

--------------------------------

### Fetch Historical Rates as Array

Source: https://github.com/leo4815162342/dukascopy-node/blob/master/examples/basic/README.md

Use this snippet to retrieve historical trading data in a simple array format. Ensure the 'dukascopy-node' package is installed.

```javascript
const { getHistoricalRates } = require('dukascopy-node');

(async () => {
  try {
    const data = await getHistoricalRates({
      instrument: 'eurusd',
      dates: {
        from: new Date('2021-02-01'),
        to: new Date('2021-03-01')
      },
      timeframe: 'd1',
      format: 'array'
    });

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

```bash
npx dukascopy-node -i eurusd -from 2021-02-01 -to 2021-03-01 -t d1 -f array
```

--------------------------------

### Fetch Historical Rates as CSV

Source: https://github.com/leo4815162342/dukascopy-node/wiki/Basic-usage-of-dukascopy-node

Obtain historical trading data in CSV format using this code. Ensure the 'dukascopy-node' library is installed before running.

```javascript
const { getHistoricalRates } = require('dukascopy-node');

(async () => {
  try {
    const data = await getHistoricalRates({
      instrument: 'eurusd',
      dates: {
        from: new Date('2021-02-01'),
        to: new Date('2021-03-01')
      },
      timeframe: 'd1',
      format: 'csv'
    });

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

```bash
npx dukascopy-cli -i eurusd -from 2021-02-01 -to 2021-03-01 -t d1 -f csv
```

--------------------------------

### Download Tick Data with JavaScript

Source: https://github.com/leo4815162342/dukascopy-node/wiki/Downloading-tick-data

Use this snippet to download tick data for a specified instrument and date range. Ensure you have the 'dukascopy-node' library installed. Tick data does not contain OHLC prices.

```javascript
const { getHistoricalRates } = require('dukascopy-node');

(async () => {
  try {
    const data = await getHistoricalRates({
      instrument: 'eurusd',
      dates: {
        from: new Date('2021-03-30'),
        to: new Date('2021-03-31'),
      },
      timeframe: 'tick'
    });

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

--------------------------------

### Configure Batch Size and Pause via CLI

Source: https://github.com/leo4815162342/dukascopy-node/wiki/Downloading-data-with-custom-batching

Customize the download process by specifying the number of items per batch and the pause duration between batches using CLI arguments.

```bash
npx dukascopy-node -i eurusd -from 2019-06-01 -to 2019-07-01 -t m1 -bs 15 -bp 2000
```

--------------------------------

### Enable caching via CLI

Source: https://github.com/leo4815162342/dukascopy-node/blob/master/examples/with-cache/README.md

Use the --cache flag in the command line interface to enable local storage of downloaded data.

```bash
npx dukascopy-node -i eurusd -from 2021-02-01 -to 2021-03-01 -t m1 -f json --cache
```

--------------------------------

### Enable Debugging with Environment Variable

Source: https://github.com/leo4815162342/dukascopy-node/blob/master/examples/with-debugging/README.md

Prepend DEBUG=dukascopy-node:cli:* to your command to enable debugging. This provides more granular control over debug output.

```bash
DEBUG=dukascopy-node:cli:* npx dukascopy-node -i usdjpy -from 2022-03-21 -to 2022-03-22 -t m1
```

--------------------------------

### Download Data with dukascopy-node CLI

Source: https://github.com/leo4815162342/dukascopy-node/wiki/Downloading-data-with-CLI

Use this command to download financial data. Specify the instrument, date range, time interval, and output format. The data is saved to the './download' directory by default.

```bash
npx dukascopy-node -i btcusd -from 2019-01-01 -to 2019-01-14 -t m1 -f json
```

--------------------------------

### Download Real-Time Data via Node.js

Source: https://github.com/leo4815162342/dukascopy-node/blob/master/README.md

Fetches current market rates programmatically using the getRealTimeRates function.

```javascript
const { getRealTimeRates } = require('dukascopy-node');

(async () => {
  try {
    const data = await getRealTimeRates({
      instrument: 'eurusd',
      timeframe: 'tick',
      format: 'json'
    });

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

--------------------------------

### Download Tick Data via CLI

Source: https://github.com/leo4815162342/dukascopy-node/blob/master/examples/with-tick-data/README.md

Execute this command in your terminal to download tick data. Adjust instrument, dates, and timeframe as needed. Be aware that tick data can be very large.

```bash
npx dukascopy-node -i eurusd -from 2021-03-30 -to 2021-03-31 -t tick
```

--------------------------------

### Download Historical Data via CLI

Source: https://github.com/leo4815162342/dukascopy-node/blob/master/README.md

Executes a historical data download directly from the terminal.

```bash
npx dukascopy-node -i btcusd -from 2019-01-13 -to 2019-01-14 -t tick -f csv
```

--------------------------------

### Download Tick Data via CLI

Source: https://github.com/leo4815162342/dukascopy-node/wiki/Downloading-tick-data

This command-line interface command allows downloading tick data. Specify the instrument, date range, and timeframe. The output format is set to JSON.

```bash
npx dukascopy-node -i eurusd -from 2021-03-30 -to 2021-03-31 -t tick -f json
```

--------------------------------

### Enable Caching in Node.js

Source: https://github.com/leo4815162342/dukascopy-node/wiki/Downloading-data-with-cache

Set the 'useCache' option to true in the getHistoricalRates function to enable caching. Optionally, specify 'cacheFolderPath' for a custom cache directory.

```javascript
const { getHistoricalRates } = require('dukascopy-node');

(async () => {
  try {
    const data = await getHistoricalRates({
      instrument: 'eurusd',
      dates: {
        from: new Date('2021-02-01'),
        to: new Date('2021-03-01')
      },
      timeframe: 'd1',
      format: 'json',
      useCache: true,
    });

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

--------------------------------

### Fetch historical rates with default batching

Source: https://github.com/leo4815162342/dukascopy-node/blob/master/examples/with-custom-batching/README.md

Fetches minutely data for a specific instrument and date range using default batch settings.

```javascript
const { getHistoricalRates } = require('dukascopy-node');

(async () => {
  const data = await getHistoricalRates({
    instrument: 'eurusd',
    dates: {
      from: new Date('2019-06-01'),
      to: new Date('2019-07-01')
    },
    timeframe: 'm1'
  });

  console.log(data);
})();
```

```bash
npx dukascopy-node -i eurusd -from 2019-06-01 -to 2019-07-01 -t m1
```

--------------------------------

### Fetch historical rates with custom batching

Source: https://github.com/leo4815162342/dukascopy-node/blob/master/examples/with-custom-batching/README.md

Configures batch size and pause duration to optimize request pressure for large data ranges.

```javascript
const { getHistoricalRates } = require('dukascopy-node');

(async () => {
  const data = await getHistoricalRates({
    instrument: 'eurusd',
    dates: {
      from: new Date('2019-06-01'),
      to: new Date('2019-07-01')
    },
    timeframe: 'm1',
    batchSize: 15,
    pauseBetweenBatchesMs: 2000
  });

  console.log(data);
})();
```

```bash
npx dukascopy-node -i eurusd -from 2019-06-01 -to 2019-07-01 -t m1 --batch-size 15 --batch-pause 2000
```

--------------------------------

### Download Historical Data via Node.js

Source: https://github.com/leo4815162342/dukascopy-node/blob/master/README.md

Fetches historical rates programmatically using the getHistoricalRates function.

```javascript
const { getHistoricalRates } = require('dukascopy-node');

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

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

--------------------------------

### Enable Debugging with CLI Flag

Source: https://github.com/leo4815162342/dukascopy-node/blob/master/examples/with-debugging/README.md

Use the -d flag with npx to enable debugging for CLI calls. This is useful for troubleshooting.

```bash
npx dukascopy-node -i usdjpy -from 2022-03-21 -to 2022-03-22 -t m1 -d
```

--------------------------------

### Enable caching via Node.js

Source: https://github.com/leo4815162342/dukascopy-node/blob/master/examples/with-cache/README.md

Set the useCache property to true within the configuration object passed to getHistoricalRates.

```javascript
const { getHistoricalRates } = require("dukascopy-node");

(async () => {
  try {
    const data = await getHistoricalRates({
      instrument: "eurusd",
      dates: {
        from: new Date("2021-02-01"),
        to: new Date("2021-03-01"),
      },
      timeframe: "d1",
      format: "json",
      useCache: true,
    });

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

--------------------------------

### Fetch Historical Rates (CSV Format)

Source: https://github.com/leo4815162342/dukascopy-node/wiki/Usage-with-typescript

Use this code to fetch historical rates in CSV format. The `format` property in the `Config` object should be set to `Format.csv`.

```typescript
import { getHistoricalRates, Config, Instrument, Timeframe, Format } from 'dukascopy-node';

const config: Config = {
  instrument: Instrument.eurusd,
  dates: {
    from: new Date('2021-03-30'),
    to: new Date('2021-03-31')
  },
  timeframe: Timeframe.d1,
  format: Format.csv,
  priceType: Price.bid
};

getHistoricalRates(config).then(data => console.log(data));

```

--------------------------------

### Fetch Tick Data (Array Format)

Source: https://github.com/leo4815162342/dukascopy-node/wiki/Usage-with-typescript

This snippet shows how to fetch tick data in an array format. Set `timeframe` to `Timeframe.tick` and `format` to `Format.array` in the `Config` object.

```typescript
import { getHistoricalRates, Config, Instrument, Timeframe, Format } from 'dukascopy-node';

const config: Config = {
  instrument: Instrument.eurusd,
  dates: {
    from: new Date('2021-03-30'),
    to: new Date('2021-03-31')
  },
  timeframe: Timeframe.tick,
  format: Format.array,
  priceType: Price.bid
};

getHistoricalRates(config).then(data => console.log(data));

```

--------------------------------

### Fetch Historical Rates (JSON Format)

Source: https://github.com/leo4815162342/dukascopy-node/wiki/Usage-with-typescript

Use this snippet to fetch historical rates in JSON format for a non-tick timeframe. Ensure the `Config` object is correctly set with instrument, dates, timeframe, format, and price type.

```typescript
import { getHistoricalRates, Config, Instrument, Timeframe, Format } from 'dukascopy-node';

const config: Config = {
  instrument: Instrument.eurusd,
  dates: {
    from: new Date('2021-03-30'),
    to: new Date('2021-03-31')
  },
  timeframe: Timeframe.d1,
  format: Format.json,
  priceType: Price.bid
};

getHistoricalRates(config).then(data => console.log(data));

```

--------------------------------

### Fetch Tick Data (JSON Format)

Source: https://github.com/leo4815162342/dukascopy-node/wiki/Usage-with-typescript

Retrieve tick data in JSON format by setting the `timeframe` to `Timeframe.tick`. This is useful for high-frequency trading analysis.

```typescript
import { getHistoricalRates, Config, Instrument, Timeframe, Format } from 'dukascopy-node';

const config: Config = {
  instrument: Instrument.eurusd,
  dates: {
    from: new Date('2021-03-30'),
    to: new Date('2021-03-31')
  },
  timeframe: Timeframe.tick,
  format: Format.json,
  priceType: Price.bid
};

getHistoricalRates(config).then(data => console.log(data));

```

--------------------------------

### Fetch Historical Rates as CSV

Source: https://github.com/leo4815162342/dukascopy-node/blob/master/examples/basic/README.md

Retrieve historical trading data in CSV format. This is useful for direct import into spreadsheet software or data analysis tools. The output includes a header row.

```javascript
const { getHistoricalRates } = require('dukascopy-node');

(async () => {
  try {
    const data = await getHistoricalRates({
      instrument: 'eurusd',
      dates: {
        from: new Date('2021-02-01'),
        to: new Date('2021-03-01')
      },
      timeframe: 'd1',
      format: 'csv'
    });

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

```bash
npx dukascopy-node -i eurusd -from 2021-02-01 -to 2021-03-01 -t d1 -f csv
```

--------------------------------

### Tick Data Output Shape

Source: https://github.com/leo4815162342/dukascopy-node/wiki/Downloading-tick-data

The output for tick data includes timestamp, ask price, bid price, ask volume, and bid volume. It does not contain OHLC data.

```json
[
    {
    "timestamp": 1585526400104,
    "askPrice": 1.11369,
    "bidPrice": 1.11361,
    "askVolume": 0.75,
    "bidVolume": 0.75
  },
]
```
Tokens:
Raw