https://github.com/westonplatter/finx-option-data
Fetch, store, and warehouse Option Data
https://github.com/westonplatter/finx-option-data
Last synced: about 2 months ago
JSON representation
Fetch, store, and warehouse Option Data
- Host: GitHub
- URL: https://github.com/westonplatter/finx-option-data
- Owner: westonplatter
- License: bsd-3-clause
- Created: 2021-05-29T20:45:39.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2023-03-26T21:44:49.000Z (about 2 years ago)
- Last Synced: 2024-04-14T20:10:42.944Z (about 1 year ago)
- Language: Python
- Size: 197 KB
- Stars: 7
- Watchers: 4
- Forks: 5
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# finx-option-data
Fetch, store, manipulate, and store option data from vendors.
**WARNING - software is in alpha status. Expect the API to change.**
## Vendors
- [x] Polygon
# Quick setup
This repo is designed in conjunction with https://github.com/westonplatter/finx-option-pricer.
Therefore, you'll need both FOD (finx-option-data) and FOP (finx-option-pricer)
```
# install option pricer
git clone [email protected]:westonplatter/finx-option-pricer.git
cd finx-option-pricer
pip install -e .
cd ..
# install this repo, finx-option-data
git clone [email protected]:westonplatter/finx-option-data.git
cd finx-option-data
cd ../finx-option-data
pip install -e .
```
## Quick start
1. Copy over sample `.env.sample` to `.env.prod`
2. Run example file, `python finx_option_data/x_fetch.py`
## ReWrite Todos
- [x] setup.py file and python folder structure for `finx_option_data`
- [ ] separate logic into sections,
- [ ] polygon API operations
- [ ] AWS CRUD operations
- [ ] finx_option_data intelligent operations
- [ ] utility ops (glue)