Go to file
Austin Godber 74e2444bd4
All checks were successful
Test bankfind / Python ${{ matrix.python-version }} sample (3.8) (push) Successful in 39s
fix test
2024-07-23 07:49:28 -07:00
.gitea/workflows split tests out 2024-07-23 07:44:28 -07:00
bankfind add financials 2024-07-21 19:25:34 -07:00
docs Add CNAME 2020-08-21 23:01:26 -06:00
tests fix test 2024-07-23 07:49:28 -07:00
.gitattributes Initial commit for 0.0.1 2020-08-21 22:29:52 -06:00
.gitignore Don't include site directory from docs 2020-08-21 23:01:20 -06:00
.travis.yml Update python versions 2020-08-21 22:59:26 -06:00
CHANGELOG.md Initial commit for 0.0.1 2020-08-21 22:29:52 -06:00
LICENSE Initial commit for 0.0.1 2020-08-21 22:29:52 -06:00
pyproject.toml Fix invalid requirement specification 2020-08-21 22:54:05 -06:00
pytest.ini Initial commit for 0.0.1 2020-08-21 22:29:52 -06:00
README.md add tests 2024-07-23 07:41:20 -07:00
requirements.txt Fix invalid requirement specification 2020-08-21 22:54:05 -06:00

Python interface to the FDIC's API for publically available bank data

Build Status Coverage Package version


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