finstockdash's Introduction

FinStockDash

FinStockDash is a web application that allows users to analyze stock data using various financial ratios, balance sheet, income statement, and other financial metrics. User can enter a stock ticker symbol to retrieve relevant financial information, view stock prices over time, and generate visualizations to gather insights on the company performance. The application makes use of APIs provided by Financial Modeling Prep and Alpha Vantage to retrieve real-time stock data.

Note: The Financial Dashboard app uses APIs provided by Financial Modeling Prep and Alpha Vantage to retrieve real-time stock data. However, the free plan is limited to US stocks only. Therefore, the app will only work for US stocks and will not retrieve data for non-US stocks.

Requirements

To run this app locally, you will need Python 3.x installed, as well as the required libraries listed in the requirements.txt file.

Files

app.py: Main code for the Streamlit app. It imports functions from the data.py and utils.py files to retrieve and display financial data.
data.py: Functions for retrieving financial data from various APIs such as Financial Modeling Prep and Alpha Vantage.
utils.py: Utility functions that are used in the main app to create menus, cards, and other display elements.

Setup

To run the app locally, follow these steps:

Clone the repository:

$ git clone https://github.com/abeltavares/financial_dashboard_app.git

Create and activate a virtual environment:

$ python3 -m venv venv
$ source venv/bin/activate

Install the required libraries:
```
$ pip install -r requirements.txt
```
Run the app:
```
$ streamlit run app.py
```

Usage

Enter a valid stock ticker symbol in the search bar to retrieve financial data for the corresponding company.
Use the various options provided to visualize and analyze financial data.
Click on the "Download Data" button to download an Excel file with relevant financial information for the selected stock.