Giter Club home page Giter Club logo

fredapi's Introduction

Fred

Javascript wrapper for the St. Louis Federal Reserve Economic Data Fred API.

Installation

npm install fred-api

Get a FRED API key

Sign up for a Fred API key: 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

fredapi's People

Contributors

hunter-github avatar rleahy22 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.