Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Feature] Balance Of Payments For FRED #6431

Merged
merged 5 commits into from
May 20, 2024
Merged

[Feature] Balance Of Payments For FRED #6431

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
fbaf10f
add balance of payments to FRED provider
deeleeramone May 17, 2024
be5df8c
gotta commit the init file
deeleeramone May 17, 2024
fa45d03
unused import
deeleeramone May 17, 2024
64407f4
mypy
deeleeramone May 17, 2024
301c071
Merge branch 'develop' into feature/fred-balance-of-payments
IgorWounds May 19, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
79 changes: 79 additions & 0 deletions openbb_platform/core/openbb_core/provider/standard_models/balance_of_payments.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,85 @@ class BalanceOfPaymentsQueryParams(QueryParams):
"""Balance Of Payments Query."""


class BP6BopUsdData(Data):
"""OECD BP6 Balance of Payments Items, in USD."""

period: dateType = Field(
default=None,
description="The date representing the beginning of the reporting period.",
)
balance_percent_of_gdp: Optional[float] = Field(
default=None,
description="Current Account Balance as Percent of GDP",
json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100},
)
balance_total: Optional[float] = Field(
default=None, description="Current Account Total Balance (USD)"
)
balance_total_services: Optional[float] = Field(
default=None, description="Current Account Total Services Balance (USD)"
)
balance_total_secondary_income: Optional[float] = Field(
default=None, description="Current Account Total Secondary Income Balance (USD)"
)
balance_total_goods: Optional[float] = Field(
default=None, description="Current Account Total Goods Balance (USD)"
)
balance_total_primary_income: Optional[float] = Field(
default=None, description="Current Account Total Primary Income Balance (USD)"
)
credits_services_percent_of_goods_and_services: Optional[float] = Field(
default=None,
description="Current Account Credits Services as Percent of Goods and Services",
json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100},
)
credits_services_percent_of_current_account: Optional[float] = Field(
default=None,
description="Current Account Credits Services as Percent of Current Account",
json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100},
)
credits_total_services: Optional[float] = Field(
default=None, description="Current Account Credits Total Services (USD)"
)
credits_total_goods: Optional[float] = Field(
default=None, description="Current Account Credits Total Goods (USD)"
)
credits_total_primary_income: Optional[float] = Field(
default=None, description="Current Account Credits Total Primary Income (USD)"
)
credits_total_secondary_income: Optional[float] = Field(
default=None, description="Current Account Credits Total Secondary Income (USD)"
)
credits_total: Optional[float] = Field(
default=None, description="Current Account Credits Total (USD)"
)
debits_services_percent_of_goods_and_services: Optional[float] = Field(
default=None,
description="Current Account Debits Services as Percent of Goods and Services",
json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100},
)
debits_services_percent_of_current_account: Optional[float] = Field(
default=None,
description="Current Account Debits Services as Percent of Current Account",
json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100},
)
debits_total_services: Optional[float] = Field(
default=None, description="Current Account Debits Total Services (USD)"
)
debits_total_goods: Optional[float] = Field(
default=None, description="Current Account Debits Total Goods (USD)"
)
debits_total_primary_income: Optional[float] = Field(
default=None, description="Current Account Debits Total Primary Income (USD)"
)
debits_total: Optional[float] = Field(
default=None, description="Current Account Debits Total (USD)"
)
debits_total_secondary_income: Optional[float] = Field(
default=None, description="Current Account Debits Total Secondary Income (USD)"
)


class ECBMain(Data):
"""ECB Main Balance of Payments Items."""

Expand Down
8 changes: 8 additions & 0 deletions openbb_platform/extensions/economy/integration/test_economy_api.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -251,6 +251,14 @@ def test_economy_gdp_real(params, headers):
"provider": "ecb",
}
),
(
{
"country": "united_states",
"start_date": None,
"end_date": None,
"provider": "fred",
}
),
],
)
@pytest.mark.integration
Expand Down
8 changes: 8 additions & 0 deletions openbb_platform/extensions/economy/integration/test_economy_python.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -212,6 +212,14 @@ def test_economy_gdp_real(params, obb):
"provider": "ecb",
}
),
(
{
"country": "united_states",
"start_date": None,
"end_date": None,
"provider": "fred",
}
),
],
)
@pytest.mark.integration
Expand Down
2 changes: 2 additions & 0 deletions openbb_platform/extensions/economy/openbb_economy/economy_router.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -93,6 +93,8 @@ async def risk_premium(
@router.command(
model="BalanceOfPayments",
examples=[
APIEx(parameters={"provider": "fred"}),
APIEx(parameters={"provider": "fred", "country": "brazil"}),
APIEx(parameters={"provider": "ecb"}),
APIEx(parameters={"report_type": "summary", "provider": "ecb"}),
APIEx(
Expand Down
248 changes: 248 additions & 0 deletions openbb_platform/openbb/assets/reference.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3153,6 +3153,254 @@
},
"model": "RiskPremium"
},
"/economy/balance_of_payments": {
"deprecated": {
"flag": null,
"message": null
},
"description": "Balance of Payments Reports.",
"examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.economy.balance_of_payments(provider='fred')\nobb.economy.balance_of_payments(provider='fred', country=brazil)\n```\n\n",
"parameters": {
"standard": [
{
"name": "provider",
"type": "Literal['fred']",
"description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fred' if there is no default.",
"default": "fred",
"optional": true
}
],
"fred": [
{
"name": "country",
"type": "Literal['argentina', 'australia', 'austria', 'belgium', 'brazil', 'canada', 'chile', 'china', 'colombia', 'costa_rica', 'czechia', 'denmark', 'estonia', 'finland', 'france', 'germany', 'greece', 'hungary', 'iceland', 'india', 'indonesia', 'ireland', 'israel', 'italy', 'japan', 'korea', 'latvia', 'lithuania', 'luxembourg', 'mexico', 'netherlands', 'new_zealand', 'norway', 'poland', 'portugal', 'russia', 'saudi_arabia', 'slovak_republic', 'slovenia', 'south_africa', 'spain', 'sweden', 'switzerland', 'turkey', 'united_kingdom', 'united_states', 'g7', 'g20']",
"description": "The country to get data. Enter as a 3-letter ISO country code, default is USA.",
"default": "united_states",
"optional": true,
"choices": "argentina,australia,austria,belgium,brazil,canada,chile,china,colombia,costa_rica,czechia,denmark,estonia,finland,france,germany,greece,hungary,iceland,india,indonesia,ireland,israel,italy,japan,korea,latvia,lithuania,luxembourg,mexico,netherlands,new_zealand,norway,poland,portugal,russia,saudi_arabia,slovak_republic,slovenia,south_africa,spain,sweden,switzerland,turkey,united_kingdom,united_states,g7,g20"
},
{
"name": "start_date",
"type": "Union[date, str]",
"description": "Start date of the data, in YYYY-MM-DD format.",
"default": null,
"optional": true,
"choices": null
},
{
"name": "end_date",
"type": "Union[date, str]",
"description": "End date of the data, in YYYY-MM-DD format.",
"default": null,
"optional": true,
"choices": null
}
]
},
"returns": {
"OBBject": [
{
"name": "results",
"type": "List[BalanceOfPayments]",
"description": "Serializable results."
},
{
"name": "provider",
"type": "Optional[Literal['fred']]",
"description": "Provider name."
},
{
"name": "warnings",
"type": "Optional[List[Warning_]]",
"description": "List of warnings."
},
{
"name": "chart",
"type": "Optional[Chart]",
"description": "Chart object."
},
{
"name": "extra",
"type": "Dict[str, Any]",
"description": "Extra info."
}
]
},
"data": {
"standard": [
{
"name": "period",
"type": "date",
"description": "The date representing the beginning of the reporting period.",
"default": null,
"optional": true,
"choices": null
},
{
"name": "balance_percent_of_gdp",
"type": "float",
"description": "Current Account Balance as Percent of GDP",
"default": null,
"optional": true,
"choices": null
},
{
"name": "balance_total",
"type": "float",
"description": "Current Account Total Balance (USD)",
"default": null,
"optional": true,
"choices": null
},
{
"name": "balance_total_services",
"type": "float",
"description": "Current Account Total Services Balance (USD)",
"default": null,
"optional": true,
"choices": null
},
{
"name": "balance_total_secondary_income",
"type": "float",
"description": "Current Account Total Secondary Income Balance (USD)",
"default": null,
"optional": true,
"choices": null
},
{
"name": "balance_total_goods",
"type": "float",
"description": "Current Account Total Goods Balance (USD)",
"default": null,
"optional": true,
"choices": null
},
{
"name": "balance_total_primary_income",
"type": "float",
"description": "Current Account Total Primary Income Balance (USD)",
"default": null,
"optional": true,
"choices": null
},
{
"name": "credits_services_percent_of_goods_and_services",
"type": "float",
"description": "Current Account Credits Services as Percent of Goods and Services",
"default": null,
"optional": true,
"choices": null
},
{
"name": "credits_services_percent_of_current_account",
"type": "float",
"description": "Current Account Credits Services as Percent of Current Account",
"default": null,
"optional": true,
"choices": null
},
{
"name": "credits_total_services",
"type": "float",
"description": "Current Account Credits Total Services (USD)",
"default": null,
"optional": true,
"choices": null
},
{
"name": "credits_total_goods",
"type": "float",
"description": "Current Account Credits Total Goods (USD)",
"default": null,
"optional": true,
"choices": null
},
{
"name": "credits_total_primary_income",
"type": "float",
"description": "Current Account Credits Total Primary Income (USD)",
"default": null,
"optional": true,
"choices": null
},
{
"name": "credits_total_secondary_income",
"type": "float",
"description": "Current Account Credits Total Secondary Income (USD)",
"default": null,
"optional": true,
"choices": null
},
{
"name": "credits_total",
"type": "float",
"description": "Current Account Credits Total (USD)",
"default": null,
"optional": true,
"choices": null
},
{
"name": "debits_services_percent_of_goods_and_services",
"type": "float",
"description": "Current Account Debits Services as Percent of Goods and Services",
"default": null,
"optional": true,
"choices": null
},
{
"name": "debits_services_percent_of_current_account",
"type": "float",
"description": "Current Account Debits Services as Percent of Current Account",
"default": null,
"optional": true,
"choices": null
},
{
"name": "debits_total_services",
"type": "float",
"description": "Current Account Debits Total Services (USD)",
"default": null,
"optional": true,
"choices": null
},
{
"name": "debits_total_goods",
"type": "float",
"description": "Current Account Debits Total Goods (USD)",
"default": null,
"optional": true,
"choices": null
},
{
"name": "debits_total_primary_income",
"type": "float",
"description": "Current Account Debits Total Primary Income (USD)",
"default": null,
"optional": true,
"choices": null
},
{
"name": "debits_total",
"type": "float",
"description": "Current Account Debits Total (USD)",
"default": null,
"optional": true,
"choices": null
},
{
"name": "debits_total_secondary_income",
"type": "float",
"description": "Current Account Debits Total Secondary Income (USD)",
"default": null,
"optional": true,
"choices": null
}
],
"fred": []
},
"model": "BalanceOfPayments"
},
"/economy/fred_search": {
"deprecated": {
"flag": null,
Expand Down
Loading
Loading