household_debt
Get the New York Fed total household debt balance by category.
Examples
from openbb import obb
obb.federal_reserve.ny.household_debt(provider='federal_reserve')
# Get the by-state composition of debt balance per capita.
obb.federal_reserve.ny.household_debt(table='composition_of_debt_balance_per_capita_by_state', provider='federal_reserve')
Parameters
- standard
- federal_reserve
table: str | None
Default: total_debt_balance
The report table to retrieve. Each table corresponds to one chart in the Quarterly Report on Household Debt and Credit, including national, by-age, and by-state breakdowns.
start_date: date | None | str
Start date of the data, in YYYY-MM-DD format.
end_date: date | None | str
End date of the data, in YYYY-MM-DD format.
Returns
results: FederalReserveNewYorkHouseholdDebt
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
date: date | str
The quarter, as the quarter-end date.