mirror of
https://github.com/OpenBB-finance/OpenBB.git
synced 2026-10-31 22:41:19 +00:00
4400cd9a8f
* small changes - moving provider inside the core * uptade readme * lint * remove old provider readme * leftovers * refactor website examples * ruff * fix nox * relock * fix fails_to_deliver headers * fix for tests that have renamed endpoints * fix discovery * removed test for renamed endpoint * fix broken syntax - test_search_financial_attributes * fix cash/income/balance * fix derivatives tests * fix etf tests * fix news tests * fix regulators * black * wrong test param * sort equity gainers/losers by percent * platform markdown generation import * Hotfix/fix int tests core merge (#5779) * removing tests on old endpoint * removing visualization on old endpoint * fixing equity tests * fixing examples * fix news tests * fix index test * example * add comments * example --------- Co-authored-by: Diogo Sousa <montezdesousa@gmail.com> --------- Co-authored-by: montezdesousa <79287829+montezdesousa@users.noreply.github.com> Co-authored-by: Diogo Sousa <montezdesousa@gmail.com> Co-authored-by: Danglewood <85772166+deeleeramone@users.noreply.github.com> Co-authored-by: Pratyush Shukla <ps4534@nyu.edu>
81 lines
2.8 KiB
Python
81 lines
2.8 KiB
Python
"""FRED Consumer Price Index Model."""
|
|
|
|
from typing import Any, Dict, List, Optional
|
|
|
|
from openbb_core.provider.abstract.fetcher import Fetcher
|
|
from openbb_core.provider.standard_models.cpi import (
|
|
ConsumerPriceIndexData,
|
|
ConsumerPriceIndexQueryParams,
|
|
)
|
|
from openbb_fred.utils.fred_base import Fred
|
|
from openbb_fred.utils.fred_helpers import all_cpi_options
|
|
|
|
|
|
class FREDConsumerPriceIndexQueryParams(ConsumerPriceIndexQueryParams):
|
|
"""FRED Consumer Price Index Query."""
|
|
|
|
|
|
class FREDConsumerPriceIndexData(ConsumerPriceIndexData):
|
|
"""FRED Consumer Price Index Data."""
|
|
|
|
|
|
class FREDConsumerPriceIndexFetcher(
|
|
Fetcher[FREDConsumerPriceIndexQueryParams, List[FREDConsumerPriceIndexData]]
|
|
):
|
|
"""Transform the query, extract and transform the data from the FRED endpoints."""
|
|
|
|
@staticmethod
|
|
def transform_query(params: Dict[str, Any]) -> FREDConsumerPriceIndexQueryParams:
|
|
"""Transform query."""
|
|
return FREDConsumerPriceIndexQueryParams(**params)
|
|
|
|
@staticmethod
|
|
def extract_data(
|
|
query: FREDConsumerPriceIndexQueryParams,
|
|
credentials: Optional[Dict[str, str]],
|
|
**kwargs: Any,
|
|
) -> Dict:
|
|
"""Extract data."""
|
|
api_key = credentials.get("fred_api_key") if credentials else ""
|
|
|
|
all_options = all_cpi_options(query.harmonized)
|
|
|
|
step_1 = [x for x in all_options if x["country"] in query.countries]
|
|
step_2 = [x for x in step_1 if x["units"] == query.units]
|
|
step_3 = [x for x in step_2 if x["frequency"] == query.frequency]
|
|
|
|
series_dict = {}
|
|
fred = Fred(api_key)
|
|
for item in step_3:
|
|
loc = f"{item['country']}"
|
|
temp = fred.get_series(
|
|
item["series_id"], query.start_date, query.end_date, **kwargs
|
|
)
|
|
temp = [{"date": item["date"], "value": item["value"]} for item in temp]
|
|
series_dict[loc] = [item for item in temp if item["value"] != "."]
|
|
|
|
return series_dict
|
|
|
|
@staticmethod
|
|
def transform_data(
|
|
query: FREDConsumerPriceIndexQueryParams, data: Dict, **kwargs: Any
|
|
) -> List[FREDConsumerPriceIndexData]:
|
|
"""Transform data."""
|
|
transformed_data = {}
|
|
|
|
# Iterate over the series_dict
|
|
for country, data_list in data.items():
|
|
for item in data_list:
|
|
# If the date is not in the dictionary, add it
|
|
if item["date"] not in transformed_data:
|
|
transformed_data[item["date"]] = {"date": item["date"]}
|
|
# Update the dictionary with the country's value data
|
|
transformed_data[item["date"]].update({country: item["value"]})
|
|
|
|
# Convert the dictionary to a list of dictionaries
|
|
transformed_data = list(transformed_data.values())
|
|
|
|
return [
|
|
FREDConsumerPriceIndexData.model_validate(item) for item in transformed_data
|
|
]
|