Giter VIP home page Giter VIP logo

lean.datasource.cnstock's Introduction

LEAN Data Source SDK

Lean DataSource SDK

Build Status

Introduction

The Lean Data SDK is a cross-platform template repository for developing custom data types for Lean. These data types will be consumed by QuantConnect trading algorithms and research environment, locally or in the cloud.

It is composed by example .Net solution for the data type and converter scripts.

Prerequisites

The solution targets dotnet 5, for installation instructions please follow dotnet download.

The data downloader and converter script can be developed in different ways: C# executable, Python script, Python Jupyter notebook or even a bash script.

  • The python script should be compatible with python 3.6.8
  • Bash script will run on Ubuntu Bionic

Specifically, the enviroment where these scripts will be run is quantconnect/research based on quantconnect/lean:foundation.

Installation

The "Use this template" feature should be used for each unique data source which requires its own data processing. Once it is cloned locally, you should be able to successfully build the solution, run all tests and execute the downloader and/or conveter scripts. The final version should pass all CI tests of GitHub Actions.

Once ready, please contact [email protected] and we will create a listing in the QuantConnect Data Market for your company and link to your public repository and commit hash.

Datasets Vendor Requirements

Key requirements for new vendors include:

  • A well-defined dataset with a clear and static vision for the data to minimize churn or changes as people will be building systems from it. This is easiest with "raw" data (e.g. sunshine hours vs a sentiment algorithm)
  • Robust ticker and security links to ensure the tickers are tracked well through time, or accurately point in time. ISIN, FIGI, or point in time ticker supported
  • Robust funding to ensure viable for at least 1 year
  • Robust API to ensure reliable up-time. No dead links on site or and 502 servers while using API
  • Consistent delivery schedule, on time and in time for market trading
  • Consistent data format with notifications and lead time on data format updates
  • At least 1 year of historical point in time data
  • Survivorship bias free data
  • Good documentation for the dataset

Tutorials

  • See Tutorials for a step by step guide for creating a new LEAN Data Source.

lean.datasource.cnstock's People

Contributors

zengxinle avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.