1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
|
"""FRED Regional Data Model."""
# pylint: disable=unused-argument
import json
import warnings
from datetime import datetime
from typing import Any, Dict, List, Literal, Optional, Union
from openbb_core.provider.abstract.fetcher import Fetcher
from openbb_core.provider.standard_models.fred_series import (
SeriesData,
SeriesQueryParams,
)
from openbb_core.provider.utils.errors import EmptyDataError
from openbb_core.provider.utils.helpers import (
amake_request,
get_querystring,
)
from pydantic import Field, model_validator
_warn = warnings.warn
class FredRegionalQueryParams(SeriesQueryParams):
"""FRED Regional Data Query Params."""
__alias_dict__ = {
"symbol": "series_group",
"transform": "transformation",
}
symbol: str = Field(
description="For this function, it is the series_group ID or series ID."
+ " If the symbol provided is for a series_group, set the `is_series_group` parameter to True."
+ " Not all series that are in FRED have geographical data."
)
is_series_group: bool = Field(
default=False,
description="When True, the symbol provided is for a series_group, else it is for a series ID.",
)
region_type: Union[
None,
Literal[
"bea",
"msa",
"frb",
"necta",
"state",
"country",
"county",
"censusregion",
],
] = Field(
default=None,
description="The type of regional data."
+ " Parameter is only valid when `is_series_group` is True.",
)
season: Union[
None,
Literal[
"SA",
"NSA",
"SSA",
],
] = Field(
default="NSA",
description="The seasonal adjustments to the data."
+ " Parameter is only valid when `is_series_group` is True.",
)
units: Optional[str] = Field(
default=None,
description="The units of the data."
+ " This should match the units returned from searching by series ID."
+ " An incorrect field will not necessarily return an error."
+ " Parameter is only valid when `is_series_group` is True.",
)
frequency: Union[
None,
Literal[
"d",
"w",
"bw",
"m",
"q",
"sa",
"a",
"wef",
"weth",
"wew",
"wetu",
"wem",
"wesu",
"wesa",
"bwew",
"bwem",
],
] = Field(
default=None,
description="""
Frequency aggregation to convert high frequency data to lower frequency.
Parameter is only valid when `is_series_group` is True.
a = Annual
sa= Semiannual
q = Quarterly
m = Monthly
w = Weekly
d = Daily
wef = Weekly, Ending Friday
weth = Weekly, Ending Thursday
wew = Weekly, Ending Wednesday
wetu = Weekly, Ending Tuesday
wem = Weekly, Ending Monday
wesu = Weekly, Ending Sunday
wesa = Weekly, Ending Saturday
bwew = Biweekly, Ending Wednesday
bwem = Biweekly, Ending Monday
""",
)
aggregation_method: Literal["avg", "sum", "eop"] = Field(
default="avg",
description="""
A key that indicates the aggregation method used for frequency aggregation.
This parameter has no affect if the frequency parameter is not set.
Only valid when `is_series_group` is True.
avg = Average
sum = Sum
eop = End of Period
""",
)
transform: Literal[
"lin", "chg", "ch1", "pch", "pc1", "pca", "cch", "cca", "log"
] = Field(
default="lin",
description="""
Transformation type. Only valid when `is_series_group` is True.
lin = Levels (No transformation)
chg = Change
ch1 = Change from Year Ago
pch = Percent Change
pc1 = Percent Change from Year Ago
pca = Compounded Annual Rate of Change
cch = Continuously Compounded Rate of Change
cca = Continuously Compounded Annual Rate of Change
log = Natural Log
""",
)
@model_validator(mode="before")
@classmethod
def transform_validate(cls, values):
"""Add default start date."""
if values.get("is_series_group") is True:
required = ["frequency", "region_type", "units"]
for key in required:
if values.get(key) is None:
raise ValueError(
f"{key} is a required field missing for series_group."
)
values["start_date"] = (
"1900-01-01"
if values.get("start_date") is None
else values.get("start_date")
)
if values.get("is_series_group") is False:
values["start_date"] = (
None if values.get("start_date") is None else values.get("start_date")
)
return values
class FredRegionalData(SeriesData):
"""FRED Regional Data."""
__alias_dict__ = {
"date": "observation_date",
}
region: str = Field(
description="The name of the region.",
)
code: Union[str, int] = Field(
description="The code of the region.",
)
value: Optional[Union[int, float]] = Field(
default=None,
description="The obersvation value. The units are defined in the search results by series ID.",
)
series_id: str = Field(
description="The individual series ID for the region.",
)
class FredRegionalDataFetcher(
Fetcher[
FredRegionalQueryParams,
List[FredRegionalData],
]
):
"""FRED Regional Data Fetcher."""
@staticmethod
def transform_query(params: Dict[str, Any]) -> FredRegionalQueryParams:
"""Transform query."""
return FredRegionalQueryParams(**params)
@staticmethod
async def aextract_data(
query: FredRegionalQueryParams,
credentials: Optional[Dict[str, str]],
**kwargs: Any,
) -> Dict:
"""Extract the raw data."""
api_key = credentials.get("fred_api_key") if credentials else ""
if query.is_series_group:
base_url = "https://api.stlouisfed.org/geofred/regional/data?"
url = (
base_url
+ get_querystring(
query.model_dump(), ["limit", "end_date", "is_series_group"]
)
+ f"&file_type=json&api_key={api_key}"
)
else:
base_url = "https://api.stlouisfed.org/geofred/series/data?"
url = (
base_url
+ f"series_id={query.symbol}&"
+ get_querystring(
query.model_dump(),
[
"limit",
"end_date",
"region_type",
"season",
"units",
"is_series_group",
],
)
+ f"&file_type=json&api_key={api_key}"
)
return await amake_request(url) # type: ignore
@staticmethod
def transform_data(
query: FredRegionalQueryParams,
data: Dict,
**kwargs,
) -> List[FredRegionalData]:
"""Flatten the response object and validate the model."""
results: List[FredRegionalData] = []
if data.get("meta") is None:
raise EmptyDataError()
meta = {k: v for k, v in data.get("meta").items() if k not in ["data"]} # type: ignore
if meta:
_warn(json.dumps(meta))
_data = data["meta"]["data"]
keys = list(_data.keys())
units = data["meta"].get("units")
for key in keys:
_row = _data[key]
for item in _row:
item["date"] = key
item["units"] = units
if (
query.end_date is None
or datetime.strptime(key, "%Y-%m-%d").date() <= query.end_date
):
results.append(FredRegionalData.model_validate(item))
return results
|
