Metadata-Version: 2.1
Name: fdicdata
Version: 0.1.3
Summary: The fdicdata package provides a set of functions for working with data from the Federal Deposit Insurance Corporation(FDIC), including retrieving financial data for FDIC-insured institutions and accessing the data taxonomy
Home-page: https://github.com/Visbanking/fdicdataPy
Author: Ugur Dar, Boray Yildiz
Author-email: ugurdarr@gmail.com, boray.yldz@gmail.com
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Financial and Insurance Industry
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Operating System :: OS Independent
Requires-Python: >=3.7
Description-Content-Type: text/markdown

## fdicdata
The fdicdata package provides a set of functions for working with data from the Federal Deposit Insurance Corporation (FDIC), including retrieving financial data for FDIC-insured institutions and accessing the data taxonomy.

## Installation 
```python
pip install fdicdata
import fdicdata as fdic
```

## Examples
```python
# Data Taxonomy:
fdic.dataTaxonomy("institution")

# Get Failures:
fdic.getFailures(['CERT'], date_range=('2010', '2015'))

# Get Financials:
fdic.getFinancials(IDRSSD_or_CERT=37, metrics=["ASSET", "DEP"], limit=10, date_range=["2015-01-01", "*"])

# Get History:
fdic.getHistory(CERT_or_NAME=3850, fields=["INSTNAME", "CERT", "PCITY", "PSTALP", "PZIP5"], CERT=True, limit=10)

# Get Institutions:
fdic.getInstitution(name="Bank of America", fields=["NAME", "CITY", "STATE"], limit=10)

# Get Institutions All:
fdic.getInstitutionsAll()

# Get Location:
fdic.getLocation(3850, fields=['NAME', 'CITY', 'ZIP'])

# Get Summary:
fdic.getSummary(states = ["California", "New York"], date_range= ["2020", "2021"], fields =  ["DEP", "ASSET"])

```
## License
This project is licensed under the terms of the MIT license.
