No project description provided
Project description
stocklake
Table of Contents
Installation
pip install stocklake
Quick start
pre requesties:
- docker && docker compose
1. setup docker compose
Let's create docker compose file.
touch docker-compose.yml
Copy this docker compose file contents into the your docker compose file.
Then, run docker containers.
docker compose up -d
This command builds the following 3 containers.
- PostgreSQL for stocklake data.
- Metabase Web UI
- PostgreSQL for metabase.
2. Download NASDAQ API data.
Run the following command to download data from nasdaq API and save into PostgreSQL.
stocklake download nasdaqapi --exchange nasdaq --store_type postgresql
3. Setup metabase
Accessing the metabase web ui (Metabase Web UI) and setup connection of stocklake PostgreSQL database with the following settings.
section | value |
---|---|
Database Type | PostgreSQL |
Host | stocklake-db |
Port | 5432 |
Database name | stocklake |
Username | postgres |
Password | password |
Other settings can be theier default values.
Now you can see the Nasdaq API data on your metabase dashborad!
Supported APIs
name | status | API Docs | Additional Information |
---|---|---|---|
Nasdaq API (Screener) | :white_check_mark: | URL | |
Polygon API (Stock Financials Vx) | :white_check_mark: | URL | Data Fields Information |
Polygon API (Tickers) | :construction: | URL |
Examples
Nasdaq API (Screener)
stocklake download nasdaqapi --exchange nasdaq --store_type postgresql
Polygon API (Stock Financials Vx)
stocklake download polygonapi --symbols AAPL --api_type stock_financials_vx --store_type postgresql
License
stocklake
is distributed under the terms of the MIT license.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
stocklake-0.0.12.tar.gz
(21.3 kB
view hashes)
Built Distribution
Close
Hashes for stocklake-0.0.12-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | ca7cd8150c1a67e1d59d29a2efa6d9dd05d92d770b08ca500096ba08a497ad57 |
|
MD5 | 10d8530d7c2288bae3fd8af9eaa4f296 |
|
BLAKE2b-256 | 31c9be86a7e27ca9b3884aed672ad06d38715cc2d2071c26ec78eb8f2e84917f |