fedfred

A feature-rich Python package for interacting with the Federal Reserve Bank of St. Louis Economic Database (FRED).

Features

• Pandas/Polars DataFrames

• Async support

• Local caching

• Rate limiting

• Type-safe API

Table of Contents

Contents:

• Installation
  • Using pip
  • Using conda
  • Optional Type Stubs
  • Optional DataFrame Dependencies
  • Development Installation
• Quick Start Guide
  • Getting Started
  • Basic Usage
  • Async Usage
  • Working with Data
  • Searching for Series
  • Categories and Tags
  • Caching and Rate Limits
  • Geographic Data with FredMapsAPI
  • Common Economic Indicators
• Usage Examples
  • Basic Usage Examples
    • Initializing the API Client
    • Fetching a Time Series
    • Fetching Metadata for a Series
    • Exploring Categories
    • Fetching Tags for a Series
    • Fetching Related Series
  • Advanced Usage Examples
    • Caching and Rate Limiting
    • Concurrent Requests with AsyncAPI
    • Working with Geographic Data
    • Customizing API Requests
    • Exploring Categories and Tags
    • Error Handling and Validation
  • Data Visualization Examples
    • Line Plot of Time Series Data
    • Bar Plot of Category Data
    • Heatmap of Correlations
    • Geographic Visualization with GeoPandas
• API Reference
  • 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()
• Contributing to FedFred
  • Table of Contents
  • How to Contribute
    • Reporting Issues
  • Static Analysis
    • Submitting Code Changes
    • Coding Standards
    • Code Quality and Warnings
    • Testing
      • Testing with Assertions
    • Documentation
    • License
    • Contact
    • Security Vulnerability Reporting
    • Code of Conduct
    • Development Setup
    • Pull Request Process
    • Continuous Integration
    • Dynamic Analysis
      • Property-Based Testing with Hypothesis
      • Running Dynamic Analysis Tests
    • Release Process
  • Governance Model
• Changelog
  • Unreleased
  • 2.0.9 - 2025-04-14 (PUBLISHING FIX)
  • 2.0.8 - 2025-04-14 (YANKED)
  • 2.0.7 - 2025-04-14 (YANKED)
  • 2.0.6 - 2025-04-14 (YANKED)
  • 2.0.5 - 2025-04-14 (YANKED)
  • 2.0.4 - 2025-04-14 (YANKED)
  • 2.0.3 - 2025-04-14 (YANKED)
  • 2.0.2 - 2025-04-14 (YANKED)
  • 2.0.1 - 2025-04-14 (YANKED)
  • 2.0.0 - 2025-04-14
    • Added
    • Removed
    • Fixed
  • 1.2.9 - 2025-03-20
    • Added
    • Changed
  • 1.2.8 - 2025-03-20
    • Changed
  • 1.2.7 - 2025-03-20
    • Added
    • Changed
    • Removed
  • 1.2.6 - 2025-03-19
    • Fixed
  • 1.2.5 - 2025-03-19
    • Fixed
  • 1.2.4 - 2025-03-19
    • Changed
    • Fixed
  • 1.2.3 - 2025-03-19
    • Fixed
  • 1.2.2 - 2025-03-19
    • Added
    • Changed
  • 1.2.1 - 2025-03-15
    • Added
  • 1.2.0 - 2025-03-14
    • Added
    • Fixed
    • Deprecated
  • 1.1.0 - 2025-03-12
    • Added
    • Changed
    • Removed
    • Fixed
  • 1.0.26 - 2025-03-11
    • Fixed
  • 1.0.25 - 2025-03-11 (YANKED RELEASE)
    • Fixed
  • 1.0.24 - 2025-03-11 (YANKED RELEASE)
    • Fixed
  • 1.0.23 - 2025-03-11 (YANKED RELEASE)
    • Fixed
  • 1.0.22 - 2025-03-11 (YANKED RELEASE)
    • Fixed
  • 1.0.21 - 2025-03-11 (YANKED RELEASE)
    • Fixed
  • 1.0.20 - 2025-03-11 (YANKED RELEASE)
    • Fixed
  • 1.0.19 - 2025-03-11 (YANKED RELEASE)
    • Fixed
  • 1.0.18 - 2025-03-11 (YANKED RELEASE)
    • Fixed
  • 1.0.17 - 2025-03-11 (YANKED RELEASE)
    • Fixed
  • 1.0.16 - 2025-03-11 (YANKED RELEASE)
    • Fixed
  • 1.0.15 - 2025-03-10 (YANKED RELEASE)
    • Fixed
  • 1.0.14 - 2025-03-10 (YANKED RELEASE)
    • Fixed
  • 1.0.13 - 2025-03-10 (YANKED RELEASE)
    • Fixed
  • 1.0.12 - 2025-03-10 (YANKED RELEASE)
    • Fixed
  • 1.0.11 - 2025-03-10 (YANKED RELEASE)
    • Fixed
  • 1.0.10 - 2025-03-10 (YANKED RELEASE)
    • Fixed
  • 1.0.9 - 2025-03-10 (YANKED RELEASE)
    • Fixed
  • 1.0.8 - 2025-03-10 (YANKED RELEASE)
    • Fixed
  • 1.0.7 - 2025-03-10 (YANKED RELEASE)
    • Fixed
  • [1.0.6] - 2025-03-10 (YANKED RELEASE)
    • Fixed
  • 1.0.5 - 2025-03-10 (YANKED RELEASE)
    • Fixed
  • 1.0.4 - 2025-03-10 (YANKED RELEASE)
    • Fixed
  • 1.0.3 - 2025-03-10 (YANKED RELEASE)
    • Fixed
  • 1.0.2 - 2025-03-10 (YANKED RELEASE)
    • Fixed
  • 1.0.1 - 2025-03-10 (YANKED RELEASE)
    • Fixed
  • 1.0.0 - 2025-03-10
    • Added
    • Changed
    • Removed
    • Fixed
  • 0.0.7 - 2025-01-29
    • Changed
  • [0.0.6] - 2025-01-29 (DELETED RELEASE)
    • Fixed
  • 0.0.5 - 2025-01-29
    • Added
    • Changed
  • 0.0.4 - 2025-01-29
    • Changed
    • Added
  • 0.0.3 - 2025-01-19
    • Added
  • 0.0.2 - 2025-01-17
    • Added
  • [0.0.1] - 2025-01-16 (DELETED RELEASE)
    • Added
• Code of Conduct
  • Contributor Covenant Code of Conduct
    • Our Pledge
    • Our Standards
    • Enforcement Responsibilities
    • Scope
    • Enforcement
    • Enforcement Guidelines
      • 1. Correction
      • 2. Warning
      • 3. Temporary Ban
      • 4. Permanent Ban
    • Attribution
• Security Policy
  • Table of Contents
  • Current Vulnerability Status
  • Reporting a Vulnerability
  • Response Process
  • Disclosure Policy
  • Supported Versions
  • Common Vulnerabilities and Mitigations
    • API Client-Specific Vulnerabilities
    • General Python Vulnerabilities
  • Security Measures
  • Security-Related Configuration
  • Third-Party Security Dependencies
  • Secure Software Delivery
    • PyPI (Python Package Index)
    • Anaconda (conda-forge)
    • GitHub Releases
  • Verifying Package Signatures
  • Security Updates and Announcements
  • Security Design Principles
• License