state_average
Get the FFIEC UBPR State Average report (state-level peer-group averages).
Examples
from openbb import obb
# Get the UBPR State Average for South Dakota commercial banks.
obb.federal_reserve.ffiec.state_average(state='SD', provider='federal_reserve')
# Get a State Average section for New York savings institutions.
obb.federal_reserve.ffiec.state_average(state='NY', group_type='savings', section='Balance Sheet %', provider='federal_reserve')
Parameters
- standard
- federal_reserve
state: str | None
Default: SD
The two-letter state (or territory) code to average.
Choices
- AL
- AK
- AS
- AZ
- AR
- CA
- CO
- CT
- DE
- DC
- FL
- GA
- GU
- HI
- ID
- IL
- IN
- IA
- KS
- KY
- LA
- ME
- MD
- MA
- MI
- FM
- MN
- MS
- MO
- MT
- NE
- NV
- NH
- NJ
- NM
- NY
- NC
- ND
- OH
- OK
- OR
- PA
- PR
- RI
- SC
- SD
- TN
- TX
- UT
- VT
- VI
- VA
- WA
- WV
- WI
- WY
group_type: str | None
Default: commercial
The institution peer group to average across the state.
Choices
- commercial
- savings
section: str | None
Default: Summary Ratios
The UBPR State Average report section (page) to return.
Choices
- Summary Ratios
- Noninterest Income and Expenses
- Asset Yields and Funding Costs
- Off Balance Sheet Items
- Derivative Analysis
- Balance Sheet %
- Allowance & Loan Mix-a
- Allowance & Loan Mix-b
- Concentrations of Credit
- PD, Nonacc & Rest Loans-a
- PD, Nonacc & Rest Loans-b
- Interest Rate Risk-a
- Interest Rate Risk-b
- Liquidity & Funding
- Liquidity & Inv Portfolio
- Capital Analysis-a
- Income Statement 1-Qtr-Ann
- Fiduciary Services-a
all_periods: bool | None
Default: False
Return every reported period instead of only the most recent five.
Returns
results: FederalReserveStateAverage
Serializable results.
provider: str | None
Provider name.
warnings: Optional[list[Warning_]]
List of warnings.
chart: Optional[Chart]
Chart object.
extra: dict[str, Any]
Extra info.
Data
- standard
- federal_reserve
label: str
The line item, indented by the report hierarchy.
is_header: bool | None
Whether the row is a section or sub-section header.
narrative: str | None
The MDRM definition of the line item, when available.