Datasets

Data Documentation

Introduction

This page explains how to provide documentation for your dataset so QuantConnect members can use it in their trading algorithms.

Required Key Properties

You need to process the entire dataset to collect the following information:

PropertyDescription
Start DateDate and time of the first data point
Asset CoverageNumber of assets covered by the dataset
Data densityDense for tick data. Regular or Sparse according to the frequency.
ResolutionOptions: Tick, Second, Minute, Hourly, & Daily.
TimezoneData timezone. This is a property of the data source.
Data process timeTime and days of the week to process the data.
Data process durationTime to process the entire the dataset.
Update process durationTime to update the dataset.

Provide Documentation

To provide documentation for your dataset, in the Lean.DataSource.<vendorNameDatasetName> / listing-about.md and Lean.DataSource.<vendorNameDatasetName> / listing-documentation.md files, fill in the missing content.

Next Steps

After we review and accept your dataset contribution, we will create a page in our Dataset Market. At that point, you will be able to write algorithms in QuantConnect Cloud using your dataset and you can contribute an example algorithm for the dataset listing. After your dataset listing is complete, we'll include your new dataset in our downloading data tutorial.

You can also see our Videos. You can also get in touch with us via Discord.

Did you find this page helpful?

Contribute to the documentation: