custom_peer_group
Get a bank's FFIEC UBPR measures against a custom peer group of RSSDs.
Examples
from openbb import obb
# Get a bank's UBPR measures against a custom peer group of RSSDs, by ticker.
obb.federal_reserve.ffiec.custom_peer_group(symbol='WFC', peers='451965,480228,852218', provider='federal_reserve')
# Get a bank's UBPR measures against a custom peer group of RSSDs, by RSSD identifier and report section.
obb.federal_reserve.ffiec.custom_peer_group(rssd_id='451965', peers='451965,480228,852218', section='Capital Analysis-a', provider='federal_reserve')
Parameters
- standard
- federal_reserve
symbol: str | None
The target bank's stock ticker, resolved to its parent RSSD identifier.
rssd_id: str | None
The target bank's RSSD identifier (the UBPR ID RSSD).
peers: str | None
Comma-separated RSSD identifiers forming the custom peer group; the target bank may be included.
section: str | None
Default: Summary Ratios
The UBPR report section (page) to return.
Choices
- Summary Ratios
- Income Statement $
- QTR Income Statement $
- Noninterest Income and Expenses
- Asset Yields and Funding Costs
- Balance Sheet $
- Off Balance Sheet Items
- Derivative Instruments
- 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
- Capital Analysis-b
- Capital Analysis-c
- Income Statement 1-Qtr-Ann
- Securitization & Asset Sale-a
- Securitization & Asset Sale-b
- Securitization & Asset Sale-c
- Fiduciary Services-a
- Fiduciary Services-b
all_periods: bool | None
Default: False
Return every reported period as the bank's own time series.
Returns
results: FederalReserveCustomPeerGroup
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's concept, where available.