Instructions:
- Replace the default values in
settings.py
as desired - You can get the free API Key from https://polygon.io/.
Running locally:
- To run type
POLYGON_API_KEY="<api_key>" python3 main.py
Running on Github CI:
- Fork this repo
- Go to
Settings
->Secrets and Variables
->Actions
- Added a Repository Secret called
POLYGON_API_KEY
and should be your Polygon API Key - Now whenever you make a Pull request wait for the CI to finish (the longest time will be in the Polygon call with free licenses. It is limited to 5 calls a minute)
- Once your CI is done go to
Actions
-> Click on the latest run -> You will see the artifacts calledrun-results
. Download it
TODO:
- Implement long and short options correctly. Currently they are implemented same as stocks
- Investigate other API's that provide realtime data and are stable (For example: YFinance is good but it delists options that have expired)