FredHelpers

class fedfred.helpers.FredHelpers

Bases: object

A class that provides helper methods for the FRED API.

Methods

FredHelpers.__init__
FredHelpers.datestring_validation	Helper method to validate date-string formatted parameters.
FredHelpers.datestring_validation_async	Helper method to validate date-string formatted parameter asynchronously.
FredHelpers.datetime_conversion	Helper method to convert a datetime object to a string in YYYY-MM-DD format.
FredHelpers.datetime_conversion_async	Helper method to convert a datetime object to a string in YYYY-MM-DD format asynchronously.
FredHelpers.datetime_hh_mm_conversion	Helper method to convert a datetime object to a string in HH:MM format.
FredHelpers.datetime_hh_mm_conversion_async	Helper method to convert a datetime object to a string in HH:MM format asynchronously.
FredHelpers.extract_region_type	Helper method to extract the region type from a GeoFred response dict.
FredHelpers.extract_region_type_async	Helper method to extract the region type from a GeoFred response dictionary asynchronously.
FredHelpers.geo_parameter_validation	Helper method to validate parameters prior to making a get request.
FredHelpers.geo_parameter_validation_async	Helper method to validate parameters prior to making a get request.
FredHelpers.hh_mm_datestring_validation	Helper method to validate hh:mm formatted parameters.
FredHelpers.hh_mm_datestring_validation_async	Helper method to validate hh:mm formatted parameters asynchronously.
FredHelpers.liststring_conversion	Helper method to convert a list of strings to a semicolon-separated string.
FredHelpers.liststring_conversion_async	Helper method to convert a list of strings to a semicolon-separated string asynchronously.
FredHelpers.liststring_validation	Helper method to validate list-string formatted parameters.
FredHelpers.liststring_validation_async	Helper method to validate list-string formatted parameters asynchronously.
FredHelpers.parameter_validation	Helper method to validate parameters prior to making a get request.
FredHelpers.parameter_validation_async	Helper method to validate parameters prior to making a get request asynchronously.
FredHelpers.pd_frequency_conversion	Convert fedfred native frequency strings to pandas compatible ones.
FredHelpers.pd_frequency_conversion_async	Asynchronously convert fedfred native frequency strings to pandas compatible ones.
FredHelpers.to_dd_df	Helper method to convert a FRED observation dictionary to a Dask DataFrame.
FredHelpers.to_dd_df_async	Helper method to convert a FRED observation dictionary to a Dask DataFrame asynchronously.
FredHelpers.to_dd_gpd_gdf	Helper method to convert a FRED observation dictionary to a Dask GeoPandas GeoDataFrame.
FredHelpers.to_dd_gpd_gdf_async	Helper method to convert a FRED observation dictionary to a Dask GeoPandas GeoDataFrame asynchronously.
FredHelpers.to_gpd_gdf	Helper method to convert a fred observation dictionary to a GeoPandas GeoDataFrame.
FredHelpers.to_gpd_gdf_async	Helper method to convert a FRED observation dictionary to a GeoPandas GeoDataFrame asynchronously.
FredHelpers.to_pd_df	Helper method to convert a fred observation dictionary to a Pandas DataFrame.
FredHelpers.to_pd_df_async	Helper method to convert a FRED observation dictionary to a Pandas DataFrame asynchronously.
FredHelpers.to_pd_series	Accepts a Series or a DataFrame with 'date' and 'value' columns and returns a float Series with DatetimeIndex and the given name.
FredHelpers.to_pd_series_async	Asynchronously accepts a Series or a DataFrame with 'date' and 'value' columns (fedfred style) and returns a float Series with DatetimeIndex and the given name.
FredHelpers.to_pl_df	Helper method to convert a fred observation dictionary to a Polars DataFrame.
FredHelpers.to_pl_df_async	Helper method to convert a FRED observation dictionary to a Polars DataFrame asynchronously.
FredHelpers.to_pl_st_gdf	Helper method to convert a FRED observation dictionary to a Polars GeoDataFrame.
FredHelpers.to_pl_st_gdf_async	Helper method to convert a FRED observation dictionary to a Polars GeoDataFrame asynchronously.
FredHelpers.vintage_dates_type_conversion	Helper method to convert a vintage_dates parameter to a string.
FredHelpers.vintage_dates_type_conversion_async	Helper method to convert a vintage_dates parameter to a string asynchronously.
FredHelpers.vintage_dates_validation	Helper method to validate vintage_dates parameters.
FredHelpers.vintage_dates_validation_async	Helper method to validate vintage_dates parameters asynchronously.