FFIEC Data Connect
Contents:
FFIEC Account Setup Instructions
Development Setup
FFIEC Webservice Data Connector
REST API Reference
Data Type Handling
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
FFIEC Data Connect
Index
Index
A
|
B
|
C
|
D
|
E
|
F
|
G
|
H
|
I
|
M
|
N
|
O
|
P
|
R
|
S
|
T
|
U
|
V
|
W
|
X
A
async_wait_if_needed() (RateLimiter method)
AsyncCompatibleClient (class in ffiec_data_connect)
B
BASE_URL (RESTAdapter attribute)
base_url (WebserviceConstants attribute)
bearer_token (OAuth2Credentials property)
,
[1]
C
cleanup_all() (FFIECConnection class method)
,
[1]
clear_soap_cache() (in module ffiec_data_connect)
close() (AsyncCompatibleClient method)
(FFIECConnection method)
,
[1]
collect_batch_async() (AsyncCompatibleClient method)
collect_data() (AsyncCompatibleClient method)
(in module ffiec_data_connect)
(in module ffiec_data_connect.methods)
collect_data_async() (AsyncCompatibleClient method)
collect_data_parallel() (AsyncCompatibleClient method)
collect_filers_on_reporting_period() (in module ffiec_data_connect)
(in module ffiec_data_connect.methods)
collect_filers_since_date() (in module ffiec_data_connect)
(in module ffiec_data_connect.methods)
collect_filers_submission_date_time() (in module ffiec_data_connect)
(in module ffiec_data_connect.methods)
collect_reporting_periods() (AsyncCompatibleClient method)
(in module ffiec_data_connect)
(in module ffiec_data_connect.methods)
collect_time_series() (AsyncCompatibleClient method)
collect_time_series_async() (AsyncCompatibleClient method)
collect_ubpr_facsimile_data() (in module ffiec_data_connect)
(in module ffiec_data_connect.methods)
collect_ubpr_reporting_periods() (in module ffiec_data_connect)
(in module ffiec_data_connect.methods)
ConnectionError
,
[1]
create_protocol_adapter() (in module ffiec_data_connect)
CredentialError
,
[1]
CredentialType (class in ffiec_data_connect)
(class in ffiec_data_connect.credentials)
D
DataNormalizer (class in ffiec_data_connect)
DEFAULT_RATE_LIMIT (RESTAdapter attribute)
disable_legacy_mode() (in module ffiec_data_connect)
E
enable_legacy_mode() (in module ffiec_data_connect)
F
ffiec_data_connect
module
ffiec_data_connect.constants
module
ffiec_data_connect.credentials
module
ffiec_data_connect.datahelpers
module
ffiec_data_connect.exceptions
module
ffiec_data_connect.ffiec_connection
module
ffiec_data_connect.methods
module
ffiec_data_connect.xbrl_processor
module
FFIECConnection (class in ffiec_data_connect)
(class in ffiec_data_connect.ffiec_connection)
FFIECError
,
[1]
G
get_auth_headers() (OAuth2Credentials method)
,
[1]
get_cache_stats() (in module ffiec_data_connect)
get_normalization_stats() (DataNormalizer static method)
H
HTTP (ProxyProtocol attribute)
,
[1]
HTTPS (ProxyProtocol attribute)
,
[1]
I
is_expired (OAuth2Credentials property)
,
[1]
is_rest() (RESTAdapter method)
(SOAPAdapter method)
M
module
ffiec_data_connect
ffiec_data_connect.constants
ffiec_data_connect.credentials
ffiec_data_connect.datahelpers
ffiec_data_connect.exceptions
ffiec_data_connect.ffiec_connection
ffiec_data_connect.methods
ffiec_data_connect.xbrl_processor
N
NO_CREDENTIALS (CredentialType attribute)
,
[1]
NoDataError
,
[1]
normalize_for_validation() (DataNormalizer static method)
normalize_response() (DataNormalizer static method)
O
OAuth2Credentials (class in ffiec_data_connect)
(class in ffiec_data_connect.credentials)
P
password (WebserviceCredentials property)
,
[1]
protocol_name (ProtocolAdapter property)
(RESTAdapter property)
(SOAPAdapter property)
ProtocolAdapter (class in ffiec_data_connect)
proxy_host (FFIECConnection property)
,
[1]
proxy_password (FFIECConnection property)
,
[1]
proxy_port (FFIECConnection property)
,
[1]
proxy_protocol (FFIECConnection property)
,
[1]
proxy_user_name (FFIECConnection property)
,
[1]
ProxyProtocol (class in ffiec_data_connect)
(class in ffiec_data_connect.ffiec_connection)
R
raise_exception() (in module ffiec_data_connect.exceptions)
RateLimiter (class in ffiec_data_connect)
RateLimitError
,
[1]
RESTAdapter (class in ffiec_data_connect)
retrieve_facsimile() (ProtocolAdapter method)
(RESTAdapter method)
(SOAPAdapter method)
retrieve_filers_since_date() (ProtocolAdapter method)
(RESTAdapter method)
(SOAPAdapter method)
retrieve_filers_submission_datetime() (ProtocolAdapter method)
(RESTAdapter method)
(SOAPAdapter method)
retrieve_panel_of_reporters() (ProtocolAdapter method)
(RESTAdapter method)
(SOAPAdapter method)
retrieve_reporting_periods() (ProtocolAdapter method)
(RESTAdapter method)
(SOAPAdapter method)
retrieve_ubpr_reporting_periods() (ProtocolAdapter method)
(RESTAdapter method)
(SOAPAdapter method)
retrieve_ubpr_xbrl_facsimile() (ProtocolAdapter method)
(RESTAdapter method)
(SOAPAdapter method)
S
session (FFIECConnection property)
,
[1]
SessionError
,
[1]
SET_FROM_ENV (CredentialType attribute)
,
[1]
SET_FROM_INIT (CredentialType attribute)
,
[1]
set_legacy_errors() (in module ffiec_data_connect)
SOAPAdapter (class in ffiec_data_connect)
T
test_connection() (FFIECConnection method)
,
[1]
test_credentials() (OAuth2Credentials method)
,
[1]
(WebserviceCredentials method)
,
[1]
token_expires (OAuth2Credentials property)
,
[1]
TYPE_COERCIONS (DataNormalizer attribute)
U
use_legacy_errors() (in module ffiec_data_connect)
use_proxy (FFIECConnection property)
,
[1]
username (OAuth2Credentials property)
,
[1]
(WebserviceCredentials property)
,
[1]
V
validate_pydantic_compatibility() (DataNormalizer static method)
VALIDATION_RULES (DataNormalizer attribute)
ValidationError
,
[1]
W
wait_if_needed() (RateLimiter method)
WebserviceConstants (class in ffiec_data_connect.constants)
WebserviceCredentials (class in ffiec_data_connect)
(class in ffiec_data_connect.credentials)
X
XMLParsingError
,
[1]