FredAPI.jl
A Julia interface to the Federal Reserve Economic Data API. This package is issued under the MIT License and is unaffiliated with the Federal Reserve Bank of St. Louis.
This product uses the FRED API but is not endorsed or certified by the Federal Reserve Bank of St. Louis.
Use of the FRED API is subject to Terms of Use, and by using this Julia package to interface with the FRED API, you agree to be bound by the FRED API Terms of Use.
All use of the FRED API requires an API key. You are responsible for requesting and using your own key.
Interface
FredAPI.Responses.CategoryResponseFredAPI.Responses.ReleasesResponseFredAPI.category.childrenFredAPI.category.getFredAPI.category.relatedFredAPI.category.related_tagsFredAPI.category.seriesFredAPI.category.tagsFredAPI.get_api_keyFredAPI.release.datesFredAPI.release.getFredAPI.release.related_tagsFredAPI.release.seriesFredAPI.release.sourcesFredAPI.release.tablesFredAPI.release.tagsFredAPI.releases.datesFredAPI.releases.get_allFredAPI.series.categoriesFredAPI.series.getFredAPI.series.observationsFredAPI.series.releaseFredAPI.series.searchFredAPI.series.search_related_tagsFredAPI.series.search_tagsFredAPI.series.tagsFredAPI.series.updatesFredAPI.series.vintagedatesFredAPI.set_api_keyFredAPI.source.getFredAPI.source.get_allFredAPI.source.releasesFredAPI.tags.get_allFredAPI.tags.related_tagsFredAPI.tags.series
FredAPI.get_api_key — Method
get_api_key(api_key)Obtains an api_key for use in HTTP requests
- If
api_keyis an instance ofAbstractString, aStringrepresentation ofapi_keyis returned. - If
api_keyisnothing, the global API key is returned. (Seeset(api_key)(@ref))
This method serves as the default approach to obtaining an api_key in many functions.
FredAPI.set_api_key — Method
set_api_key(api_key)Sets the global api-key constant to api_key
FredAPI.category.children — Function
children(category_id=0)Get the children categories for the category_id category
FredAPI.category.get — Function
get(category_id=0)Get the category for category_id, defaulting to the root category
See fred/category.
FredAPI.category.related — Method
FredAPI.category.related_tags — Method
related_tags(category_id, tag_names; <keyword arguments>)Get the related tags for one or more tags within a category
FredAPI.category.series — Method
FredAPI.category.tags — Method
tags(category_id; <keyword arguments>)Get the tags for the category_id category
See fred/category/tags.
FredAPI.release.dates — Method
dates(release_id; <keyword arguments>)Gets release dates for a single data release
See fred/release/dates.
FredAPI.release.get — Method
FredAPI.release.related_tags — Method
related_tags(release_id, tag_names; <keyword arguments>)Get related tags for tag_names within release release_id
FredAPI.release.series — Method
FredAPI.release.sources — Method
FredAPI.release.tables — Method
tables(release_id; <keyword arguments>)Get release tables for release release_id
See fred/release/tables.
FredAPI.release.tags — Method
FredAPI.releases.dates — Method
FredAPI.releases.get_all — Method
FredAPI.Responses.CategoryResponse — Type
Returned By:
categorycategory/childrencategory/relatedseries/categories
FredAPI.Responses.ReleasesResponse — Type
Returned By:
releases
FredAPI.series.categories — Method
categories(series_id; <keyword arguments>)Get the categories for series series_id
FredAPI.series.get — Method
FredAPI.series.observations — Method
observations(series_id; <keyword arguments>)Get the observations or data values for a data series
FredAPI.series.release — Method
release(series_id; <keyword arguments>)Get the release for the series_id series
See fred/series/release.
FredAPI.series.search — Method
search(search_text; <keyword arguments>)Gets the series that match search_text
See fred/series/search.
FredAPI.series.search_related_tags — Function
search_related_tags(series_search_text, tag_names; <keyword arguments>)Get the related tags for tag_names matching series_search_text
FredAPI.series.search_tags — Method
search_tags(series_search_text; <keyword arguments>)Get the tags for a series search
FredAPI.series.tags — Method
FredAPI.series.updates — Method
FredAPI.series.vintagedates — Method
vintagedates(series_id; <keyword arguments>)Get historical dates for when the series_id series data values were released/revised
FredAPI.source.get — Method
FredAPI.source.get_all — Method
FredAPI.source.releases — Method
releases(source_id; <keyword arguments>)Get the releases for the source_id source
See fred/source/releases.