0
# Economic Indicators
1
2
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.
3
4
## Capabilities
5
6
### Economic Data Access
7
8
Comprehensive macroeconomic indicators and time series data from various government and institutional sources.
9
10
```python { .api }
11
def obb.economy.unemployment(
12
provider: str = None,
13
**kwargs
14
) -> ResponseObject:
15
"""
16
Get global unemployment data.
17
18
Parameters:
19
- provider: Data provider to use
20
21
Returns:
22
ResponseObject with unemployment statistics
23
"""
24
25
def obb.economy.country_profile(
26
country: str,
27
provider: str = None,
28
**kwargs
29
) -> ResponseObject:
30
"""
31
Get economic country profile data.
32
33
Parameters:
34
- country: Country code or name
35
- provider: Data provider to use
36
37
Returns:
38
ResponseObject with country economic profile
39
"""
40
41
def obb.economy.house_price_index(
42
provider: str = None,
43
**kwargs
44
) -> ResponseObject:
45
"""
46
Get house price index data.
47
48
Parameters:
49
- provider: Data provider to use
50
51
Returns:
52
ResponseObject with house price index
53
"""
54
55
def obb.economy.share_price_index(
56
provider: str = None,
57
**kwargs
58
) -> ResponseObject:
59
"""
60
Get share price index data.
61
62
Parameters:
63
- provider: Data provider to use
64
65
Returns:
66
ResponseObject with share price index
67
"""
68
69
def obb.economy.balance_of_payments(
70
provider: str = None,
71
**kwargs
72
) -> ResponseObject:
73
"""
74
Get balance of payments data.
75
76
Parameters:
77
- provider: Data provider to use
78
79
Returns:
80
ResponseObject with balance of payments data
81
"""
82
83
def obb.economy.calendar(
84
provider: str = None,
85
**kwargs
86
) -> ResponseObject:
87
"""
88
Get economic calendar data.
89
90
Parameters:
91
- provider: Data provider to use
92
93
Returns:
94
ResponseObject with economic calendar events
95
"""
96
97
def obb.economy.interest_rates(
98
provider: str = None,
99
**kwargs
100
) -> ResponseObject:
101
"""
102
Get interest rates data.
103
104
Parameters:
105
- provider: Data provider to use
106
107
Returns:
108
ResponseObject with interest rates
109
"""
110
111
def obb.economy.direction_of_trade(
112
provider: str = None,
113
**kwargs
114
) -> ResponseObject:
115
"""
116
Get direction of trade data.
117
118
Parameters:
119
- provider: Data provider to use
120
121
Returns:
122
ResponseObject with trade direction statistics
123
"""
124
```
125
126
## Usage Examples
127
128
### Basic Economic Data Retrieval
129
130
```python
131
from openbb import obb
132
133
# Get unemployment data
134
unemployment_data = obb.economy.unemployment()
135
unemployment_df = unemployment_data.to_dataframe()
136
137
# Get economic calendar
138
calendar_data = obb.economy.calendar()
139
calendar_df = calendar_data.to_dataframe()
140
141
# Get country profile
142
country_data = obb.economy.country_profile(country="US")
143
country_df = country_data.to_dataframe()
144
```
145
146
### Economic Analysis Workflow
147
148
```python
149
# Retrieve multiple economic indicators for analysis
150
# GDP data, inflation metrics, employment statistics
151
# Compare economic trends across different time periods
152
```