FRED (fred_client v0.1.1)

Summary

Functions

Get a category from the FRED API

Get a category's children from the FRED API

Get a category's related from the FRED API

Get a category's related tags from the FRED API

Get a category's series from the FRED API

Get a category's tags from the FRED API

Get the related FRED tags for one or more FRED tags.

Get a release of economic data.

Get release dates for a release of economic data.

Get the related tags for one or more FRED tags within a release of economic data.

Get the series on a release of economic data.

Get the sources for a release of economic data.

Get release table trees for a given release.

Get the tags for a release of economic data.

Get all releases of economic data.

Get release dates for all releases of economic data.

Get an economic data series.

Get the categories for an economic data series.

Get the observations or data values for an economic data series.

Get the release for an economic data series.

Get economic data series that match search text.

Get the related tags for one or more tags.

Get the tags for a series search.

Get the sources for a series search.

Get economic data series sorted by when observations were updated on the FRED® server.

Get the dates in history when a series' data values were revised or new data values were released.

Get a source of economic data.

Get the releases for a source.

Get all sources of economic data.

Get FRED tags.

Get the series matching all tags.

Functions

Link to this function

category(category_id)

Get a category from the FRED API

Required

  • category_id The id for a category
Link to this function

category_children(category_id, opts \\ [])

Get a category's children from the FRED API

Required

  • category_id The id for a category

Optional

  • realtime_start The start of the real-time period. (YYYY-MM-DD)
  • realtime_end The end of the real-time period. (YYYY-MM-DD)
Link to this function

category_related(category_id, opts \\ [])

Get a category's related from the FRED API

Required

  • category_id The id for a category

Optional

  • realtime_start The start of the real-time period. (YYYY-MM-DD)
  • realtime_end The end of the real-time period. (YYYY-MM-DD)
Link to this function

category_series(category_id, opts \\ [])

Get a category's series from the FRED API

Required

  • category_id The id for a category

Optional

  • realtime_start The start of the real-time period. (YYYY-MM-DD)
  • realtime_end The end of the real-time period. (YYYY-MM-DD)
  • limit The maximum number of results to return.
  • offset The number of results to skip
  • order_by Order results by values of the specified attribute.
  • sort_order Sort results is ascending or descending order for attribute values specified by order_by.
  • filter_variable The attribute to filter results by.
  • filter_value The value of the filter_variable attribute to filter results by.
  • tag_names A semicolon delimited list of tag names that series match all of.
  • exclude_tag_names A semicolon delimited list of tag names that series match none of.
Link to this function

category_tags(category_id, opts \\ [])

Get a category's tags from the FRED API

Required

  • category_id The id for a category

Optional

  • realtime_start The start of the real-time period. (YYYY-MM-DD)
  • realtime_end The end of the real-time period. (YYYY-MM-DD)
  • tag_names A semicolon delimited list of tag names to only include in the response.
  • tag_group_id A tag group id to filter tags by type.
  • search_text The words to find matching tags with.
  • limit The maximum number of results to return.
  • offset The number of results to skip
  • order_by Order results by values of the specified attribute.
  • sort_order Sort results is ascending or descending order for attribute values specified by order_by.
Link to this function

release(release_id, opts \\ [])

Get a release of economic data.

Required

  • release_id The id for a release

Optional

  • realtime_start The start of the real-time period. (YYYY-MM-DD)
  • realtime_end The end of the real-time period. (YYYY-MM-DD)
Link to this function

release_dates(release_id, opts \\ [])

Get release dates for a release of economic data.

Required

  • release_id The id for a release

Optional

  • realtime_start The start of the real-time period. (YYYY-MM-DD)
  • realtime_end The end of the real-time period. (YYYY-MM-DD)
  • limit The maximum number of results to return.
  • offset The number of results to skip
  • order_by Order results by values of the specified attribute.
  • sort_order Sort results is ascending or descending order for attribute values specified by order_by.
  • include_release_dates_with_no_data Determines whether release dates with no data available are returned.
Link to this function

release_series(release_id, opts \\ [])

Get the series on a release of economic data.

Required

  • release_id The id for a release

Optional

  • realtime_start The start of the real-time period. (YYYY-MM-DD)
  • realtime_end The end of the real-time period. (YYYY-MM-DD)
  • limit The maximum number of results to return.
  • offset The number of results to skip
  • order_by Order results by values of the specified attribute.
  • sort_order Sort results is ascending or descending order for attribute values specified by order_by.
  • filter_variable The attribute to filter results by.
  • filter_value The value of the filter_variable attribute to filter results by.
  • tag_names A semicolon delimited list of tag names that series match all of.
  • exclude_tag_names A semicolon delimited list of tag names that series match none of.
Link to this function

release_sources(release_id, opts \\ [])

Get the sources for a release of economic data.

Required

  • release_id The id for a release

Optional

  • realtime_start The start of the real-time period. (YYYY-MM-DD)
  • realtime_end The end of the real-time period. (YYYY-MM-DD)
Link to this function

release_tables(release_id, opts \\ [])

Get release table trees for a given release.

Required

  • release_id The id for a release

Optional

  • element_id The id for an element
  • include_observation_values A flag to indicate that observations need to be returned.
  • observation_date The observation date to be included with the returned release table.
Link to this function

release_tags(release_id, opts \\ [])

Get the tags for a release of economic data.

Required

  • release_id The id for a release

Optional

  • realtime_start The start of the real-time period. (YYYY-MM-DD)
  • realtime_end The end of the real-time period. (YYYY-MM-DD)
  • tag_group_id A tag group id to filter tags by type.
  • search_text The words to find matching tags with.
  • limit The maximum number of results to return.
  • offset The number of results to skip
  • order_by Order results by values of the specified attribute.
  • sort_order Sort results is ascending or descending order for attribute values specified by order_by.
Link to this function

releases(opts \\ [])

Get all releases of economic data.

Optional

  • realtime_start The start of the real-time period. (YYYY-MM-DD)
  • realtime_end The end of the real-time period. (YYYY-MM-DD)
  • limit The maximum number of results to return.
  • offset The number of results to skip
  • order_by Order results by values of the specified attribute.
  • sort_order Sort results is ascending or descending order for attribute values specified by order_by.
Link to this function

releases_dates(opts \\ [])

Get release dates for all releases of economic data.

Optional

  • realtime_start The start of the real-time period. (YYYY-MM-DD)
  • realtime_end The end of the real-time period. (YYYY-MM-DD)
  • limit The maximum number of results to return.
  • offset The number of results to skip
  • order_by Order results by values of the specified attribute.
  • sort_order Sort results is ascending or descending order for attribute values specified by order_by.
  • include_release_dates_with_no_data Determines whether release dates with no data available are returned.
Link to this function

series(series_id, opts \\ [])

Get an economic data series.

Required

  • series_id The id for a series

Optional

  • realtime_start The start of the real-time period. (YYYY-MM-DD)
  • realtime_end The end of the real-time period. (YYYY-MM-DD)
Link to this function

series_categories(series_id, opts \\ [])

Get the categories for an economic data series.

Required

  • series_id The id for a series

Optional

  • realtime_start The start of the real-time period. (YYYY-MM-DD)
  • realtime_end The end of the real-time period. (YYYY-MM-DD)
Link to this function

series_observations(series_id, opts \\ [])

Get the observations or data values for an economic data series.

Required

  • series_id The id for a series

Optional

  • realtime_start The start of the real-time period. (YYYY-MM-DD)
  • realtime_end The end of the real-time period. (YYYY-MM-DD)
  • limit The maximum number of results to return.
  • offset The number of results to skip
  • sort_order Sort results is ascending or descending order for attribute values specified by order_by.
  • observation_start The start of the observation period. (YYYY-MM-DD)
  • observation_end The end of the observation period. (YYYY-MM-DD)
  • units A key that indicates a data value transformation.
  • frequency An indicator of the frequency of an observation.
  • aggregation_method A key that indicates the aggregation method used for frequency aggregation.
  • output_type An integer that indicates an output type.
  • vintage_dates A comma separated string of YYYY-MM-DD formatted dates in history (e.g. 2000-01-01,2005-02-24).
Link to this function

series_release(series_id, opts \\ [])

Get the release for an economic data series.

Required

  • series_id The id for a series

Optional

  • realtime_start The start of the real-time period. (YYYY-MM-DD)
  • realtime_end The end of the real-time period. (YYYY-MM-DD)
Link to this function

series_search(search_text, opts \\ [])

Get economic data series that match search text.

Required

  • search_text The words to match against economic data series.

Optional

  • search_type Determines the type of search to perform.
  • realtime_start The start of the real-time period. (YYYY-MM-DD)
  • realtime_end The end of the real-time period. (YYYY-MM-DD)
  • limit The maximum number of results to return.
  • offset The number of results to skip
  • order_by Order results by values of the specified attribute.
  • sort_order Sort results is ascending or descending order for attribute values specified by order_by.
  • filter_variable The attribute to filter results by.
  • filter_value The value of the filter_variable attribute to filter results by.
  • tag_names A semicolon delimited list of tag names to match against.
  • exclude_tag_names A semicolon delimited list of tag names to exclude from the returned data series.
Link to this function

series_search_tags(series_search_text, opts \\ [])

Get the tags for a series search.

Required

  • series_search_text The words to match against economic data series.

Optional

  • realtime_start The start of the real-time period. (YYYY-MM-DD)
  • realtime_end The end of the real-time period. (YYYY-MM-DD)
  • tag_names A semicolon delimited list of tag names to only include in the response.
  • tag_group_id A tag group id to filter tags by type.
  • tag_search_text The words to find matching tags with.
  • limit The maximum number of results to return.
  • offset The number of results to skip
  • order_by Order results by values of the specified attribute.
  • sort_order Sort results is ascending or descending order for attribute values specified by order_by.
Link to this function

series_tags(series_id, opts \\ [])

Get the sources for a series search.

Required

  • series_id The id for a series

Optional

  • realtime_start The start of the real-time period. (YYYY-MM-DD)
  • realtime_end The end of the real-time period. (YYYY-MM-DD)
  • order_by Order results by values of the specified attribute.
  • sort_order Sort results is ascending or descending order for attribute values specified by order_by.
Link to this function

series_updates(opts \\ [])

Get economic data series sorted by when observations were updated on the FRED® server.

Optional

  • realtime_start The start of the real-time period. (YYYY-MM-DD)
  • realtime_end The end of the real-time period. (YYYY-MM-DD)
  • limit The maximum number of results to return.
  • offset The number of results to skip
  • filter_value Limit results by geographic type of economic data series; namely 'macro', 'regional', and 'all'.
  • start_time Start time for limiting results for a time range, can filter down to minutes
  • end_time End time for limiting results for a time range, can filter down to minutes
Link to this function

series_vintagedates(series_id, opts \\ [])

Get the dates in history when a series' data values were revised or new data values were released.

Required

  • series_id The id for a series

Optional

  • realtime_start The start of the real-time period. (YYYY-MM-DD)
  • realtime_end The end of the real-time period. (YYYY-MM-DD)
  • limit The maximum number of results to return.
  • offset The number of results to skip
  • sort_order Sort results is ascending or descending order for attribute values specified by order_by.
Link to this function

source(source_id, opts \\ [])

Get a source of economic data.

Required

  • source_id The id for a source

Optional

  • realtime_start The start of the real-time period. (YYYY-MM-DD)
  • realtime_end The end of the real-time period. (YYYY-MM-DD)
Link to this function

source_releases(source_id, opts \\ [])

Get the releases for a source.

Required

  • source_id The id for a source

Optional

  • realtime_start The start of the real-time period. (YYYY-MM-DD)
  • realtime_end The end of the real-time period. (YYYY-MM-DD)
  • limit The maximum number of results to return.
  • offset The number of results to skip
  • order_by Order results by values of the specified attribute.
  • sort_order Sort results is ascending or descending order for attribute values specified by order_by.
Link to this function

sources(opts \\ [])

Get all sources of economic data.

Optional

  • realtime_start The start of the real-time period. (YYYY-MM-DD)
  • realtime_end The end of the real-time period. (YYYY-MM-DD)
  • limit The maximum number of results to return.
  • offset The number of results to skip
  • order_by Order results by values of the specified attribute.
  • sort_order Sort results is ascending or descending order for attribute values specified by order_by.
Link to this function

tags(opts \\ [])

Get FRED tags.

Optional

  • realtime_start The start of the real-time period. (YYYY-MM-DD)
  • realtime_end The end of the real-time period. (YYYY-MM-DD)
  • tag_names A semicolon delimited list of tag names to only include in the response.
  • tag_group_id A tag group id to filter tags by type.
  • search_text The words to find matching tags with.
  • limit The maximum number of results to return.
  • offset The number of results to skip
  • order_by Order results by values of the specified attribute.
  • sort_order Sort results is ascending or descending order for attribute values specified by order_by.
Link to this function

tags_series(tag_names, opts \\ [])

Get the series matching all tags.

Required

  • tag_names A semicolon delimited list of tag names for series to match.

Optional

  • exclude_tag_names A semicolon delimited list of tag names to exclude from the response.
  • realtime_start The start of the real-time period. (YYYY-MM-DD)
  • realtime_end The end of the real-time period. (YYYY-MM-DD)
  • limit The maximum number of results to return.
  • offset The number of results to skip
  • order_by Order results by values of the specified attribute.
  • sort_order Sort results is ascending or descending order for attribute values specified by order_by.