Skip to content

Commit d820bb8

Browse files
authored
Update README.md
1 parent 66c177c commit d820bb8

1 file changed

Lines changed: 60 additions & 2 deletions

File tree

README.md

Lines changed: 60 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,60 @@
1-
# Lean.DataSource.ThetaData
2-
Integration with ThetaData for Options History and Live Streaming
1+
![LEAN Data Source SDK](http://cdn.quantconnect.com.s3.us-east-1.amazonaws.com/datasources/Github_LeanDataSourceSDK.png)
2+
3+
# Lean ThetaData DataSource Plugin
4+
5+
[![Build & Test](https://github.com/QuantConnect/Lean.DataSource.ThetaData/actions/workflows/gh-actions.yml/badge.svg)](https://github.com/QuantConnect/Lean.DataSource.ThetaData/actions/workflows/gh-actions.yml)
6+
7+
Welcome to the ThetaData Library repository! This library, built on .NET 6, provides seamless integration with the QuantConnect LEAN Algorithmic Trading Engine. It empowers users to interact with ThetaData's financial dataset to create powerful trading algorithms.
8+
9+
## Introduction
10+
ThetaData Library is an open-source project written in C#, designed to simplify the process of accessing real-time and historical financial market data. With support for Options Data across all exchanges and low latency, it offers a comprehensive solution for algorithmic trading.
11+
12+
## Features
13+
### Easy Integration with QuantConnect LEAN Algorithmic Trading Engine
14+
Seamlessly incorporate ThetaData into your trading strategies within the QuantConnect LEAN environment.
15+
16+
### Rich Financial Data
17+
Access a wealth of financial data including real-time and historical information. Subscribe to different option contracts with various expiry dates, strikes, and rights.
18+
19+
### Flexible Configuration
20+
Customize the library to suit your needs with flexible configuration options.
21+
22+
### Symbol SecurityType Support
23+
#### Historical Data
24+
- [x] Option
25+
#### Real-time Updates
26+
- [x] Option
27+
- [x] Index - [support tickers list](https://http-docs.thetadata.us/docs/theta-data-rest-api-v2/s1ezbyfni6rw0-index-option-tickers)
28+
- [x] IndexOption - [support tickers list](https://http-docs.thetadata.us/docs/theta-data-rest-api-v2/s1ezbyfni6rw0-index-option-tickers)
29+
### Backtesting and Research
30+
Utilize the power of QuantConnect.LEAN CLI to test and optimize your trading algorithms in both backtest and research modes.
31+
32+
## Contributing
33+
Contributions to the project are highly encouraged! Feel free to open issues, submit pull requests, or contribute in any way you see fit.
34+
35+
## Installation
36+
To contribute to the ThetaData API Connector Library for .NET 6 within QuantConnect LEAN, follow these steps:
37+
1. Obtain [ThetaData client](https://http-docs.thetadata.us/docs/theta-data-rest-api-v2/4g9ms9h4009k0-getting-started) and follow thier instaction to run client.
38+
2. Fork the Project: Fork the repository by clicking the "Fork" button at the top right of the GitHub page.
39+
3. Clone Your Forked Repository:
40+
```
41+
https://github.com/QuantConnect/Lean.DataSource.ThetaData.git
42+
```
43+
4. Configuration:
44+
- [optional] Set the thetadata-subscription-plan (by default: Free)
45+
```
46+
{
47+
"thetadata-subscription-plan": ""
48+
}
49+
```
50+
51+
## Price Plan
52+
For detailed information on ThetaData's pricing plans, please refer to the [ThetaData Pricing](https://www.thetadata.net/subscribe) page.
53+
54+
## Documentation
55+
For detailed documentation on how to use ThetaData Library, please visit [documentation](https://http-docs.thetadata.us/docs/theta-data-rest-api-v2/4g9ms9h4009k0-getting-started).
56+
57+
## License
58+
This project is licensed under the MIT License - see the [LICENSE](https://github.com/QuantConnect/Lean.DataSource.ThetaData/blob/master/LICENSE) file for details.
59+
60+
Happy coding and algorithmic trading! 📈💻

0 commit comments

Comments
 (0)