1 line
38 KiB
JSON
1 line
38 KiB
JSON
|
{"config":{"lang":["en"],"min_search_length":3,"prebuild_index":false,"separator":"[\\s\\-]+"},"docs":[{"location":"","text":"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 \u00b6 bankfind is a python interface to publically available bank data from the FDIC. There are currently, as of 8/11/20, 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 Requirements \u00b6 Python 2.7, 3.5+ Requests - The elegant and simple HTTP library for Python, built for human beings. Installation \u00b6 pip install bankfind Successfully installed bankfind restart \u21bb Example \u00b6 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 \u00b6 This project is licensed under the terms of the MIT license.","title":"Home"},{"location":"#overview","text":"bankfind is a python interface to publically available bank data from the FDIC. There are currently, as of 8/11/20, 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","title":"Overview"},{"location":"#requirements","text":"Python 2.7, 3.5+ Requests - The elegant and simple HTTP library for Python, built for human beings.","title":"Requirements"},{"location":"#installation","text":"pip install bankfind Successfully installed bankfind restart \u21bb","title":"Installation"},{"location":"#example","text":"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\" )","title":"Example"},{"location":"#license","text":"This project is licensed under the terms of the MIT license.","title":"License"},{"location":"filtering/","text":"The API uses the Elastic Search query string syntax for filtering. Overview \u00b6 First, get an idea of what fields you can use to filter from the meta_dict . >>> import bankfind as bf >>> fields = bf . meta_dict . keys () dict_keys ([ 'failures' , 'history' , 'institutions' , 'locations' , 'summary' ]) Each of the keys above represent an endpoint. The values corresponding to each of the keys above are dictionaries. The dictionaries contain the fields available as well as the data type, description, and, sometimes, options to filter with. >>> bf . meta_dict [ 'failures' ] . keys () dict_keys ([ 'NAME' , 'CERT' , 'FIN' , 'CITYST' , 'FAILDATE' , 'FAILYR' , 'SAVR' , 'RESTYPE1' , 'CHCLASS1' , 'RESTYPE' , 'QBFDEP' , 'QBFASSET' , 'COST' , 'PSTALP' ]) >>> bf . meta_dict [ 'failures' ][ 'NAME' ] { 'type' : 'string' , 'x-elastic-type' : 'keyword' , 'title' : 'Institution Name' , 'description' : \"This is the legal name of the institution. When available, the Institution's name links to useful information for the customers and vendors of these institutions. This information includes press releases, information about the acquiring institution
|