API Reference#

This section provides detailed, automatically generated documentation for FedFred’s modules, classes, and functions. It covers both synchronous and asynchronous clients, helper utilities, and typed object models.

All API documentation is generated from the live source code using Sphinx autodoc and autosummary.

—

API Clients#

fedfred.FredAPI(api_key[, cache_mode, ...])

The FredAPI class contains methods for interacting with the Federal Reserve Bank of St.

fedfred.AsyncAPI(parent)

The Async sub-class contains async methods for interacting with the Federal Reserve Bank of St.

fedfred.MapsAPI(parent)

The Maps sub-class contains methods for interacting with the FRED® Maps API and GeoFRED endpoints.

fedfred.AsyncMapsAPI(parent)

The AsyncMapsAPI sub-class contains async methods for interacting with the FRED® Maps API and GeoFRED endpoints.

Utility Helpers#

fedfred.helpers.FredHelpers()

A class that provides helper methods for the FRED API.

Data Objects#

fedfred.objects.Category(id, name[, parent_id])

A class used to represent a Category.

fedfred.objects.Series(id, title, ...[, ...])

A class used to represent a Series.

fedfred.objects.Tag(name, group_id, created, ...)

A class used to represent a Tag.

fedfred.objects.Release(id, realtime_start, ...)

A class used to represent a Release.

fedfred.objects.ReleaseDate(release_id, date)

A class used to represent a ReleaseDate.

fedfred.objects.Source(id, realtime_start, ...)

A class used to represent a Source.

fedfred.objects.Element(element_id, ...[, ...])

A class used to represent an Element.

fedfred.objects.VintageDate(vintage_date)

A class used to represent a VintageDate.

fedfred.objects.SeriesGroup(title, ...)

A class used to represent a SeriesGroup.

—