international_portfolio_investment

Get International Portfolio Investment holdings (Enhanced Financial Accounts).

Examples

from openbb import obb
# Get foreign residents' holdings of total U.S. long-term securities by country.
obb.federal_reserve.international_portfolio_investment(table='table1', provider='federal_reserve')
# Get U.S. residents' holdings of foreign corporate stocks for a single country.
obb.federal_reserve.international_portfolio_investment(table='table2b', country='Japan', provider='federal_reserve')

Parameters

• standard
• federal_reserve

table: str | None
Default: table1
The holdings table: foreign residents' holdings of U.S. securities - total (table1), Treasury (1a), agency (1b), corporate bonds (1c), stocks (1d), short-term Treasury memo (1e); or U.S. residents' holdings of foreign securities - total (table2), bonds (2a), stocks (2b).

country: str | None
Filter to a single country or region (matched in the path).

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: FederalReserveInternationalPortfolioInvestment

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 observation date.

country: str
The country or region.