Welcome to FFIEC Webservice Python Connector’s documentation!
Repo: https://github.com/call-report/ffiec-data-connect
This package and documentation is not affiliated with the Federal Financial Institution Examination Council (FFIEC) or any other US Government Agency.
Please review the license and disclaimer before using this package.
The FFIEC Webservice Python Connector (ffiec_data_connect) was created to facilitate the use of both the SOAP-based FFIEC Webservice and the modern REST API.
Although limited documentation is provided for the Webservice by the FFIEC, practical use of the Webservice via Python requires a considerable amount of boilerplate code - and knowledge of esoteric terms and concepts inherent to bank regulatory data.
With these challenges in mind, this package provides a Python wrapper for both FFIEC APIs:
SOAP API: The legacy webservice using WebserviceCredentials (username/password)
REST API: The modern API using OAuth2Credentials (bearer tokens)
Both APIs provide access to the same data, with the REST API offering improved performance and reliability. The package automatically handles protocol differences, providing a unified interface for data collection.
Data returned from the APIs may be returned as:
Native Python data structures (list)
Pandas DataFrames or Series
Polars DataFrames (with direct XBRL conversion for maximum precision)
Getting Started with Interactive Tutorials
📓 Jupyter Notebook Demos
The best way to learn the library is through our comprehensive Jupyter notebook tutorials:
``ffiec_data_connect_rest_demo.ipynb`` - Complete REST API walkthrough with executable examples
``ffiec_data_connect_soap_demo.ipynb`` - Legacy SOAP API implementation and migration guidance
These notebooks include:
Step-by-step setup instructions with real credentials
Executable code examples using actual banking data
Troubleshooting guides for common issues
Performance optimization techniques
Migration strategies from SOAP to REST
The notebooks are included with the package installation and provide hands-on experience with both APIs.
Contents:
- FFIEC Account Setup Instructions
- Development Setup
- Prerequisites
- Clone the Repository
- Set Up Virtual Environment
- Install Dependencies
- Verify Installation
- Running Code in Development Mode
- Running Tests
- Code Quality Tools
- Building Documentation
- Making Changes
- Common Development Tasks
- Project Structure
- Environment Variables
- Troubleshooting Development Setup
- Contributing
- See Also
- FFIEC Webservice Data Connector
- REST API Reference
- Data Type Handling
- Overview
- Type Detection in XBRL Processing
- SOAP vs REST Null Handling
- Output Format Type Mapping
- Integer Display Examples
- Type Conversion Decision Tree
- Date Format Handling
- Common Patterns and Best Practices
- Migration Guide
- Overriding Null Value Handling
- Troubleshooting
- Performance Considerations
- API Reference
- Version History
- See Also
- Examples & Interactive Tutorials
- Code Examples
- Collecting the reporting periods
- Collect the list of filers for a particular reporting period
- Collect the rssd IDs and submission datetimes of all filers who have filed for a particular reporting period, since a particular date.
- Collect the list of rssd(s) that have filed in a reporting period since a particular date.
- REST API Examples
- Collect the time series data associated with a particular rssd and reporting period.
- Troubleshooting
- Version History
- Version 2.0.0 - Major Release
- Disclaimers and License