Changelog

Version 0.10.2 - 2025-07-27

Changed

• Bumped version number to 0.10.2 because pypi won't allow the reuse of already published version numbers.

Version 0.10.1 - 2025-07-27

Fixed

• Fixed bug where MISSING_PLOTLY flag was not defined when plotly is installed.

Version 0.10.0 - 2025-07-26

Added

• Support for polars as a return format.

Fixed

• Fixed misspelling of ascending literal type. Changed to 'asc'. (#38)

Removed

• Removed dependency on numpy. (#39)

Version 0.9.1 - 2024-11-02

Removed

• Dependency on frozendict package.

Version 0.9.0 - 2024-09-28

Added

• Added .data attribute to SeriesCollection.
• Added series_info_to_df() method to SeriesCollection.
• Official support for Python 3.12.

Changed

• Bumped pydantic version to >=2.
• Updated pandas version to >=1.0.0,<3.0.0.
• Updated numpy version to >=1.0.0,<2.0.0.

Version 0.8.0 - 2023-04-27

Changed

• Make series_id a required parameter for SeriesCollection().

Version 0.7.1 - 2023-04-27

Fixed

• Import error in SeriesCollection when plotly is not installed.
• Updated dev dependencies to include plotly.

Version 0.7.0 - 2023-04-27

Changed

• Refactor SeriesCollection's internal structure to represent a sequence.
• Updated __init__ to handle adding the initial set of series.
• SeriesCollection is now iterable, indexable, and sized.
• Renamed add_series() to add().
• Renamed drop_series() to remove().
• Updated the docstring for api_key parameter.
• When data is converted to a pandas dataframe, the created attribute will be cast a date-type column.
• Added sleep parameter to SeriesCollection.add_series. Defaults to 0.1 seconds.
• Added upper bound to dependency versions.
• Made plotly an optional dependency.

Removed

• Unnecessary type ignore comments.
• .flake8 config file.

Version 0.6.0 - 2023-04-22

Changed

• Switched to the Hatch build tool.
• Bumped copyright year to 2023.
• Renamed APIKeyNotFoundError exception to APIKeyNotFound.
• Updated the bug report github issue template.

Version 0.5.4 - 2022-04-16

Changed

• Loosened the dependency package versions to >= latest major version.

Version 0.5.3 - 2022-04-02

Changed

• Added @lru_cache decorator to _get_request and _get_api_key.
• Upgraded project to poetry 1.4.0.

Version 0.5.2 - 2023-03-30

Fixed

• Typos and errors in the documentation.
• Add timeouts to API requests.

Changed

• Updated dependencies to latest versions.
• Updated the linting suite to ruff.

Version 0.5.1 - 2022-11-05

Added

• Support for python 3.11.

Removed

• Github actions for building docs.

Version 0.5.0 - 2022-10-26

This release introduces breaking changes. The pyfredapi API has been refactored to use functions rather than class methods.

Added

• CONTRIBUTING.md.

Changed

• Refactored the API into functions. Each FRED API endpoint now has an associated function rather than being attached to a class. All tests and docs have been updated to reflect this change.
• Moved SeriesData to the SeriesCollection module. get_series now only returns series data. To get both series data and series info in one object, use a SeriesCollection.

Fixed

• Broken formatting in the sphinx autodocs API reference.

Version 0.4.1 - 2022-10-20

Changed

• Updated pydantic base model classes to accept extra parameters.
• Updated SeriesData.plot x-axis label to include units.
• Tweak docs formatting to adapt to sphinx_material theme.

Version 0.4.0 - 2022-10-19

Added

• SeriesCollection class, test, and docs.
• plot function to SeriesData.
• Docstring to the top of all API modules.

Changed

• Sphinx docs theme to sphinx_material.
• Removed 'dev' install group to make dependencies DRY.
• Sonarcloud config to generate main branch statistics.

Version 0.3.0 - 2022-10-11

Added

• Methods and tests for FredRelease, FredTags, and FredSource.
• py.typed file.
• Pull request template.
• GitHub actions workflows for sonarcloud, linting, and testing.

Changed

• Updates SeriesInfo's notes field to be optional.
• Added sort_order parameter to SeriesSearchParameters.
• Updates to the README.md.
• Updates to the documentation.

Version 0.2.0 - 2022-09-27

Added

• SeriesData class for the get_series methods. SeriesData holds both the data and the metadata for a given series.
• Unit tests for FredSeries method,
• vcr pytest fixture to unit tests. vcr records the http interactions with the FRED API. Speeds up unit tests significantly and reduces the requests made to the FRED API.
• FredMaps class and tests.

Changed

• Switch license to MIT.
• Updates FredCategory & FredSeries method docstrings to fix typos, add missing parameters, and add links to the FRED endpoint documentation.
• When returning data as a pandas dataframe, process the data so that date and numeric columns are the correct data type.
• Renamed methods in FredSeries
• get_series_data -> get_series
• get_series_data_all_releases -> get_series_all_releases
• get_series_data_initial_release -> get_series_initial_release
• get_series_data_asof_date -> get_series_asof_date
• Rename BaseApiArgs to BaseApiParameters.
• Rename CategoryArgs to CategoryApiParameters.
• Rename SeriesArgs to SeriesApiParameters.

Fixed

• Install instructions.
• pydantic dependency.
• FredSeries.get_series_releases endpoint.
• Removed series_id from SeriesArgs.

Version 0.1.0 - 2022-09-25

Note: This version has been deleted from Python Package Index.

Initial release of pyfredapi package.

Added

• FredApi class.
• FredCategory class.
• FredSeries class.
• FredMaps stub.
• FredSources stub.
• FredTags stub.
• Sphinx docs.