Skip to content

Fred

You can import the module via

from quantflow.data.fred import Fred

quantflow.data.fred.Fred dataclass 

Fred(
    url="https://api.stlouisfed.org/fred",
    key=(lambda: get("FRED_API_KEY", ""))(),
)

Bases: AioHttpClient

Federal Reserve Economic Data API client

Fetch economic data from FRED_.

.. _FRED: https://fred.stlouisfed.org/

url class-attribute instance-attribute 

url = 'https://api.stlouisfed.org/fred'

key class-attribute instance-attribute 

key = field(default_factory=lambda: get("FRED_API_KEY", ""))

freq

Bases: StrEnum

Fred historical frequencies

D class-attribute instance-attribute 

D = 'd'

W class-attribute instance-attribute 

W = 'w'

BW class-attribute instance-attribute 

BW = 'bw'

M class-attribute instance-attribute 

M = 'm'

Q class-attribute instance-attribute 

Q = 'q'

SA class-attribute instance-attribute 

SA = 'sa'

A class-attribute instance-attribute 

A = 'a'

categiories async 

categiories(**kw)

Get categories

Source code in quantflow/data/fred.py 
33
34
35
async def categiories(self, **kw: Any) -> dict:
    """Get categories"""
    return await self.get_path("category", **kw)

subcategories async 

subcategories(**kw)

Get subcategories of a given category

Source code in quantflow/data/fred.py 
37
38
39
async def subcategories(self, **kw: Any) -> dict:
    """Get subcategories of a given category"""
    return await self.get_path("category/children", **kw)

series async 

series(**kw)

Get series of a given category

Source code in quantflow/data/fred.py 
41
42
43
async def series(self, **kw: Any) -> dict:
    """Get series of a given category"""
    return await self.get_path("category/series", **kw)

serie_data async 

serie_data(*, to_date=False, **kw)

Get series data frame

Source code in quantflow/data/fred.py 
45
46
47
48
49
50
51
52
async def serie_data(self, *, to_date: bool = False, **kw: Any) -> pd.DataFrame:
    """Get series data frame"""
    data = await self.get_path("series/observations", **kw)
    df = pd.DataFrame(data["observations"])
    df["value"] = pd.to_numeric(df["value"])
    if to_date and "date" in df.columns:
        df["date"] = pd.to_datetime(df["date"])
    return df

get_path async 

get_path(path, **kw)
Source code in quantflow/data/fred.py 
55
56
57
async def get_path(self, path: str, **kw: Any) -> dict:
    result = await self.get(f"{self.url}/{path}", **self.params(**kw))
    return cast(dict, result)

params 

params(params=None, **kw)
Source code in quantflow/data/fred.py 
59
60
61
62
def params(self, params: dict | None = None, **kw: Any) -> dict:
    params = params.copy() if params is not None else {}
    params.update(api_key=self.key, file_type="json")
    return {"params": params, **kw}