fds.sdk.FactSetBanks 0.1.0__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- fds/__init__.py +0 -0
- fds/sdk/FactSetBanks/__init__.py +28 -0
- fds/sdk/FactSetBanks/api/__init__.py +3 -0
- fds/sdk/FactSetBanks/api/branches_api.py +309 -0
- fds/sdk/FactSetBanks/api/deposit_rates_api.py +309 -0
- fds/sdk/FactSetBanks/api/exposure_api.py +309 -0
- fds/sdk/FactSetBanks/api/filings_api.py +559 -0
- fds/sdk/FactSetBanks/api/financials_api.py +309 -0
- fds/sdk/FactSetBanks/api/metrics_api.py +345 -0
- fds/sdk/FactSetBanks/api/specialty_finance_api.py +559 -0
- fds/sdk/FactSetBanks/api/ubpr_performance_api.py +309 -0
- fds/sdk/FactSetBanks/api_client.py +939 -0
- fds/sdk/FactSetBanks/apis/__init__.py +24 -0
- fds/sdk/FactSetBanks/configuration.py +496 -0
- fds/sdk/FactSetBanks/exceptions.py +160 -0
- fds/sdk/FactSetBanks/model/__init__.py +5 -0
- fds/sdk/FactSetBanks/model/aum_report_type.py +276 -0
- fds/sdk/FactSetBanks/model/aum_request.py +274 -0
- fds/sdk/FactSetBanks/model/aum_request_data.py +291 -0
- fds/sdk/FactSetBanks/model/aum_response.py +268 -0
- fds/sdk/FactSetBanks/model/australia_branch.py +324 -0
- fds/sdk/FactSetBanks/model/australia_coverage.py +276 -0
- fds/sdk/FactSetBanks/model/australia_financial.py +306 -0
- fds/sdk/FactSetBanks/model/branch.py +467 -0
- fds/sdk/FactSetBanks/model/branches_request.py +274 -0
- fds/sdk/FactSetBanks/model/branches_request_data.py +396 -0
- fds/sdk/FactSetBanks/model/branches_response.py +268 -0
- fds/sdk/FactSetBanks/model/canada_coverage.py +276 -0
- fds/sdk/FactSetBanks/model/canada_financial.py +306 -0
- fds/sdk/FactSetBanks/model/credit_union_branch.py +348 -0
- fds/sdk/FactSetBanks/model/credit_union_coverage.py +276 -0
- fds/sdk/FactSetBanks/model/credit_union_financial.py +310 -0
- fds/sdk/FactSetBanks/model/currency_code.py +283 -0
- fds/sdk/FactSetBanks/model/entity_identification.py +260 -0
- fds/sdk/FactSetBanks/model/error_object.py +288 -0
- fds/sdk/FactSetBanks/model/error_object_source.py +264 -0
- fds/sdk/FactSetBanks/model/error_response.py +268 -0
- fds/sdk/FactSetBanks/model/exposure.py +350 -0
- fds/sdk/FactSetBanks/model/exposure_all_of.py +276 -0
- fds/sdk/FactSetBanks/model/exposure_request.py +274 -0
- fds/sdk/FactSetBanks/model/exposure_request_data.py +299 -0
- fds/sdk/FactSetBanks/model/exposure_response.py +268 -0
- fds/sdk/FactSetBanks/model/filing10_d.py +362 -0
- fds/sdk/FactSetBanks/model/filing10_d_all_of.py +284 -0
- fds/sdk/FactSetBanks/model/filing_ucc1.py +343 -0
- fds/sdk/FactSetBanks/model/filing_ucc1_all_of.py +276 -0
- fds/sdk/FactSetBanks/model/filings10_d_response.py +268 -0
- fds/sdk/FactSetBanks/model/filings_ucc1_response.py +268 -0
- fds/sdk/FactSetBanks/model/financial.py +389 -0
- fds/sdk/FactSetBanks/model/financials_request.py +274 -0
- fds/sdk/FactSetBanks/model/financials_request_data.py +316 -0
- fds/sdk/FactSetBanks/model/financials_response.py +268 -0
- fds/sdk/FactSetBanks/model/focus_report_type.py +276 -0
- fds/sdk/FactSetBanks/model/focus_request.py +274 -0
- fds/sdk/FactSetBanks/model/focus_request_data.py +291 -0
- fds/sdk/FactSetBanks/model/focus_response.py +268 -0
- fds/sdk/FactSetBanks/model/global_branch.py +308 -0
- fds/sdk/FactSetBanks/model/global_coverage.py +276 -0
- fds/sdk/FactSetBanks/model/ids.py +282 -0
- fds/sdk/FactSetBanks/model/meta.py +276 -0
- fds/sdk/FactSetBanks/model/metric.py +309 -0
- fds/sdk/FactSetBanks/model/metric_value_base.py +264 -0
- fds/sdk/FactSetBanks/model/metrics_response.py +268 -0
- fds/sdk/FactSetBanks/model/pagination.py +268 -0
- fds/sdk/FactSetBanks/model/pagination_request.py +267 -0
- fds/sdk/FactSetBanks/model/performance.py +354 -0
- fds/sdk/FactSetBanks/model/performance_all_of.py +280 -0
- fds/sdk/FactSetBanks/model/performance_request.py +274 -0
- fds/sdk/FactSetBanks/model/performance_request_data.py +301 -0
- fds/sdk/FactSetBanks/model/performance_response.py +268 -0
- fds/sdk/FactSetBanks/model/rate.py +385 -0
- fds/sdk/FactSetBanks/model/rate_all_of.py +322 -0
- fds/sdk/FactSetBanks/model/rates_request.py +274 -0
- fds/sdk/FactSetBanks/model/rates_request_data.py +296 -0
- fds/sdk/FactSetBanks/model/rates_response.py +268 -0
- fds/sdk/FactSetBanks/model/request_meta.py +262 -0
- fds/sdk/FactSetBanks/model/specialty_finance_aum.py +308 -0
- fds/sdk/FactSetBanks/model/specialty_finance_focus.py +304 -0
- fds/sdk/FactSetBanks/model/ten_d_filings_request.py +274 -0
- fds/sdk/FactSetBanks/model/ten_d_filings_request_data.py +291 -0
- fds/sdk/FactSetBanks/model/ucc1_filings_request.py +274 -0
- fds/sdk/FactSetBanks/model/ucc1_filings_request_data.py +284 -0
- fds/sdk/FactSetBanks/model/us_branch.py +317 -0
- fds/sdk/FactSetBanks/model/us_coverage.py +276 -0
- fds/sdk/FactSetBanks/model/us_financial.py +306 -0
- fds/sdk/FactSetBanks/model/us_state_code.py +339 -0
- fds/sdk/FactSetBanks/model_utils.py +2062 -0
- fds/sdk/FactSetBanks/models/__init__.py +81 -0
- fds/sdk/FactSetBanks/rest.py +347 -0
- fds/sdk/__init__.py +0 -0
- fds_sdk_factsetbanks-0.1.0.dist-info/METADATA +423 -0
- fds_sdk_factsetbanks-0.1.0.dist-info/RECORD +95 -0
- fds_sdk_factsetbanks-0.1.0.dist-info/WHEEL +5 -0
- fds_sdk_factsetbanks-0.1.0.dist-info/licenses/LICENSE +202 -0
- fds_sdk_factsetbanks-0.1.0.dist-info/top_level.txt +1 -0
fds/__init__.py
ADDED
|
File without changes
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
# flake8: noqa
|
|
2
|
+
|
|
3
|
+
"""
|
|
4
|
+
FactSet Banks API
|
|
5
|
+
|
|
6
|
+
The FactSet Banks API provides comprehensive banking industry data including regulatory financials, performance metrics, branch networks, and specialized reporting across US, Canadian, and Australian institutions. **Key Features:** - Multi-jurisdiction regulatory financials (US, Canada, Australia) - Unified endpoint structure for banks, credit unions, and specialty finance - UBPR performance metrics and peer group analysis - Branch and ATM location data with market share - Country exposure and risk metrics - Regulatory filings (10-D, UCC-1) - Deposit rates and specialty finance reporting # noqa: E501
|
|
7
|
+
|
|
8
|
+
The version of the OpenAPI document: 1.0.0
|
|
9
|
+
Contact: api@factset.com
|
|
10
|
+
Generated by: https://openapi-generator.tech
|
|
11
|
+
"""
|
|
12
|
+
|
|
13
|
+
|
|
14
|
+
__version__ = "0.1.0"
|
|
15
|
+
|
|
16
|
+
# import ApiClient
|
|
17
|
+
from fds.sdk.FactSetBanks.api_client import ApiClient
|
|
18
|
+
|
|
19
|
+
# import Configuration
|
|
20
|
+
from fds.sdk.FactSetBanks.configuration import Configuration
|
|
21
|
+
|
|
22
|
+
# import exceptions
|
|
23
|
+
from fds.sdk.FactSetBanks.exceptions import OpenApiException
|
|
24
|
+
from fds.sdk.FactSetBanks.exceptions import ApiAttributeError
|
|
25
|
+
from fds.sdk.FactSetBanks.exceptions import ApiTypeError
|
|
26
|
+
from fds.sdk.FactSetBanks.exceptions import ApiValueError
|
|
27
|
+
from fds.sdk.FactSetBanks.exceptions import ApiKeyError
|
|
28
|
+
from fds.sdk.FactSetBanks.exceptions import ApiException
|
|
@@ -0,0 +1,309 @@
|
|
|
1
|
+
"""
|
|
2
|
+
FactSet Banks API
|
|
3
|
+
|
|
4
|
+
The FactSet Banks API provides comprehensive banking industry data including regulatory financials, performance metrics, branch networks, and specialized reporting across US, Canadian, and Australian institutions. **Key Features:** - Multi-jurisdiction regulatory financials (US, Canada, Australia) - Unified endpoint structure for banks, credit unions, and specialty finance - UBPR performance metrics and peer group analysis - Branch and ATM location data with market share - Country exposure and risk metrics - Regulatory filings (10-D, UCC-1) - Deposit rates and specialty finance reporting # noqa: E501
|
|
5
|
+
|
|
6
|
+
The version of the OpenAPI document: 1.0.0
|
|
7
|
+
Contact: api@factset.com
|
|
8
|
+
Generated by: https://openapi-generator.tech
|
|
9
|
+
"""
|
|
10
|
+
|
|
11
|
+
|
|
12
|
+
import re # noqa: F401
|
|
13
|
+
import sys # noqa: F401
|
|
14
|
+
from multiprocessing.pool import ApplyResult
|
|
15
|
+
import typing
|
|
16
|
+
|
|
17
|
+
from fds.sdk.FactSetBanks.api_client import ApiClient, Endpoint as _Endpoint
|
|
18
|
+
from fds.sdk.FactSetBanks.model_utils import ( # noqa: F401
|
|
19
|
+
check_allowed_values,
|
|
20
|
+
check_validations,
|
|
21
|
+
date,
|
|
22
|
+
datetime,
|
|
23
|
+
file_type,
|
|
24
|
+
none_type,
|
|
25
|
+
validate_and_convert_types
|
|
26
|
+
)
|
|
27
|
+
from fds.sdk.FactSetBanks.exceptions import ApiException
|
|
28
|
+
from fds.sdk.FactSetBanks.model.branches_request import BranchesRequest
|
|
29
|
+
from fds.sdk.FactSetBanks.model.branches_response import BranchesResponse
|
|
30
|
+
from fds.sdk.FactSetBanks.model.error_response import ErrorResponse
|
|
31
|
+
|
|
32
|
+
|
|
33
|
+
|
|
34
|
+
|
|
35
|
+
|
|
36
|
+
class BranchesApi(object):
|
|
37
|
+
"""NOTE: This class is auto generated by OpenAPI Generator
|
|
38
|
+
Ref: https://openapi-generator.tech
|
|
39
|
+
|
|
40
|
+
Do not edit the class manually.
|
|
41
|
+
"""
|
|
42
|
+
|
|
43
|
+
def __init__(self, api_client=None):
|
|
44
|
+
if api_client is None:
|
|
45
|
+
api_client = ApiClient()
|
|
46
|
+
self.api_client = api_client
|
|
47
|
+
|
|
48
|
+
self.get_branches_endpoint = _Endpoint(
|
|
49
|
+
settings={
|
|
50
|
+
'response_type': (
|
|
51
|
+
{ 200: (BranchesResponse,), 400: (ErrorResponse,), 401: (ErrorResponse,), 403: (ErrorResponse,), 404: (ErrorResponse,), 415: (ErrorResponse,), 422: (ErrorResponse,), 500: (ErrorResponse,), },
|
|
52
|
+
None
|
|
53
|
+
),
|
|
54
|
+
'auth': [
|
|
55
|
+
'FactSetApiKey',
|
|
56
|
+
'FactSetOAuth2'
|
|
57
|
+
],
|
|
58
|
+
'endpoint_path': '/branches',
|
|
59
|
+
'operation_id': 'get_branches',
|
|
60
|
+
'http_method': 'POST',
|
|
61
|
+
'servers': None,
|
|
62
|
+
},
|
|
63
|
+
params_map={
|
|
64
|
+
'all': [
|
|
65
|
+
'branches_request',
|
|
66
|
+
],
|
|
67
|
+
'required': [
|
|
68
|
+
'branches_request',
|
|
69
|
+
],
|
|
70
|
+
'nullable': [
|
|
71
|
+
],
|
|
72
|
+
'enum': [
|
|
73
|
+
],
|
|
74
|
+
'validation': [
|
|
75
|
+
]
|
|
76
|
+
},
|
|
77
|
+
root_map={
|
|
78
|
+
'validations': {
|
|
79
|
+
},
|
|
80
|
+
'allowed_values': {
|
|
81
|
+
},
|
|
82
|
+
'openapi_types': {
|
|
83
|
+
'branches_request':
|
|
84
|
+
(BranchesRequest,),
|
|
85
|
+
},
|
|
86
|
+
'attribute_map': {
|
|
87
|
+
},
|
|
88
|
+
'location_map': {
|
|
89
|
+
'branches_request': 'body',
|
|
90
|
+
},
|
|
91
|
+
'collection_format_map': {
|
|
92
|
+
}
|
|
93
|
+
},
|
|
94
|
+
headers_map={
|
|
95
|
+
'accept': [
|
|
96
|
+
'application/json'
|
|
97
|
+
],
|
|
98
|
+
'content_type': [
|
|
99
|
+
'application/json'
|
|
100
|
+
]
|
|
101
|
+
},
|
|
102
|
+
api_client=api_client
|
|
103
|
+
)
|
|
104
|
+
|
|
105
|
+
|
|
106
|
+
@staticmethod
|
|
107
|
+
def apply_kwargs_defaults(kwargs, return_http_data_only, async_req):
|
|
108
|
+
kwargs["async_req"] = async_req
|
|
109
|
+
kwargs["_return_http_data_only"] = return_http_data_only
|
|
110
|
+
kwargs["_preload_content"] = kwargs.get("_preload_content", True)
|
|
111
|
+
kwargs["_request_timeout"] = kwargs.get("_request_timeout", None)
|
|
112
|
+
kwargs["_check_input_type"] = kwargs.get("_check_input_type", True)
|
|
113
|
+
kwargs["_check_return_type"] = kwargs.get("_check_return_type", True)
|
|
114
|
+
kwargs["_spec_property_naming"] = kwargs.get("_spec_property_naming", False)
|
|
115
|
+
kwargs["_content_type"] = kwargs.get("_content_type")
|
|
116
|
+
kwargs["_host_index"] = kwargs.get("_host_index")
|
|
117
|
+
|
|
118
|
+
|
|
119
|
+
def get_branches(
|
|
120
|
+
self,
|
|
121
|
+
branches_request,
|
|
122
|
+
**kwargs
|
|
123
|
+
) -> BranchesResponse:
|
|
124
|
+
"""Returns bank branch and location data # noqa: E501
|
|
125
|
+
|
|
126
|
+
Returns branch and location data for banks and financial institutions. Use the `coverage` field to specify the data source: * **US** — FDIC-insured bank branches with branch counts and deposit market share by county, ZIP, and MSA. 85,000+ current branches across 9,000+ banks and BHCs. Sourced from the FDIC Summary of Deposits (annual) and Institutions and Locations (weekly). Current-only feed; deposit balances as of the most recent June 30. * **CREDIT_UNION** — US credit union branches and ATMs with service flags. 5,800+ credit unions, 21,000+ branches, and 17,000+ ATM addresses; reported quarterly since September 2022. * **AUSTRALIA** — Service channel locations with remoteness classifications. 149+ banks; 30,000+ branches, 47,000+ ATMs, 6,600+ other face-to-face, and 4.9M+ EFTPOS channels. Annual data as of June 30. * **GLOBAL** — Global bank branches and ATMs ex-US with country, region, city, lat/long, postal, and street details where available. 300,000+ banks, 800,000+ locations, 180+ countries. Current-only feed. # noqa: E501
|
|
127
|
+
This method makes a synchronous HTTP request. Returns the http data only
|
|
128
|
+
|
|
129
|
+
Args:
|
|
130
|
+
branches_request (BranchesRequest):
|
|
131
|
+
|
|
132
|
+
Keyword Args:
|
|
133
|
+
_preload_content (bool): if False, the urllib3.HTTPResponse object
|
|
134
|
+
will be returned without reading/decoding response data.
|
|
135
|
+
Default is True. NOTE: if this API returns a file, it is the responsibility
|
|
136
|
+
of the caller to close the file stream.
|
|
137
|
+
_request_timeout (int/float/tuple): timeout setting for this request. If
|
|
138
|
+
one number provided, it will be total request timeout. It can also
|
|
139
|
+
be a pair (tuple) of (connection, read) timeouts.
|
|
140
|
+
Default is None.
|
|
141
|
+
_check_input_type (bool): specifies if type checking
|
|
142
|
+
should be done one the data sent to the server.
|
|
143
|
+
Default is True.
|
|
144
|
+
_check_return_type (bool): specifies if type checking
|
|
145
|
+
should be done one the data received from the server.
|
|
146
|
+
Default is True.
|
|
147
|
+
_spec_property_naming (bool): True if the variable names in the input data
|
|
148
|
+
are serialized names, as specified in the OpenAPI document.
|
|
149
|
+
False if the variable names in the input data
|
|
150
|
+
are pythonic names, e.g. snake case (default)
|
|
151
|
+
_content_type (str/None): force body content-type.
|
|
152
|
+
Default is None and content-type will be predicted by allowed
|
|
153
|
+
content-types and body.
|
|
154
|
+
_host_index (int/None): specifies the index of the server
|
|
155
|
+
that we want to use.
|
|
156
|
+
Default is read from the configuration.
|
|
157
|
+
Returns:
|
|
158
|
+
BranchesResponse
|
|
159
|
+
Response Object
|
|
160
|
+
"""
|
|
161
|
+
self.apply_kwargs_defaults(kwargs=kwargs, return_http_data_only=True, async_req=False)
|
|
162
|
+
kwargs['branches_request'] = \
|
|
163
|
+
branches_request
|
|
164
|
+
return self.get_branches_endpoint.call_with_http_info(**kwargs)
|
|
165
|
+
|
|
166
|
+
def get_branches_with_http_info(
|
|
167
|
+
self,
|
|
168
|
+
branches_request,
|
|
169
|
+
**kwargs
|
|
170
|
+
) -> typing.Tuple[BranchesResponse, int, typing.MutableMapping]:
|
|
171
|
+
"""Returns bank branch and location data # noqa: E501
|
|
172
|
+
|
|
173
|
+
Returns branch and location data for banks and financial institutions. Use the `coverage` field to specify the data source: * **US** — FDIC-insured bank branches with branch counts and deposit market share by county, ZIP, and MSA. 85,000+ current branches across 9,000+ banks and BHCs. Sourced from the FDIC Summary of Deposits (annual) and Institutions and Locations (weekly). Current-only feed; deposit balances as of the most recent June 30. * **CREDIT_UNION** — US credit union branches and ATMs with service flags. 5,800+ credit unions, 21,000+ branches, and 17,000+ ATM addresses; reported quarterly since September 2022. * **AUSTRALIA** — Service channel locations with remoteness classifications. 149+ banks; 30,000+ branches, 47,000+ ATMs, 6,600+ other face-to-face, and 4.9M+ EFTPOS channels. Annual data as of June 30. * **GLOBAL** — Global bank branches and ATMs ex-US with country, region, city, lat/long, postal, and street details where available. 300,000+ banks, 800,000+ locations, 180+ countries. Current-only feed. # noqa: E501
|
|
174
|
+
This method makes a synchronous HTTP request. Returns http data, http status and headers
|
|
175
|
+
|
|
176
|
+
Args:
|
|
177
|
+
branches_request (BranchesRequest):
|
|
178
|
+
|
|
179
|
+
Keyword Args:
|
|
180
|
+
_preload_content (bool): if False, the urllib3.HTTPResponse object
|
|
181
|
+
will be returned without reading/decoding response data.
|
|
182
|
+
Default is True. NOTE: if this API returns a file, it is the responsibility
|
|
183
|
+
of the caller to close the file stream.
|
|
184
|
+
_request_timeout (int/float/tuple): timeout setting for this request. If
|
|
185
|
+
one number provided, it will be total request timeout. It can also
|
|
186
|
+
be a pair (tuple) of (connection, read) timeouts.
|
|
187
|
+
Default is None.
|
|
188
|
+
_check_input_type (bool): specifies if type checking
|
|
189
|
+
should be done one the data sent to the server.
|
|
190
|
+
Default is True.
|
|
191
|
+
_check_return_type (bool): specifies if type checking
|
|
192
|
+
should be done one the data received from the server.
|
|
193
|
+
Default is True.
|
|
194
|
+
_spec_property_naming (bool): True if the variable names in the input data
|
|
195
|
+
are serialized names, as specified in the OpenAPI document.
|
|
196
|
+
False if the variable names in the input data
|
|
197
|
+
are pythonic names, e.g. snake case (default)
|
|
198
|
+
_content_type (str/None): force body content-type.
|
|
199
|
+
Default is None and content-type will be predicted by allowed
|
|
200
|
+
content-types and body.
|
|
201
|
+
_host_index (int/None): specifies the index of the server
|
|
202
|
+
that we want to use.
|
|
203
|
+
Default is read from the configuration.
|
|
204
|
+
Returns:
|
|
205
|
+
BranchesResponse
|
|
206
|
+
Response Object
|
|
207
|
+
int
|
|
208
|
+
Http Status Code
|
|
209
|
+
dict
|
|
210
|
+
Dictionary of the response headers
|
|
211
|
+
"""
|
|
212
|
+
self.apply_kwargs_defaults(kwargs=kwargs, return_http_data_only=False, async_req=False)
|
|
213
|
+
kwargs['branches_request'] = \
|
|
214
|
+
branches_request
|
|
215
|
+
return self.get_branches_endpoint.call_with_http_info(**kwargs)
|
|
216
|
+
|
|
217
|
+
def get_branches_async(
|
|
218
|
+
self,
|
|
219
|
+
branches_request,
|
|
220
|
+
**kwargs
|
|
221
|
+
) -> "ApplyResult[BranchesResponse]":
|
|
222
|
+
"""Returns bank branch and location data # noqa: E501
|
|
223
|
+
|
|
224
|
+
Returns branch and location data for banks and financial institutions. Use the `coverage` field to specify the data source: * **US** — FDIC-insured bank branches with branch counts and deposit market share by county, ZIP, and MSA. 85,000+ current branches across 9,000+ banks and BHCs. Sourced from the FDIC Summary of Deposits (annual) and Institutions and Locations (weekly). Current-only feed; deposit balances as of the most recent June 30. * **CREDIT_UNION** — US credit union branches and ATMs with service flags. 5,800+ credit unions, 21,000+ branches, and 17,000+ ATM addresses; reported quarterly since September 2022. * **AUSTRALIA** — Service channel locations with remoteness classifications. 149+ banks; 30,000+ branches, 47,000+ ATMs, 6,600+ other face-to-face, and 4.9M+ EFTPOS channels. Annual data as of June 30. * **GLOBAL** — Global bank branches and ATMs ex-US with country, region, city, lat/long, postal, and street details where available. 300,000+ banks, 800,000+ locations, 180+ countries. Current-only feed. # noqa: E501
|
|
225
|
+
This method makes a asynchronous HTTP request. Returns the http data, wrapped in ApplyResult
|
|
226
|
+
|
|
227
|
+
Args:
|
|
228
|
+
branches_request (BranchesRequest):
|
|
229
|
+
|
|
230
|
+
Keyword Args:
|
|
231
|
+
_preload_content (bool): if False, the urllib3.HTTPResponse object
|
|
232
|
+
will be returned without reading/decoding response data.
|
|
233
|
+
Default is True. NOTE: if this API returns a file, it is the responsibility
|
|
234
|
+
of the caller to close the file stream.
|
|
235
|
+
_request_timeout (int/float/tuple): timeout setting for this request. If
|
|
236
|
+
one number provided, it will be total request timeout. It can also
|
|
237
|
+
be a pair (tuple) of (connection, read) timeouts.
|
|
238
|
+
Default is None.
|
|
239
|
+
_check_input_type (bool): specifies if type checking
|
|
240
|
+
should be done one the data sent to the server.
|
|
241
|
+
Default is True.
|
|
242
|
+
_check_return_type (bool): specifies if type checking
|
|
243
|
+
should be done one the data received from the server.
|
|
244
|
+
Default is True.
|
|
245
|
+
_spec_property_naming (bool): True if the variable names in the input data
|
|
246
|
+
are serialized names, as specified in the OpenAPI document.
|
|
247
|
+
False if the variable names in the input data
|
|
248
|
+
are pythonic names, e.g. snake case (default)
|
|
249
|
+
_content_type (str/None): force body content-type.
|
|
250
|
+
Default is None and content-type will be predicted by allowed
|
|
251
|
+
content-types and body.
|
|
252
|
+
_host_index (int/None): specifies the index of the server
|
|
253
|
+
that we want to use.
|
|
254
|
+
Default is read from the configuration.
|
|
255
|
+
Returns:
|
|
256
|
+
ApplyResult[BranchesResponse]
|
|
257
|
+
"""
|
|
258
|
+
self.apply_kwargs_defaults(kwargs=kwargs, return_http_data_only=True, async_req=True)
|
|
259
|
+
kwargs['branches_request'] = \
|
|
260
|
+
branches_request
|
|
261
|
+
return self.get_branches_endpoint.call_with_http_info(**kwargs)
|
|
262
|
+
|
|
263
|
+
def get_branches_with_http_info_async(
|
|
264
|
+
self,
|
|
265
|
+
branches_request,
|
|
266
|
+
**kwargs
|
|
267
|
+
) -> "ApplyResult[typing.Tuple[BranchesResponse, int, typing.MutableMapping]]":
|
|
268
|
+
"""Returns bank branch and location data # noqa: E501
|
|
269
|
+
|
|
270
|
+
Returns branch and location data for banks and financial institutions. Use the `coverage` field to specify the data source: * **US** — FDIC-insured bank branches with branch counts and deposit market share by county, ZIP, and MSA. 85,000+ current branches across 9,000+ banks and BHCs. Sourced from the FDIC Summary of Deposits (annual) and Institutions and Locations (weekly). Current-only feed; deposit balances as of the most recent June 30. * **CREDIT_UNION** — US credit union branches and ATMs with service flags. 5,800+ credit unions, 21,000+ branches, and 17,000+ ATM addresses; reported quarterly since September 2022. * **AUSTRALIA** — Service channel locations with remoteness classifications. 149+ banks; 30,000+ branches, 47,000+ ATMs, 6,600+ other face-to-face, and 4.9M+ EFTPOS channels. Annual data as of June 30. * **GLOBAL** — Global bank branches and ATMs ex-US with country, region, city, lat/long, postal, and street details where available. 300,000+ banks, 800,000+ locations, 180+ countries. Current-only feed. # noqa: E501
|
|
271
|
+
This method makes a asynchronous HTTP request. Returns http data, http status and headers, wrapped in ApplyResult
|
|
272
|
+
|
|
273
|
+
Args:
|
|
274
|
+
branches_request (BranchesRequest):
|
|
275
|
+
|
|
276
|
+
Keyword Args:
|
|
277
|
+
_preload_content (bool): if False, the urllib3.HTTPResponse object
|
|
278
|
+
will be returned without reading/decoding response data.
|
|
279
|
+
Default is True. NOTE: if this API returns a file, it is the responsibility
|
|
280
|
+
of the caller to close the file stream.
|
|
281
|
+
_request_timeout (int/float/tuple): timeout setting for this request. If
|
|
282
|
+
one number provided, it will be total request timeout. It can also
|
|
283
|
+
be a pair (tuple) of (connection, read) timeouts.
|
|
284
|
+
Default is None.
|
|
285
|
+
_check_input_type (bool): specifies if type checking
|
|
286
|
+
should be done one the data sent to the server.
|
|
287
|
+
Default is True.
|
|
288
|
+
_check_return_type (bool): specifies if type checking
|
|
289
|
+
should be done one the data received from the server.
|
|
290
|
+
Default is True.
|
|
291
|
+
_spec_property_naming (bool): True if the variable names in the input data
|
|
292
|
+
are serialized names, as specified in the OpenAPI document.
|
|
293
|
+
False if the variable names in the input data
|
|
294
|
+
are pythonic names, e.g. snake case (default)
|
|
295
|
+
_content_type (str/None): force body content-type.
|
|
296
|
+
Default is None and content-type will be predicted by allowed
|
|
297
|
+
content-types and body.
|
|
298
|
+
_host_index (int/None): specifies the index of the server
|
|
299
|
+
that we want to use.
|
|
300
|
+
Default is read from the configuration.
|
|
301
|
+
Returns:
|
|
302
|
+
ApplyResult[(BranchesResponse, int, typing.Dict)]
|
|
303
|
+
"""
|
|
304
|
+
self.apply_kwargs_defaults(kwargs=kwargs, return_http_data_only=False, async_req=True)
|
|
305
|
+
kwargs['branches_request'] = \
|
|
306
|
+
branches_request
|
|
307
|
+
return self.get_branches_endpoint.call_with_http_info(**kwargs)
|
|
308
|
+
|
|
309
|
+
|
|
@@ -0,0 +1,309 @@
|
|
|
1
|
+
"""
|
|
2
|
+
FactSet Banks API
|
|
3
|
+
|
|
4
|
+
The FactSet Banks API provides comprehensive banking industry data including regulatory financials, performance metrics, branch networks, and specialized reporting across US, Canadian, and Australian institutions. **Key Features:** - Multi-jurisdiction regulatory financials (US, Canada, Australia) - Unified endpoint structure for banks, credit unions, and specialty finance - UBPR performance metrics and peer group analysis - Branch and ATM location data with market share - Country exposure and risk metrics - Regulatory filings (10-D, UCC-1) - Deposit rates and specialty finance reporting # noqa: E501
|
|
5
|
+
|
|
6
|
+
The version of the OpenAPI document: 1.0.0
|
|
7
|
+
Contact: api@factset.com
|
|
8
|
+
Generated by: https://openapi-generator.tech
|
|
9
|
+
"""
|
|
10
|
+
|
|
11
|
+
|
|
12
|
+
import re # noqa: F401
|
|
13
|
+
import sys # noqa: F401
|
|
14
|
+
from multiprocessing.pool import ApplyResult
|
|
15
|
+
import typing
|
|
16
|
+
|
|
17
|
+
from fds.sdk.FactSetBanks.api_client import ApiClient, Endpoint as _Endpoint
|
|
18
|
+
from fds.sdk.FactSetBanks.model_utils import ( # noqa: F401
|
|
19
|
+
check_allowed_values,
|
|
20
|
+
check_validations,
|
|
21
|
+
date,
|
|
22
|
+
datetime,
|
|
23
|
+
file_type,
|
|
24
|
+
none_type,
|
|
25
|
+
validate_and_convert_types
|
|
26
|
+
)
|
|
27
|
+
from fds.sdk.FactSetBanks.exceptions import ApiException
|
|
28
|
+
from fds.sdk.FactSetBanks.model.error_response import ErrorResponse
|
|
29
|
+
from fds.sdk.FactSetBanks.model.rates_request import RatesRequest
|
|
30
|
+
from fds.sdk.FactSetBanks.model.rates_response import RatesResponse
|
|
31
|
+
|
|
32
|
+
|
|
33
|
+
|
|
34
|
+
|
|
35
|
+
|
|
36
|
+
class DepositRatesApi(object):
|
|
37
|
+
"""NOTE: This class is auto generated by OpenAPI Generator
|
|
38
|
+
Ref: https://openapi-generator.tech
|
|
39
|
+
|
|
40
|
+
Do not edit the class manually.
|
|
41
|
+
"""
|
|
42
|
+
|
|
43
|
+
def __init__(self, api_client=None):
|
|
44
|
+
if api_client is None:
|
|
45
|
+
api_client = ApiClient()
|
|
46
|
+
self.api_client = api_client
|
|
47
|
+
|
|
48
|
+
self.get_rates_endpoint = _Endpoint(
|
|
49
|
+
settings={
|
|
50
|
+
'response_type': (
|
|
51
|
+
{ 200: (RatesResponse,), 400: (ErrorResponse,), 401: (ErrorResponse,), 403: (ErrorResponse,), 404: (ErrorResponse,), 415: (ErrorResponse,), 422: (ErrorResponse,), 500: (ErrorResponse,), },
|
|
52
|
+
None
|
|
53
|
+
),
|
|
54
|
+
'auth': [
|
|
55
|
+
'FactSetApiKey',
|
|
56
|
+
'FactSetOAuth2'
|
|
57
|
+
],
|
|
58
|
+
'endpoint_path': '/deposit-rates',
|
|
59
|
+
'operation_id': 'get_rates',
|
|
60
|
+
'http_method': 'POST',
|
|
61
|
+
'servers': None,
|
|
62
|
+
},
|
|
63
|
+
params_map={
|
|
64
|
+
'all': [
|
|
65
|
+
'rates_request',
|
|
66
|
+
],
|
|
67
|
+
'required': [
|
|
68
|
+
'rates_request',
|
|
69
|
+
],
|
|
70
|
+
'nullable': [
|
|
71
|
+
],
|
|
72
|
+
'enum': [
|
|
73
|
+
],
|
|
74
|
+
'validation': [
|
|
75
|
+
]
|
|
76
|
+
},
|
|
77
|
+
root_map={
|
|
78
|
+
'validations': {
|
|
79
|
+
},
|
|
80
|
+
'allowed_values': {
|
|
81
|
+
},
|
|
82
|
+
'openapi_types': {
|
|
83
|
+
'rates_request':
|
|
84
|
+
(RatesRequest,),
|
|
85
|
+
},
|
|
86
|
+
'attribute_map': {
|
|
87
|
+
},
|
|
88
|
+
'location_map': {
|
|
89
|
+
'rates_request': 'body',
|
|
90
|
+
},
|
|
91
|
+
'collection_format_map': {
|
|
92
|
+
}
|
|
93
|
+
},
|
|
94
|
+
headers_map={
|
|
95
|
+
'accept': [
|
|
96
|
+
'application/json'
|
|
97
|
+
],
|
|
98
|
+
'content_type': [
|
|
99
|
+
'application/json'
|
|
100
|
+
]
|
|
101
|
+
},
|
|
102
|
+
api_client=api_client
|
|
103
|
+
)
|
|
104
|
+
|
|
105
|
+
|
|
106
|
+
@staticmethod
|
|
107
|
+
def apply_kwargs_defaults(kwargs, return_http_data_only, async_req):
|
|
108
|
+
kwargs["async_req"] = async_req
|
|
109
|
+
kwargs["_return_http_data_only"] = return_http_data_only
|
|
110
|
+
kwargs["_preload_content"] = kwargs.get("_preload_content", True)
|
|
111
|
+
kwargs["_request_timeout"] = kwargs.get("_request_timeout", None)
|
|
112
|
+
kwargs["_check_input_type"] = kwargs.get("_check_input_type", True)
|
|
113
|
+
kwargs["_check_return_type"] = kwargs.get("_check_return_type", True)
|
|
114
|
+
kwargs["_spec_property_naming"] = kwargs.get("_spec_property_naming", False)
|
|
115
|
+
kwargs["_content_type"] = kwargs.get("_content_type")
|
|
116
|
+
kwargs["_host_index"] = kwargs.get("_host_index")
|
|
117
|
+
|
|
118
|
+
|
|
119
|
+
def get_rates(
|
|
120
|
+
self,
|
|
121
|
+
rates_request,
|
|
122
|
+
**kwargs
|
|
123
|
+
) -> RatesResponse:
|
|
124
|
+
"""Returns deposit rates # noqa: E501
|
|
125
|
+
|
|
126
|
+
Returns current and historical deposit rates from US banks and credit unions — APY, previous APY, national APY averages, terms, and minimum balances — across CD, Savings, Interest Checking, Money Market, Fixed IRA, and Variable IRA products. Identifies where banks offer better rates than geographic competitors. Covers 500+ financial institutions (US banks, credit unions, internet banks); 40+ data items. # noqa: E501
|
|
127
|
+
This method makes a synchronous HTTP request. Returns the http data only
|
|
128
|
+
|
|
129
|
+
Args:
|
|
130
|
+
rates_request (RatesRequest):
|
|
131
|
+
|
|
132
|
+
Keyword Args:
|
|
133
|
+
_preload_content (bool): if False, the urllib3.HTTPResponse object
|
|
134
|
+
will be returned without reading/decoding response data.
|
|
135
|
+
Default is True. NOTE: if this API returns a file, it is the responsibility
|
|
136
|
+
of the caller to close the file stream.
|
|
137
|
+
_request_timeout (int/float/tuple): timeout setting for this request. If
|
|
138
|
+
one number provided, it will be total request timeout. It can also
|
|
139
|
+
be a pair (tuple) of (connection, read) timeouts.
|
|
140
|
+
Default is None.
|
|
141
|
+
_check_input_type (bool): specifies if type checking
|
|
142
|
+
should be done one the data sent to the server.
|
|
143
|
+
Default is True.
|
|
144
|
+
_check_return_type (bool): specifies if type checking
|
|
145
|
+
should be done one the data received from the server.
|
|
146
|
+
Default is True.
|
|
147
|
+
_spec_property_naming (bool): True if the variable names in the input data
|
|
148
|
+
are serialized names, as specified in the OpenAPI document.
|
|
149
|
+
False if the variable names in the input data
|
|
150
|
+
are pythonic names, e.g. snake case (default)
|
|
151
|
+
_content_type (str/None): force body content-type.
|
|
152
|
+
Default is None and content-type will be predicted by allowed
|
|
153
|
+
content-types and body.
|
|
154
|
+
_host_index (int/None): specifies the index of the server
|
|
155
|
+
that we want to use.
|
|
156
|
+
Default is read from the configuration.
|
|
157
|
+
Returns:
|
|
158
|
+
RatesResponse
|
|
159
|
+
Response Object
|
|
160
|
+
"""
|
|
161
|
+
self.apply_kwargs_defaults(kwargs=kwargs, return_http_data_only=True, async_req=False)
|
|
162
|
+
kwargs['rates_request'] = \
|
|
163
|
+
rates_request
|
|
164
|
+
return self.get_rates_endpoint.call_with_http_info(**kwargs)
|
|
165
|
+
|
|
166
|
+
def get_rates_with_http_info(
|
|
167
|
+
self,
|
|
168
|
+
rates_request,
|
|
169
|
+
**kwargs
|
|
170
|
+
) -> typing.Tuple[RatesResponse, int, typing.MutableMapping]:
|
|
171
|
+
"""Returns deposit rates # noqa: E501
|
|
172
|
+
|
|
173
|
+
Returns current and historical deposit rates from US banks and credit unions — APY, previous APY, national APY averages, terms, and minimum balances — across CD, Savings, Interest Checking, Money Market, Fixed IRA, and Variable IRA products. Identifies where banks offer better rates than geographic competitors. Covers 500+ financial institutions (US banks, credit unions, internet banks); 40+ data items. # noqa: E501
|
|
174
|
+
This method makes a synchronous HTTP request. Returns http data, http status and headers
|
|
175
|
+
|
|
176
|
+
Args:
|
|
177
|
+
rates_request (RatesRequest):
|
|
178
|
+
|
|
179
|
+
Keyword Args:
|
|
180
|
+
_preload_content (bool): if False, the urllib3.HTTPResponse object
|
|
181
|
+
will be returned without reading/decoding response data.
|
|
182
|
+
Default is True. NOTE: if this API returns a file, it is the responsibility
|
|
183
|
+
of the caller to close the file stream.
|
|
184
|
+
_request_timeout (int/float/tuple): timeout setting for this request. If
|
|
185
|
+
one number provided, it will be total request timeout. It can also
|
|
186
|
+
be a pair (tuple) of (connection, read) timeouts.
|
|
187
|
+
Default is None.
|
|
188
|
+
_check_input_type (bool): specifies if type checking
|
|
189
|
+
should be done one the data sent to the server.
|
|
190
|
+
Default is True.
|
|
191
|
+
_check_return_type (bool): specifies if type checking
|
|
192
|
+
should be done one the data received from the server.
|
|
193
|
+
Default is True.
|
|
194
|
+
_spec_property_naming (bool): True if the variable names in the input data
|
|
195
|
+
are serialized names, as specified in the OpenAPI document.
|
|
196
|
+
False if the variable names in the input data
|
|
197
|
+
are pythonic names, e.g. snake case (default)
|
|
198
|
+
_content_type (str/None): force body content-type.
|
|
199
|
+
Default is None and content-type will be predicted by allowed
|
|
200
|
+
content-types and body.
|
|
201
|
+
_host_index (int/None): specifies the index of the server
|
|
202
|
+
that we want to use.
|
|
203
|
+
Default is read from the configuration.
|
|
204
|
+
Returns:
|
|
205
|
+
RatesResponse
|
|
206
|
+
Response Object
|
|
207
|
+
int
|
|
208
|
+
Http Status Code
|
|
209
|
+
dict
|
|
210
|
+
Dictionary of the response headers
|
|
211
|
+
"""
|
|
212
|
+
self.apply_kwargs_defaults(kwargs=kwargs, return_http_data_only=False, async_req=False)
|
|
213
|
+
kwargs['rates_request'] = \
|
|
214
|
+
rates_request
|
|
215
|
+
return self.get_rates_endpoint.call_with_http_info(**kwargs)
|
|
216
|
+
|
|
217
|
+
def get_rates_async(
|
|
218
|
+
self,
|
|
219
|
+
rates_request,
|
|
220
|
+
**kwargs
|
|
221
|
+
) -> "ApplyResult[RatesResponse]":
|
|
222
|
+
"""Returns deposit rates # noqa: E501
|
|
223
|
+
|
|
224
|
+
Returns current and historical deposit rates from US banks and credit unions — APY, previous APY, national APY averages, terms, and minimum balances — across CD, Savings, Interest Checking, Money Market, Fixed IRA, and Variable IRA products. Identifies where banks offer better rates than geographic competitors. Covers 500+ financial institutions (US banks, credit unions, internet banks); 40+ data items. # noqa: E501
|
|
225
|
+
This method makes a asynchronous HTTP request. Returns the http data, wrapped in ApplyResult
|
|
226
|
+
|
|
227
|
+
Args:
|
|
228
|
+
rates_request (RatesRequest):
|
|
229
|
+
|
|
230
|
+
Keyword Args:
|
|
231
|
+
_preload_content (bool): if False, the urllib3.HTTPResponse object
|
|
232
|
+
will be returned without reading/decoding response data.
|
|
233
|
+
Default is True. NOTE: if this API returns a file, it is the responsibility
|
|
234
|
+
of the caller to close the file stream.
|
|
235
|
+
_request_timeout (int/float/tuple): timeout setting for this request. If
|
|
236
|
+
one number provided, it will be total request timeout. It can also
|
|
237
|
+
be a pair (tuple) of (connection, read) timeouts.
|
|
238
|
+
Default is None.
|
|
239
|
+
_check_input_type (bool): specifies if type checking
|
|
240
|
+
should be done one the data sent to the server.
|
|
241
|
+
Default is True.
|
|
242
|
+
_check_return_type (bool): specifies if type checking
|
|
243
|
+
should be done one the data received from the server.
|
|
244
|
+
Default is True.
|
|
245
|
+
_spec_property_naming (bool): True if the variable names in the input data
|
|
246
|
+
are serialized names, as specified in the OpenAPI document.
|
|
247
|
+
False if the variable names in the input data
|
|
248
|
+
are pythonic names, e.g. snake case (default)
|
|
249
|
+
_content_type (str/None): force body content-type.
|
|
250
|
+
Default is None and content-type will be predicted by allowed
|
|
251
|
+
content-types and body.
|
|
252
|
+
_host_index (int/None): specifies the index of the server
|
|
253
|
+
that we want to use.
|
|
254
|
+
Default is read from the configuration.
|
|
255
|
+
Returns:
|
|
256
|
+
ApplyResult[RatesResponse]
|
|
257
|
+
"""
|
|
258
|
+
self.apply_kwargs_defaults(kwargs=kwargs, return_http_data_only=True, async_req=True)
|
|
259
|
+
kwargs['rates_request'] = \
|
|
260
|
+
rates_request
|
|
261
|
+
return self.get_rates_endpoint.call_with_http_info(**kwargs)
|
|
262
|
+
|
|
263
|
+
def get_rates_with_http_info_async(
|
|
264
|
+
self,
|
|
265
|
+
rates_request,
|
|
266
|
+
**kwargs
|
|
267
|
+
) -> "ApplyResult[typing.Tuple[RatesResponse, int, typing.MutableMapping]]":
|
|
268
|
+
"""Returns deposit rates # noqa: E501
|
|
269
|
+
|
|
270
|
+
Returns current and historical deposit rates from US banks and credit unions — APY, previous APY, national APY averages, terms, and minimum balances — across CD, Savings, Interest Checking, Money Market, Fixed IRA, and Variable IRA products. Identifies where banks offer better rates than geographic competitors. Covers 500+ financial institutions (US banks, credit unions, internet banks); 40+ data items. # noqa: E501
|
|
271
|
+
This method makes a asynchronous HTTP request. Returns http data, http status and headers, wrapped in ApplyResult
|
|
272
|
+
|
|
273
|
+
Args:
|
|
274
|
+
rates_request (RatesRequest):
|
|
275
|
+
|
|
276
|
+
Keyword Args:
|
|
277
|
+
_preload_content (bool): if False, the urllib3.HTTPResponse object
|
|
278
|
+
will be returned without reading/decoding response data.
|
|
279
|
+
Default is True. NOTE: if this API returns a file, it is the responsibility
|
|
280
|
+
of the caller to close the file stream.
|
|
281
|
+
_request_timeout (int/float/tuple): timeout setting for this request. If
|
|
282
|
+
one number provided, it will be total request timeout. It can also
|
|
283
|
+
be a pair (tuple) of (connection, read) timeouts.
|
|
284
|
+
Default is None.
|
|
285
|
+
_check_input_type (bool): specifies if type checking
|
|
286
|
+
should be done one the data sent to the server.
|
|
287
|
+
Default is True.
|
|
288
|
+
_check_return_type (bool): specifies if type checking
|
|
289
|
+
should be done one the data received from the server.
|
|
290
|
+
Default is True.
|
|
291
|
+
_spec_property_naming (bool): True if the variable names in the input data
|
|
292
|
+
are serialized names, as specified in the OpenAPI document.
|
|
293
|
+
False if the variable names in the input data
|
|
294
|
+
are pythonic names, e.g. snake case (default)
|
|
295
|
+
_content_type (str/None): force body content-type.
|
|
296
|
+
Default is None and content-type will be predicted by allowed
|
|
297
|
+
content-types and body.
|
|
298
|
+
_host_index (int/None): specifies the index of the server
|
|
299
|
+
that we want to use.
|
|
300
|
+
Default is read from the configuration.
|
|
301
|
+
Returns:
|
|
302
|
+
ApplyResult[(RatesResponse, int, typing.Dict)]
|
|
303
|
+
"""
|
|
304
|
+
self.apply_kwargs_defaults(kwargs=kwargs, return_http_data_only=False, async_req=True)
|
|
305
|
+
kwargs['rates_request'] = \
|
|
306
|
+
rates_request
|
|
307
|
+
return self.get_rates_endpoint.call_with_http_info(**kwargs)
|
|
308
|
+
|
|
309
|
+
|