tessl/pypi-openbb
Investment research for everyone, anywhere.
—
Pending
economy.mddocs/
Economic Indicators
Macroeconomic data and indicators including GDP, inflation, employment statistics, central bank data, and global economic metrics. The economy module provides access to government and institutional economic data sources.
Capabilities
Economic Data Access
Comprehensive macroeconomic indicators and time series data from various government and institutional sources.
def obb.economy.unemployment(
provider: str = None,
**kwargs
) -> ResponseObject:
"""
Get global unemployment data.
Parameters:
- provider: Data provider to use
Returns:
ResponseObject with unemployment statistics
"""
def obb.economy.country_profile(
country: str,
provider: str = None,
**kwargs
) -> ResponseObject:
"""
Get economic country profile data.
Parameters:
- country: Country code or name
- provider: Data provider to use
Returns:
ResponseObject with country economic profile
"""
def obb.economy.house_price_index(
provider: str = None,
**kwargs
) -> ResponseObject:
"""
Get house price index data.
Parameters:
- provider: Data provider to use
Returns:
ResponseObject with house price index
"""
def obb.economy.share_price_index(
provider: str = None,
**kwargs
) -> ResponseObject:
"""
Get share price index data.
Parameters:
- provider: Data provider to use
Returns:
ResponseObject with share price index
"""
def obb.economy.balance_of_payments(
provider: str = None,
**kwargs
) -> ResponseObject:
"""
Get balance of payments data.
Parameters:
- provider: Data provider to use
Returns:
ResponseObject with balance of payments data
"""
def obb.economy.calendar(
provider: str = None,
**kwargs
) -> ResponseObject:
"""
Get economic calendar data.
Parameters:
- provider: Data provider to use
Returns:
ResponseObject with economic calendar events
"""
def obb.economy.interest_rates(
provider: str = None,
**kwargs
) -> ResponseObject:
"""
Get interest rates data.
Parameters:
- provider: Data provider to use
Returns:
ResponseObject with interest rates
"""
def obb.economy.direction_of_trade(
provider: str = None,
**kwargs
) -> ResponseObject:
"""
Get direction of trade data.
Parameters:
- provider: Data provider to use
Returns:
ResponseObject with trade direction statistics
"""Usage Examples
Basic Economic Data Retrieval
from openbb import obb
# Get unemployment data
unemployment_data = obb.economy.unemployment()
unemployment_df = unemployment_data.to_dataframe()
# Get economic calendar
calendar_data = obb.economy.calendar()
calendar_df = calendar_data.to_dataframe()
# Get country profile
country_data = obb.economy.country_profile(country="US")
country_df = country_data.to_dataframe()Economic Analysis Workflow
# Retrieve multiple economic indicators for analysis
# GDP data, inflation metrics, employment statistics
# Compare economic trends across different time periodsInstall with Tessl CLI
npx tessl i tessl/pypi-openbb