Skip to content
No description, website, or topics provided.
Visual Basic
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
Fed.Fred
LICENSE.txt
README.md

README.md

Fed.Fred

A .Net library for interacting with the Federal Reserve Economic Data (FRED) API.

Donation

If this project help you reduce time to develop, you can give me a cup of coffee. It encourages us to keep making the package better. Thank you.

paypal

Installation:

Install package via Nuget: https://www.nuget.org/packages/Fed.Fred/

PM> Install-Package Fed.Fred

FRED API key is required. Obtain key from http://api.stlouisfed.org/api_key.html

Instructions:

Create a Fed.Fred object.

var fred = new Fred("FRED API key");

The library does not cache calls from the FRED database. You can change cache option.

var fred = new Fred("api key", RequestCacheLevel.BypassCache); //Default Option

Sample Fed.Fred API Calls

Categories

GetCategory
var release = fred.GetCategory(int categoryId);

GetCategoryChildren
IEnumerable<Category> GetCategoryChildren(int categoryId);

GetCategoryRelated
IEnumerable<Category> GetCategoryRelated(int categoryId);

GetCategorySeries
IEnumerable<Series> GetCategorySeries(int seriesId);

GetCategoryTags
IEnumerable<Tags> GetCategoryTags(int categoryId);

GetCategoryRelatedTags
IEnumerable<Tags> GetCategoryRelatedTags(int categoryId);

Releases

GetReleases
IEnumerable<Release> releases = fred.GetReleases();
foreach (var release in releases){}

GetReleasesDates
IEnumerable<ReleaseDate> GetReleasesDates();

GetRelease
var release = fred.GetRelease(int releaseId);

GetReleaseDates
IEnumerable<ReleaseDate> GetReleaseDates(int releaseId);

GetReleaseSeries
IEnumerable<Series> GetReleaseSeries(int releaseId);

GetReleaseSources
IEnumerable<Series> GetReleaseSources(int releaseId);

GetReleaseTags
IEnumerable<Tags> GetReleaseTags(int releaseId);

GetReleaseRelatedTags
IEnumerable<Tags> GetReleaseRelatedTags(int releaseId);

Series

GetSeries
var release = fred.GetSeries(string seriesId);

GetSeriesCategories
IEnumerable<Category> GetSeriesCategories(string seriesId);

GetSeriesObservations
IEnumerable<Observation> GetSeriesObservations(string seriesId);

GetSeriesRelease
var series = fred.GetSeriesRelease(string seriesId);

GetSeriesSearch
IEnumerable<Series> GetSeriesSearch(string searchText);

GetSeriesSearchTags
IEnumerable<Tags> GetSeriesSearchTags(string searchText);

GetSeriesSearchRelatedTags
IEnumerable<Tags> GetSeriesSearchRelatedTags(string searchText, string tag_names);

GetSeriesTags
IEnumerable<Tags> GetSeriesTags(string seriesId);

GetSeriesUpdates
IEnumerable<Series> GetSeriesUpdates();

GetVintageDates
IEnumerable<VintageDate> GetVintageDates(string seriesId);

Sources

GetSources
IEnumerable<Source> GetSources();

GetSource
IEnumerable<Source> GetSource(int sourceID);

GetSourceReleases
IEnumerable<Source> GetSource(int sourceID);

Tags

GetTags
IEnumerable<Tags> GetTags();

GetRelatedTags
IEnumerable<Tags> GetSource(string tag_Names);

GetTagSeries
IEnumerable<Series> GetTagSeries(string tag_Names);

You can’t perform that action at this time.