Skip to content

Commit 8bb7b1d

Browse files
authored
Add information about using free FMP API and US stock focus (#3)
1 parent d7db5f2 commit 8bb7b1d

1 file changed

Lines changed: 24 additions & 0 deletions

File tree

README.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
# StockDataView
2+
23
StockDataView is a Streamlit application designed to display and visualize stock data fetched from the Financial Modeling Prep (FMP) API. It provides users with bar charts, tables of stock fundamentals, and ratings for a given stock ticker.
34

45
## Features
@@ -84,11 +85,34 @@ uv sync
8485
* `builder` stage: Used for development (linting, testing)
8586
* `production` stage: Final app image for running StockDataView
8687

88+
8789
## CI/CD Workflow
8890
* GitHub Actions automates building the `production` image and pushing it to Docker Hub (`skytics/stockdataview:latest`) on `main` branch updates
8991
* The `builder` stage is used for linting and testing in CI
9092
* See `.github/workflows/ci-cd.yml` for details
9193

94+
95+
## Data Source
96+
97+
StockDataView project utilizes data from the free tier of the Financial Modeling Prep (FMP) API. Due to the limitations of the free plan, the primary focus is on **US-listed stocks**. Data for international markets and more advanced features may not be available in this version.
98+
99+
**Limitations due to Free FMP API Plan:**
100+
101+
* **Data Coverage:** Primarily focused on US stock market data.
102+
* **Historical Data:** Limited historical data availability (typically up to 5 years for most endpoints).
103+
* **Real-time Data:** Data may be end-of-day or delayed real-time.
104+
* **API Call Limits:** Functionality might be limited by the daily API call restrictions of the free plan.
105+
106+
**Potential Future Enhancements:**
107+
108+
With access to a paid FMP API plan, future versions of this dashboard could include:
109+
110+
* Support for international stock markets.
111+
* Access to more extensive historical data.
112+
* Real-time data updates.
113+
* Integration of additional financial data and features.
114+
115+
92116
## Contributing
93117
Contributions are welcome! Please feel free to submit a pull request.
94118

0 commit comments

Comments
 (0)