Objects

This module defines data classes for the FRED API responses.

class fedfred.objects.Category(id, name, parent_id=None)

Bases: object

A class used to represent a Category.

Parameters:

• id (int)

• name (str)

• parent_id (int | None)

id: int

name: str

parent_id: Optional[int] = None

classmethod to_object(response)

Parses FRED API response and returns a list of Category objects.

Return type:

List[Category]

Parameters:

response (Dict)

async classmethod to_object_async(response)

Asynchronously parses FRED API response and returns a list of Category Objects.

Return type:

List[Category]

Parameters:

response (Dict)

class fedfred.objects.Element(element_id, release_id, series_id, parent_id, line, type, name, level, children=None)

Bases: object

A class used to represent an Element.

Parameters:

• element_id (int)

• release_id (int)

• series_id (str)

• parent_id (int)

• line (str)

• type (str)

• name (str)

• level (str)

• children (List[Element] | None)

children: Optional[List[Element]] = None

element_id: int

level: str

line: str

name: str

parent_id: int

release_id: int

series_id: str

classmethod to_object(response)

Parses the FRED API response and returns a list of Elements objects.

Return type:

List[Element]

Parameters:

response (Dict)

async classmethod to_object_async(response)

Asynchronously parses the FRED API response and returns a list of Element objects.

Return type:

List[Element]

Parameters:

response (Dict)

type: str

class fedfred.objects.Release(id, realtime_start, realtime_end, name, press_release, link=None, notes=None)

Bases: object

A class used to represent a Release.

Parameters:

• id (int)

• realtime_start (str)

• realtime_end (str)

• name (str)

• press_release (bool)

• link (str | None)

• notes (str | None)

id: int

link: Optional[str] = None

name: str

notes: Optional[str] = None

press_release: bool

realtime_end: str

realtime_start: str

classmethod to_object(response)

Parses the FRED API response and returns a list of Release objects.

Return type:

List[Release]

Parameters:

response (Dict)

async classmethod to_object_async(response)

Asynchronously parses the FRED API response and returns a list of Release objects.

Return type:

List[Release]

Parameters:

response (Dict)

class fedfred.objects.ReleaseDate(release_id, date, release_name=None)

Bases: object

A class used to represent a ReleaseDate.

Parameters:

• release_id (int)

• date (str)

• release_name (str | None)

date: str

release_id: int

release_name: Optional[str] = None

classmethod to_object(response)

Parses the FRED API response and returns a list of ReleaseDate objects.

Return type:

List[ReleaseDate]

Parameters:

response (Dict)

async classmethod to_object_async(response)

Asynchronously parses the FRED API response and returns a list of ReleaseDate objects.

Return type:

List[ReleaseDate]

Parameters:

response (Dict)

class fedfred.objects.Series(id, title, observation_start, observation_end, frequency, frequency_short, units, units_short, seasonal_adjustment, seasonal_adjustment_short, last_updated, popularity, realtime_start=None, realtime_end=None, group_popularity=None, notes=None)

Bases: object

A class used to represent a Series.

Parameters:

• id (str)

• title (str)

• observation_start (str)

• observation_end (str)

• frequency (str)

• frequency_short (str)

• units (str)

• units_short (str)

• seasonal_adjustment (str)

• seasonal_adjustment_short (str)

• last_updated (str)

• popularity (int)

• realtime_start (str | None)

• realtime_end (str | None)

• group_popularity (int | None)

• notes (str | None)

frequency: str

frequency_short: str

group_popularity: Optional[int] = None

id: str

last_updated: str

notes: Optional[str] = None

observation_end: str

observation_start: str

popularity: int

realtime_end: Optional[str] = None

realtime_start: Optional[str] = None

seasonal_adjustment: str

seasonal_adjustment_short: str

title: str

classmethod to_object(response)

Parses the FRED API response and returns a list of Series objects.

Return type:

List[Series]

Parameters:

response (Dict)

async classmethod to_object_async(response)

Asynchronously parses the FRED API response and returns a list of Series objects.

Return type:

List[Series]

Parameters:

response (Dict)

units: str

units_short: str

class fedfred.objects.SeriesGroup(title, region_type, series_group, season, units, frequency, min_date, max_date)

Bases: object

A class used to represent a SeriesGroup.

Parameters:

• title (str)

• region_type (str)

• series_group (str)

• season (str)

• units (str)

• frequency (str)

• min_date (str)

• max_date (str)

frequency: str

max_date: str

min_date: str

region_type: str

season: str

series_group: str

title: str

classmethod to_object(response)

Parses the FRED API response and returns a list of SeriesGroup objects.

Return type:

List[SeriesGroup]

Parameters:

response (Dict)

async classmethod to_object_async(response)

Asynchronously parses the FRED API response and returns a list of SeriesGroup objects.

Return type:

List[SeriesGroup]

Parameters:

response (Dict)

units: str

class fedfred.objects.Source(id, realtime_start, realtime_end, name, link=None, notes=None)

Bases: object

A class used to represent a Source.

Parameters:

• id (int)

• realtime_start (str)

• realtime_end (str)

• name (str)

• link (str | None)

• notes (str | None)

id: int

link: Optional[str] = None

name: str

notes: Optional[str] = None

realtime_end: str

realtime_start: str

classmethod to_object(response)

Parses the FRED API response and returns a list of Source objects.

Return type:

List[Source]

Parameters:

response (Dict)

async classmethod to_object_async(response)

Asynchronously parses the FRED API response and returns a list of Source objects.

Return type:

List[Source]

Parameters:

response (Dict)

class fedfred.objects.Tag(name, group_id, created, popularity, series_count, notes=None)

Bases: object

A class used to represent a Tag.

Parameters:

• name (str)

• group_id (str)

• created (str)

• popularity (int)

• series_count (int)

• notes (str | None)

created: str

group_id: str

name: str

notes: Optional[str] = None

popularity: int

series_count: int

classmethod to_object(response)

Parses the FRED API response and returns a list of Tag objects.

Return type:

List[Tag]

Parameters:

response (Dict)

async classmethod to_object_async(response)

Asynchronously parses the FRED API response and returns a list of Tags objects.

Return type:

List[Tag]

Parameters:

response (Dict)

class fedfred.objects.VintageDate(vintage_date)

Bases: object

A class used to represent a VintageDate.

Parameters:

vintage_date (str)

classmethod to_object(response)

Parses the FRED API response and returns a list of VintageDate objects.

Return type:

List[VintageDate]

Parameters:

response (Dict)

async classmethod to_object_async(response)

Asynchronously parses the FRED API response and returns a list of VintageDate objects.

Return type:

List[VintageDate]

Parameters:

response (Dict)

vintage_date: str