<!--README.md files serve as the main landing page on this directory's github repository. It is the first thing that a viewer sees when he or she enters the github repo.

-->
# FinFlux API

`finflux` is a Python library that aggregates financial and market data from multiple publicly available RESTful JSON APIs. It currently covers equities, bonds, and U.S. economic indicators, offering a consistent and lightweight way to access and work with this data using straightforward code.

`finflux` utilizes both first-party and third-party APIs connected to the sources listed below.
- Yahoo Finance
- Twelve Data
- Securities and Exchange Commission (SEC)
- Organization for Economic Co-operation and Development (OECD)
- Board of Governors of the Federal Reserve System
- U.S. Department of the Treasury
- Bureau of Economic Analysis (BEA)
- Bureau of Labor Statistics (BLS)
- U.S. Census Bureau
- National Association of REALTORS® (NAR)
- Freddie Mac
- University of Michigan

Check out our [readthedocs](https://finflux.readthedocs.io/en/latest/index.html) for information on installation, set up, and detailed API documentation.