Shippy Stock Tracker Assessment
See instructions for full assessment details.
Questions
1. Process Data from Stocks API (Polygon)
- [docs](https://polygon.io/docs/stocks/getting-started)
- [python-client](https://github.com/polygon-io/client-python)
2. Parse Documents
3. (bonus) API
Guidelines
- Upload your code in a private Github repository and add @akshayshippy and @mohnish7 as collaborators
- Provide all necessary code for us to replicate your database schema, backfill data and execute your code so that we can test your submission
- Please add a README with any setup instructions for us to be able to run and test your submission
- Write your code as if it were to be deployed on a production server and run nightly (post market close)
- Do not upload your supabase or polygon API keys/tokens, we will point your code to our supabase project and use our own polygon API keys.
Setup Instructions
Installation
python -m venv venv
venv\Scripts\activate
pip install -r requirements.txt
Configure Environment
Create local .env
to hold api keys application won't work without this
POLYGON_API_KEY=**********************
Run Local API
python main.py # update data
uvicorn src.app:app --port 5000 --host "0.0.0.0" --reload
python test.py # test api
When the API is running see http://localhost:5000/docs
for swagger docs.
Example post for average ohlc data.
curl -X 'POST' \
'http://localhost:5000/average_ohlc' \
-H 'accept: application/json' \
-H 'Content-Type: application/json' \
-d '[
"AAPL", "F"
]'
Dashboard
To run a basic dashboard
streamlit run dashboard.py