UNPKG

fred-api

Version:

Javascript wrapper for FRED (Federal Reserve Economic Database) API

github.com/Rleahy22/fredApi

Rleahy22/fredApi

102 lines (77 loc) • 2.15 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
# 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