Config (CLI)
Option | Alias | Default | Description |
---|---|---|---|
--instrument | -i | Trading instrument id. View list | |
--date-from | -from | From date (yyyy-mm-dd) | |
--date-to | -to | now | To date (yyyy-mm-dd or 'now') |
--timeframe | -t | d1 | Timeframe aggregation (tick, s1, m1, m5, m15, m30, h1, h4, d1, mn1) |
--price-type | -p | bid | Price type: (bid, ask) |
--utc-offset | -utc | 0 | UTC offset in minutes |
--volumes | -v | false | Include volumes |
--volume-units | -vu | millions | Volume units (millions, thousands, units) (default: "millions") |
--flats | -fl | false | Include flats (0 volumes) |
--format | -f | json | Output format (csv, json, array). View output examples |
--directory | -dir | ./download | Download directory |
--batch-size | -bs | 10 | Batch size of downloaded artifacts |
--batch-pause | -bp | 1000 | Pause between batches in ms |
--cache | -ch | false | Use cache |
--cache-path | -chpath | ./.dukascopy-cache | Folder path for cache data |
--retries | -r | 0 | Number of retries for a failed artifact download |
--retry-on-empty | -re | false | A flag indicating whether requests with successful but empty (0 Bytes) responses should be retried. If retries is 0 this parameter will be ignored |
--no-fail-after-retries | -fr | false | A flag indicating whether the process should fail after all retries have been exhausted. If retries is 0 this parameter will be ignored |
--retry-pause | -rp | 500 | Pause between retries in milliseconds |
--debug | -d | false | Output extra debugging |
--silent | -s | false | Hides the search config in the CLI output |
--inline | -in | false | Makes files smaller in size by removing new lines in the output (works only with json and array formats) |
--file-name | -fn | `` | Custom file name for the generated file |
--date-format | -df | `` | Date format (example: "YYYY-MM-DD HH:mm:ss" or "iso"). More info |
--time-zone | -tz | `` | Converts dates into specified time zone. More info |
--help | -h | display help for command |