balance_of_payments

Balance of Payments reports from the IMF BOP dataflow.

Examples

from openbb import obb
obb.imf.balance_of_payments(provider='imf')
obb.imf.balance_of_payments(provider='imf', country='BRA')

Parameters

• standard
• imf

country: str | None | list[str | None]
Default: USA
The country to get data. Multiple items allowed.

frequency: str | None
Default: quarterly
Reporting frequency.

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

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
• imf

period: date | None
The date representing the beginning of the reporting period.

balance_percent_of_gdp: float | None
Current Account Balance as Percent of GDP

balance_total: float | None
Current Account Total Balance (USD)

balance_total_services: float | None
Current Account Total Services Balance (USD)

balance_total_secondary_income: float | None
Current Account Total Secondary Income Balance (USD)

balance_total_goods: float | None
Current Account Total Goods Balance (USD)

balance_total_primary_income: float | None
Current Account Total Primary Income Balance (USD)

credits_services_percent_of_goods_and_services: float | None
Current Account Credits Services as Percent of Goods and Services

credits_services_percent_of_current_account: float | None
Current Account Credits Services as Percent of Current Account

credits_total_services: float | None
Current Account Credits Total Services (USD)

credits_total_goods: float | None
Current Account Credits Total Goods (USD)

credits_total_primary_income: float | None
Current Account Credits Total Primary Income (USD)

credits_total_secondary_income: float | None
Current Account Credits Total Secondary Income (USD)

credits_total: float | None
Current Account Credits Total (USD)

debits_services_percent_of_goods_and_services: float | None
Current Account Debits Services as Percent of Goods and Services

debits_services_percent_of_current_account: float | None
Current Account Debits Services as Percent of Current Account

debits_total_services: float | None
Current Account Debits Total Services (USD)

debits_total_goods: float | None
Current Account Debits Total Goods (USD)

debits_total_primary_income: float | None
Current Account Debits Total Primary Income (USD)

debits_total: float | None
Current Account Debits Total (USD)

debits_total_secondary_income: float | None
Current Account Debits Total Secondary Income (USD)

period: date | None
The date representing the beginning of the reporting period.

balance_percent_of_gdp: float | None
Current Account Balance as Percent of GDP (not provided by IMF BOP).

balance_total: float | None
Current Account Total Balance (USD)

balance_total_services: float | None
Current Account Total Services Balance (USD)

balance_total_secondary_income: float | None
Current Account Total Secondary Income Balance (USD)

balance_total_goods: float | None
Current Account Total Goods Balance (USD)

balance_total_primary_income: float | None
Current Account Total Primary Income Balance (USD)

credits_services_percent_of_goods_and_services: float | None
Current Account Credits Services as Percent of Goods and Services

credits_services_percent_of_current_account: float | None
Current Account Credits Services as Percent of Current Account

credits_total_services: float | None
Current Account Credits Total Services (USD)

credits_total_goods: float | None
Current Account Credits Total Goods (USD)

credits_total_primary_income: float | None
Current Account Credits Total Primary Income (USD)

credits_total_secondary_income: float | None
Current Account Credits Total Secondary Income (USD)

credits_total: float | None
Current Account Credits Total (USD)

debits_services_percent_of_goods_and_services: float | None
Current Account Debits Services as Percent of Goods and Services

debits_services_percent_of_current_account: float | None
Current Account Debits Services as Percent of Current Account

debits_total_services: float | None
Current Account Debits Total Services (USD)

debits_total_goods: float | None
Current Account Debits Total Goods (USD)

debits_total_primary_income: float | None
Current Account Debits Total Primary Income (USD)

debits_total: float | None
Current Account Debits Total (USD)

debits_total_secondary_income: float | None
Current Account Debits Total Secondary Income (USD)

country: str | None
ISO3 country code (or label) reported alongside each row.