The project is developed by Rishik Raj using Python Flask, HTML, JavaScript, and Bootstrap. It is a web application that fetches financial data from Yahoo Finance and exposes it through a JSON API. Users can make API calls to retrieve the data and even update it using POST requests.
To install and run the project, follow these steps:
- Clone the repository to your local machine using
git clone https://github.com/rishikraj990/Stock_API.git. - Navigate to the project directory.
- Install the required dependencies using
pip install -r requirements.txt. - Run the Flask server using
python app.py. - Access the web application by navigating to
http://127.0.0.1:8000/in your web browser.
Once the web application is running, you can access the home page, API endpoints, and about page by clicking the respective links in the navigation bar. To make an API call, use the endpoint URLs listed in the API Endpoints section below.
Home Page
API Calling Page
About Page
The following API endpoints are available:
GET /stock-date/<DATE>- Retrieves the financial data from Yahoo Finance on the basis of DATE.GET /stock-date/<COMPANY CODE>/<DATE>- Retrieves the financial data from Yahoo Finance on the basis of Company code and DATE.GET /stock-date/<COMPANY CODE>- Retrieves the financial data from Yahoo Finance on the basis of Company code.POST /stock-update/<COMPANY CODE>/<DATE>- Updates the financial data on the basis of Company code and DATE.
Both endpoints return data in JSON format.
The following technologies were used in the development of this project:
- Python
- Flask
- HTML
- JavaScript
- Bootstrap
Contributions to the project are welcome. To contribute, follow these steps:
- Fork the repository.
- Create a new branch for your changes.
- Make your changes and commit them with a descriptive commit message.
- Push your changes to your forked repository.
- Submit a pull request to the original repository with a description of your changes.
This project is licensed under the MIT License. See the LICENSE file for more information.