bankfind (0.0.1)
Installation
pip install --index-url About this package
Python interface to the FDIC's API for publically available bank data
Python interface to the FDIC's API for publically available bank data
Documentation: https://bankfind.dpguthrie.com
Source Code: https://github.com/dpguthrie/bankfind
FDIC Documentation: https://banks.data.fdic.gov/docs/
Overview
bankfind is a python interface to publically available bank data from the FDIC.
There are currently, as of 4/15/2023, five endpoints that the FDIC has exposed to the public:
- failures - returns detail on failed financial institutions
- institutions - returns a list of financial institutions
- history - returns detail on structure change events
- locations - returns locations / branches of financial institutions
- summary - returns aggregate financial and structure data, subtotaled by year, regarding financial institutions
- financial - returns financial information for financial institutions
Requirements
Python 2.7, 3.5+
- Requests - The elegant and simple HTTP library for Python, built for human beings.
- Pandas - Fast, powerful, flexible and easy to use open source data analysis and manipulation tool
Installation
pip install bankfind
Example
import bankfind as bf
# Get Institutions
data = bf.get_institutions()
# Get Institutions from Colorado with high ROE
data = bf.get_institutions(filters="STNAME:Colorado AND ROE:[25 TO *]")
# Get Commercial Banks from Colorado that aren't S-Corps
data = bf.get_institutions(filters="STNAME:Colorado AND SUBCHAPS:0 AND CB:1")
License
This project is licensed under the terms of the MIT license.
Development
Running Tests Locally
brew install python@3.8
mkvirtualenv -p /opt/homebrew/bin/python3.8 bankfind
pip install -U pip
pip install pytest coverage pytest-cov
pip install -r requirements.txt
pytest