Skip to content

Commit 26ad9ed

Browse files
authored
Merge pull request #7 from Romazes/feature-change-readme
Update Readme
2 parents b79ecad + cdcafab commit 26ad9ed

File tree

1 file changed

+27
-2
lines changed

1 file changed

+27
-2
lines changed

README.md

Lines changed: 27 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,14 +21,39 @@ Customize the library to suit your needs with flexible configuration options.
2121

2222
### Symbol SecurityType Support
2323
#### Historical Data
24-
- [x] Option
24+
- [x] Equity
25+
- [x] Equity Option
26+
- [x] Index
27+
- [x] Index Option
2528
#### Real-time Updates
26-
- [x] Option
29+
- [x] Equity
30+
- [x] Equity Option
2731
- [x] Index - [support tickers list](https://http-docs.thetadata.us/docs/theta-data-rest-api-v2/s1ezbyfni6rw0-index-option-tickers)
2832
- [x] IndexOption - [support tickers list](https://http-docs.thetadata.us/docs/theta-data-rest-api-v2/s1ezbyfni6rw0-index-option-tickers)
2933
### Backtesting and Research
3034
Utilize the power of QuantConnect.LEAN CLI to test and optimize your trading algorithms in both backtest and research modes.
3135

36+
## Getting Started
37+
You can use the following command line arguments to launch the [LEAN CLI](https://github.com/quantConnect/Lean-cli) pip project with ThetaData. For more detailed information, refer to the [ThetaData](https://www.quantconnect.com/docs/v2/lean-cli/datasets/theta-data) documentation.
38+
39+
### Downloading Data
40+
41+
```
42+
lean data download --data-provider-historical ThetaData --data-type Trade --resolution Daily --security-type Option --ticker NVDA,AMD --start 20240303 --end 20240404 --thetadata-subscription-plan Standard
43+
```
44+
### Backtesting
45+
```
46+
lean backtest "My Project" --data-provider-historical ThetaData --thetadata-subscription-plan Standard
47+
```
48+
### Jupyter Research Notebooks
49+
```
50+
lean research "My Project" --data-provider-historical ThetaData --thetadata-subscription-plan Standard
51+
```
52+
### Live Trading
53+
```
54+
lean live deploy "My Project" --data-provider-live ThetaData --thetadata-subscription-plan Standard --brokerage "Paper Trading"
55+
```
56+
3257
## Contributing
3358
Contributions to the project are highly encouraged! Feel free to open issues, submit pull requests, or contribute in any way you see fit.
3459

0 commit comments

Comments
 (0)