API Reference

This section provides detailed API documentation for fedfred’s classes and functions.

• FredAPI Class
  • FredAPI
    • FredAPI.get_category()
    • FredAPI.get_category_children()
    • FredAPI.get_category_related()
    • FredAPI.get_category_related_tags()
    • FredAPI.get_category_series()
    • FredAPI.get_category_tags()
    • FredAPI.get_related_tags()
    • FredAPI.get_release()
    • FredAPI.get_release_dates()
    • FredAPI.get_release_related_tags()
    • FredAPI.get_release_series()
    • FredAPI.get_release_sources()
    • FredAPI.get_release_tables()
    • FredAPI.get_release_tags()
    • FredAPI.get_releases()
    • FredAPI.get_releases_dates()
    • FredAPI.get_series()
    • FredAPI.get_series_categories()
    • FredAPI.get_series_observations()
    • FredAPI.get_series_release()
    • FredAPI.get_series_search()
    • FredAPI.get_series_search_related_tags()
    • FredAPI.get_series_search_tags()
    • FredAPI.get_series_tags()
    • FredAPI.get_series_updates()
    • FredAPI.get_series_vintagedates()
    • FredAPI.get_source()
    • FredAPI.get_source_releases()
    • FredAPI.get_sources()
    • FredAPI.get_tags()
    • FredAPI.get_tags_series()
• MapsAPI Class
  • MapsAPI
    • MapsAPI.get_regional_data()
    • MapsAPI.get_series_data()
    • MapsAPI.get_series_group()
    • MapsAPI.get_shape_files()
• AsyncAPI Class
  • AsyncAPI
    • AsyncAPI.get_category()
    • AsyncAPI.get_category_children()
    • AsyncAPI.get_category_related()
    • AsyncAPI.get_category_related_tags()
    • AsyncAPI.get_category_series()
    • AsyncAPI.get_category_tags()
    • AsyncAPI.get_related_tags()
    • AsyncAPI.get_release()
    • AsyncAPI.get_release_dates()
    • AsyncAPI.get_release_related_tags()
    • AsyncAPI.get_release_series()
    • AsyncAPI.get_release_sources()
    • AsyncAPI.get_release_tables()
    • AsyncAPI.get_release_tags()
    • AsyncAPI.get_releases()
    • AsyncAPI.get_releases_dates()
    • AsyncAPI.get_series()
    • AsyncAPI.get_series_categories()
    • AsyncAPI.get_series_observations()
    • AsyncAPI.get_series_release()
    • AsyncAPI.get_series_search()
    • AsyncAPI.get_series_search_related_tags()
    • AsyncAPI.get_series_search_tags()
    • AsyncAPI.get_series_tags()
    • AsyncAPI.get_series_updates()
    • AsyncAPI.get_series_vintagedates()
    • AsyncAPI.get_source()
    • AsyncAPI.get_source_releases()
    • AsyncAPI.get_sources()
    • AsyncAPI.get_tags()
    • AsyncAPI.get_tags_series()
• AsyncMapsAPI Class
  • AsyncMapsAPI
    • AsyncMapsAPI.get_regional_data()
    • AsyncMapsAPI.get_series_data()
    • AsyncMapsAPI.get_series_group()
    • AsyncMapsAPI.get_shape_files()
• Objects
  • Category
    • Category.id
    • Category.name
    • Category.parent_id
    • Category.to_object()
    • Category.to_object_async()
  • Element
    • Element.children
    • Element.element_id
    • Element.level
    • Element.line
    • Element.name
    • Element.parent_id
    • Element.release_id
    • Element.series_id
    • Element.to_object()
    • Element.to_object_async()
    • Element.type
  • Release
    • Release.id
    • Release.link
    • Release.name
    • Release.notes
    • Release.press_release
    • Release.realtime_end
    • Release.realtime_start
    • Release.to_object()
    • Release.to_object_async()
  • ReleaseDate
    • ReleaseDate.date
    • ReleaseDate.release_id
    • ReleaseDate.release_name
    • ReleaseDate.to_object()
    • ReleaseDate.to_object_async()
  • Series
    • Series.frequency
    • Series.frequency_short
    • Series.group_popularity
    • Series.id
    • Series.last_updated
    • Series.notes
    • Series.observation_end
    • Series.observation_start
    • Series.popularity
    • Series.realtime_end
    • Series.realtime_start
    • Series.seasonal_adjustment
    • Series.seasonal_adjustment_short
    • Series.title
    • Series.to_object()
    • Series.to_object_async()
    • Series.units
    • Series.units_short
  • SeriesGroup
    • SeriesGroup.frequency
    • SeriesGroup.max_date
    • SeriesGroup.min_date
    • SeriesGroup.region_type
    • SeriesGroup.season
    • SeriesGroup.series_group
    • SeriesGroup.title
    • SeriesGroup.to_object()
    • SeriesGroup.to_object_async()
    • SeriesGroup.units
  • Source
    • Source.id
    • Source.link
    • Source.name
    • Source.notes
    • Source.realtime_end
    • Source.realtime_start
    • Source.to_object()
    • Source.to_object_async()
  • Tag
    • Tag.created
    • Tag.group_id
    • Tag.name
    • Tag.notes
    • Tag.popularity
    • Tag.series_count
    • Tag.to_object()
    • Tag.to_object_async()
  • VintageDate
    • VintageDate.to_object()
    • VintageDate.to_object_async()
    • VintageDate.vintage_date
• Helpers
  • FredHelpers
    • FredHelpers.datetime_conversion()
    • FredHelpers.datetime_conversion_async()
    • FredHelpers.datetime_hh_mm_conversion()
    • FredHelpers.datetime_hh_mm_conversion_async()
    • FredHelpers.extract_region_type()
    • FredHelpers.extract_region_type_async()
    • FredHelpers.liststring_conversion()
    • FredHelpers.liststring_conversion_async()
    • FredHelpers.parameter_validation()
    • FredHelpers.parameter_validation_async()
    • FredHelpers.to_dd_df()
    • FredHelpers.to_dd_df_async()
    • FredHelpers.to_dd_gpd_gdf()
    • FredHelpers.to_dd_gpd_gdf_async()
    • FredHelpers.to_gpd_gdf()
    • FredHelpers.to_gpd_gdf_async()
    • FredHelpers.to_pd_df()
    • FredHelpers.to_pd_df_async()
    • FredHelpers.to_pl_df()
    • FredHelpers.to_pl_df_async()
    • FredHelpers.to_pl_st_gdf()
    • FredHelpers.to_pl_st_gdf_async()
    • FredHelpers.vintage_dates_type_conversion()
    • FredHelpers.vintage_dates_type_conversion_async()