https://github.com/Rleahy22/fredApi

Javascript wrapper for FRED (Federal Reserve Economic Database) API
https://github.com/Rleahy22/fredApi

Last synced: about 1 month ago
JSON representation

Javascript wrapper for FRED (Federal Reserve Economic Database) API

• Host: GitHub
• URL: https://github.com/Rleahy22/fredApi
• Owner: Rleahy22
• License: mit
• Created: 2014-09-24T23:38:43.000Z (about 10 years ago)
• Default Branch: master
• Last Pushed: 2021-08-07T17:39:39.000Z (over 3 years ago)
• Last Synced: 2024-10-28T17:25:36.292Z (about 1 month ago)
• Language: JavaScript
• Homepage: https://www.npmjs.com/package/fred-api
• Size: 17.6 KB
• Stars: 58
• Watchers: 3
• Forks: 14
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: MIT-LICENSE

Awesome Lists containing this project

• awesome-fintech - fredApi - Javascript wrapper for FRED (Federal Reserve Economic Database) API. (Libraries / Javascript)

README

        
# Fred

Javascript wrapper for the St. Louis Federal Reserve Economic Data [Fred API](http://api.stlouisfed.org/).

## Installation

   npm install fred-api

## Get a FRED API key

Sign up for a Fred API key: [http://api.stlouisfed.org/api_key.html](http://api.stlouisfed.org/api_key.html)

## Usage

### Instantiate a client

    var Fred = require('fred-api');

    apiKey = process.env.FRED_KEY;

    fred   = new Fred(apiKey);

#### Examples

    fred.getSeries({series_id: 'GNPCA'}, function(error, result) {

        console.log(result)

    });

    >> Result:

    {

        realtime_start: '2015-01-13',

        realtime_end: '2015-01-13',

        seriess: [

            {

                id: 'GNPCA',

                realtime_start: '2015-01-13',

                realtime_end: '2015-01-13',

                title: 'Real Gross National Product',

                observation_start: '1929-01-01',

                observation_end: '2013-01-01',

                frequency: 'Annual',

                frequency_short: 'A',

                units: 'Billions of Chained 2009 Dollars',

                units_short: 'Bil. of Chn. 2009 $',

                seasonal_adjustment: 'Not Seasonally Adjusted',

                seasonal_adjustment_short: 'NSA',

                last_updated: '2014-07-30 10:36:08-05',

                popularity: 25,

                notes: 'BEA Account Code: A001RX1'

            }

        ]

    }

## Copyright

Copyright (c) 2017 Ryan Leahy

## API

# categories

    getCategory

    getCategoryChildren

    getCategoryRelated

    getCategorySeries

    getCategoryTags

    getCategoryRelatedTags

# releases

    getReleases

    getReleasesDates

    getRelease

    getReleaseDates

    getReleaseSeries

    getReleaseSources

    getReleaseTags

    getReleaseRelatedTags

# series

    getSeries

    getSeriesCategories

    getSeriesObservations

    getSeriesRelease

    getSeriesSearch

    getSeriesSearchTags

    getSeriesSearchRelatedTags

    getSeriesTags

    getSeriesUpdates

    getSeriesVintageDates

# sources

    getSources

    getSource

    getSourceReleases

# tags

    getTags

    getRelatedTags

    getTagsSeries