MarketWatch API under FastAPI framework.
This API only has two reference data: /stock amd /stock/financial
This project is done with Flask framework, BeautifulSoup, and requests.
The /stock reference provides the basic information of the specific stock using the symbol parameter. It will return a 200 status code with data like price, high, low, open, close, volume, etc. It is essentially what you can see on MarketWatch website whenever you search a symbol.
To call a symbol in /stock, you can call the Apple symbol like this:
[url].com/stock/aapl
*Note: if symbol parameter is not provided, a 400 error will occur.
The /stock/financial reference provides all the financial data from MarketWatch website. The financial data consists of income statement, balance sheet, and cashflow.
The financial referece has three parameters: symbol, finance (optional), and interval (optional). Both finance and interval have default value.
To call a financial data, you can call for Apple's financial data like this:
[url].com/stock/financial/aapl
The finance default value is income means "income statement". This will have the API call the default income statement of the company. The other values to check other financial data will be balance for balance sheet, and cash for cashflow. Any other values given out of income, balance, and cash will result in default value of income.
To call a financial data with different financial statement, you can call for Apple's financial data like this:
[url].com/stock/financial/aapl?finance=balance
To call
The period default value is annual means the annual report. This will have the API call the default annual financial report of the company up to 5 years. There is only two values recognized by period parameter: annual and quarter. The quarter will show the quarterly report of the company. Any other values given out of annual, and quarter will result in default value of annual.
To call a financial data with different time period, you can call for Apple's financial data like this:
[url].com/stock/financial/aapl?interval=quarter
Lastly you can interchangebly call it like this without having to place parameter accrdingly as long as the values are met properly:
[url].com/stock/financial/aapl?interval=quarter&finance=cash
*Note: if symbol parameter is not provided, a 400 error will occur.
NOTE: This is a personal hobby project. The technology behind this is solely webscrape on MarketWatch and parsing data back to the API calling. I will not hold any accountability for any information displacement as MarketWatch website will change in the future. You are free to fork, or join in to this "open-source" project to continuously improve or maintain the API.