data-analyst-mcp 0.3.0 → 0.4.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (292) hide show
  1. package/README.md +286 -262
  2. package/dist/adapters/bjs.d.ts +13 -0
  3. package/dist/adapters/bjs.js +28 -0
  4. package/dist/adapters/bjs.js.map +1 -0
  5. package/dist/adapters/cbp.d.ts +5 -0
  6. package/dist/adapters/cbp.js +64 -0
  7. package/dist/adapters/cbp.js.map +1 -0
  8. package/dist/adapters/cdc-wonder.d.ts +5 -0
  9. package/dist/adapters/cdc-wonder.js +68 -0
  10. package/dist/adapters/cdc-wonder.js.map +1 -0
  11. package/dist/adapters/cpsc.d.ts +4 -0
  12. package/dist/adapters/cpsc.js +125 -0
  13. package/dist/adapters/cpsc.js.map +1 -0
  14. package/dist/adapters/fhwa.d.ts +9 -0
  15. package/dist/adapters/fhwa.js +16 -0
  16. package/dist/adapters/fhwa.js.map +1 -0
  17. package/dist/adapters/foreign-assistance.d.ts +9 -0
  18. package/dist/adapters/foreign-assistance.js +42 -0
  19. package/dist/adapters/foreign-assistance.js.map +1 -0
  20. package/dist/adapters/hud-ahar.d.ts +3 -0
  21. package/dist/adapters/hud-ahar.js +80 -0
  22. package/dist/adapters/hud-ahar.js.map +1 -0
  23. package/dist/adapters/nces.d.ts +10 -0
  24. package/dist/adapters/nces.js +32 -0
  25. package/dist/adapters/nces.js.map +1 -0
  26. package/dist/adapters/nsf.d.ts +11 -0
  27. package/dist/adapters/nsf.js +25 -0
  28. package/dist/adapters/nsf.js.map +1 -0
  29. package/dist/adapters/onrr.d.ts +9 -0
  30. package/dist/adapters/onrr.js +35 -0
  31. package/dist/adapters/onrr.js.map +1 -0
  32. package/dist/adapters/sba.d.ts +10 -0
  33. package/dist/adapters/sba.js +134 -0
  34. package/dist/adapters/sba.js.map +1 -0
  35. package/dist/adapters/treasury-tic.d.ts +30 -0
  36. package/dist/adapters/treasury-tic.js +149 -0
  37. package/dist/adapters/treasury-tic.js.map +1 -0
  38. package/dist/adapters/uscourts.d.ts +8 -0
  39. package/dist/adapters/uscourts.js +8 -0
  40. package/dist/adapters/uscourts.js.map +1 -0
  41. package/dist/analysis/cite.d.ts +9 -1
  42. package/dist/analysis/cite.js +9 -2
  43. package/dist/analysis/cite.js.map +1 -1
  44. package/dist/bin/cli.d.ts +2 -0
  45. package/dist/bin/cli.js +17 -0
  46. package/dist/bin/cli.js.map +1 -1
  47. package/dist/core/generic-rest.js +42 -17
  48. package/dist/core/generic-rest.js.map +1 -1
  49. package/dist/core/guard.d.ts +32 -0
  50. package/dist/core/guard.js +176 -0
  51. package/dist/core/guard.js.map +1 -0
  52. package/dist/core/http.d.ts +10 -0
  53. package/dist/core/http.js +36 -7
  54. package/dist/core/http.js.map +1 -1
  55. package/dist/core/keys.d.ts +13 -3
  56. package/dist/core/keys.js +67 -7
  57. package/dist/core/keys.js.map +1 -1
  58. package/dist/core/package.d.ts +12 -3
  59. package/dist/core/package.js +56 -12
  60. package/dist/core/package.js.map +1 -1
  61. package/dist/core/secret_patterns.d.ts +6 -0
  62. package/dist/core/secret_patterns.js +20 -0
  63. package/dist/core/secret_patterns.js.map +1 -0
  64. package/dist/core/tabular.d.ts +43 -1
  65. package/dist/core/tabular.js +149 -6
  66. package/dist/core/tabular.js.map +1 -1
  67. package/dist/envelope.js +3 -1
  68. package/dist/envelope.js.map +1 -1
  69. package/dist/index.d.ts +29 -22
  70. package/dist/index.js +45 -46
  71. package/dist/index.js.map +1 -1
  72. package/dist/remote/app.js +87 -31
  73. package/dist/remote/app.js.map +1 -1
  74. package/dist/remote/oauth.js +8 -1
  75. package/dist/remote/oauth.js.map +1 -1
  76. package/dist/remote/pages.d.ts +3 -7
  77. package/dist/remote/pages.js +49 -19
  78. package/dist/remote/pages.js.map +1 -1
  79. package/dist/remote/sign.d.ts +7 -1
  80. package/dist/remote/sign.js +33 -7
  81. package/dist/remote/sign.js.map +1 -1
  82. package/dist/remote/store.js +14 -5
  83. package/dist/remote/store.js.map +1 -1
  84. package/dist/report/audit_report.js +29 -7
  85. package/dist/report/audit_report.js.map +1 -1
  86. package/dist/report/build_report.js +34 -4
  87. package/dist/report/build_report.js.map +1 -1
  88. package/dist/report/method_audit.js +10 -1
  89. package/dist/report/method_audit.js.map +1 -1
  90. package/dist/report/scan_secrets.d.ts +4 -1
  91. package/dist/report/scan_secrets.js +38 -18
  92. package/dist/report/scan_secrets.js.map +1 -1
  93. package/dist/server.d.ts +3 -1
  94. package/dist/server.js +46 -13
  95. package/dist/server.js.map +1 -1
  96. package/dist/tools.js +27 -6
  97. package/dist/tools.js.map +1 -1
  98. package/guide/WORKFLOW.md +134 -134
  99. package/guide/assets/disclaimer.txt +1 -1
  100. package/guide/assets/download_data.ps1 +164 -162
  101. package/guide/assets/download_data.sh +8 -2
  102. package/guide/assets/report_template.html +597 -597
  103. package/guide/references/routing.md +198 -171
  104. package/guide/references/style_guide.md +398 -398
  105. package/package.json +56 -56
  106. package/packs/acf/endpoints.json +114 -114
  107. package/packs/acf/policy.json +104 -104
  108. package/packs/actuaries/endpoints.json +82 -82
  109. package/packs/actuaries/policy.json +109 -109
  110. package/packs/bea/assets/download_bea.ps1 +182 -182
  111. package/packs/bea/docs/bea_api.md +461 -461
  112. package/packs/bea/docs/datasets.md +157 -157
  113. package/packs/bea/docs/report_patterns.md +112 -112
  114. package/packs/bea/policy.json +170 -170
  115. package/packs/bea/source.md +152 -152
  116. package/packs/bjs/endpoints.json +150 -0
  117. package/packs/bjs/policy.json +114 -0
  118. package/packs/bjs/source.md +98 -0
  119. package/packs/bls/assets/download_bls.ps1 +152 -152
  120. package/packs/bls/docs/analysis_patterns.md +108 -108
  121. package/packs/bls/docs/bls_api.md +73 -73
  122. package/packs/bls/docs/series_ids.md +149 -149
  123. package/packs/bls/policy.json +238 -238
  124. package/packs/bts/endpoints.json +346 -346
  125. package/packs/bts/policy.json +94 -94
  126. package/packs/cbp/endpoints.json +31 -0
  127. package/packs/cbp/policy.json +85 -0
  128. package/packs/cbp/source.md +57 -0
  129. package/packs/cdc/endpoints.json +197 -197
  130. package/packs/cdc/policy.json +83 -83
  131. package/packs/cdc/source.md +1 -1
  132. package/packs/cdc-wonder/endpoints.json +26 -0
  133. package/packs/cdc-wonder/policy.json +84 -0
  134. package/packs/cdc-wonder/source.md +53 -0
  135. package/packs/census/endpoints.json +99 -99
  136. package/packs/cfpb/endpoints.json +326 -326
  137. package/packs/cfpb/policy.json +119 -119
  138. package/packs/clinical-trials/endpoints.json +166 -166
  139. package/packs/clinical-trials/policy.json +84 -84
  140. package/packs/cms/endpoints.json +69 -69
  141. package/packs/cms/policy.json +96 -96
  142. package/packs/college-scorecard/endpoints.json +252 -252
  143. package/packs/college-scorecard/policy.json +106 -106
  144. package/packs/college-scorecard/source.md +1 -1
  145. package/packs/congress/endpoints.json +1701 -1701
  146. package/packs/congress/policy.json +117 -117
  147. package/packs/cpsc/endpoints.json +91 -0
  148. package/packs/cpsc/policy.json +91 -0
  149. package/packs/cpsc/source.md +76 -0
  150. package/packs/dhs-ohss/endpoints.json +66 -66
  151. package/packs/dhs-ohss/policy.json +107 -107
  152. package/packs/dhs-ohss/source.md +1 -1
  153. package/packs/doj-news/endpoints.json +59 -59
  154. package/packs/doj-news/policy.json +96 -96
  155. package/packs/doj-news/source.md +1 -1
  156. package/packs/dol/endpoints.json +817 -817
  157. package/packs/dol/policy.json +135 -135
  158. package/packs/eia/endpoints.json +717 -717
  159. package/packs/eia/policy.json +112 -112
  160. package/packs/epa/endpoints.json +291 -291
  161. package/packs/epa/policy.json +99 -99
  162. package/packs/epa-aqs/endpoints.json +173 -173
  163. package/packs/epa-aqs/policy.json +96 -96
  164. package/packs/fbi/endpoints.json +1841 -1841
  165. package/packs/fbi/policy.json +118 -118
  166. package/packs/fbi/source.md +3 -3
  167. package/packs/fda/endpoints.json +237 -237
  168. package/packs/fda/policy.json +121 -121
  169. package/packs/fdic/endpoints.json +416 -416
  170. package/packs/fdic/policy.json +83 -83
  171. package/packs/fec/endpoints.json +707 -707
  172. package/packs/fec/policy.json +93 -93
  173. package/packs/fed-board/endpoints.json +89 -89
  174. package/packs/fed-board/policy.json +136 -136
  175. package/packs/federal-register/endpoints.json +143 -143
  176. package/packs/federal-register/policy.json +86 -86
  177. package/packs/fema/endpoints.json +645 -645
  178. package/packs/fema/policy.json +103 -103
  179. package/packs/fhfa/endpoints.json +105 -105
  180. package/packs/fhfa/policy.json +109 -109
  181. package/packs/fhwa/endpoints.json +48 -0
  182. package/packs/fhwa/policy.json +91 -0
  183. package/packs/fhwa/source.md +59 -0
  184. package/packs/foreign-assistance/endpoints.json +166 -0
  185. package/packs/foreign-assistance/policy.json +80 -0
  186. package/packs/foreign-assistance/source.md +76 -0
  187. package/packs/fred/assets/download_fred.ps1 +122 -122
  188. package/packs/fred/docs/analysis_patterns.md +124 -124
  189. package/packs/fred/docs/fred_api.md +94 -94
  190. package/packs/fred/docs/series.md +188 -188
  191. package/packs/fred/policy.json +253 -253
  192. package/packs/fsa/endpoints.json +150 -150
  193. package/packs/fsa/policy.json +99 -99
  194. package/packs/fsa/source.md +1 -1
  195. package/packs/govinfo/endpoints.json +519 -519
  196. package/packs/gsa-calc/endpoints.json +93 -93
  197. package/packs/gsa-calc/policy.json +97 -97
  198. package/packs/hud/endpoints.json +146 -146
  199. package/packs/hud/policy.json +84 -84
  200. package/packs/hud/source.md +1 -1
  201. package/packs/hud-ahar/endpoints.json +92 -0
  202. package/packs/hud-ahar/policy.json +88 -0
  203. package/packs/hud-ahar/source.md +72 -0
  204. package/packs/ipums/docs/report_patterns.md +117 -117
  205. package/packs/irs-soi/endpoints.json +114 -114
  206. package/packs/irs-soi/policy.json +107 -107
  207. package/packs/medicaid/endpoints.json +412 -412
  208. package/packs/medicaid/policy.json +108 -108
  209. package/packs/naep/endpoints.json +217 -217
  210. package/packs/naep/policy.json +100 -100
  211. package/packs/naep/source.md +1 -1
  212. package/packs/nces/endpoints.json +101 -0
  213. package/packs/nces/policy.json +99 -0
  214. package/packs/nces/source.md +75 -0
  215. package/packs/nhtsa/endpoints.json +132 -132
  216. package/packs/nhtsa/policy.json +93 -93
  217. package/packs/nhtsa/source.md +1 -1
  218. package/packs/nih/endpoints.json +452 -452
  219. package/packs/nih/policy.json +86 -86
  220. package/packs/noaa/endpoints.json +431 -431
  221. package/packs/noaa/policy.json +95 -95
  222. package/packs/nrel/endpoints.json +327 -327
  223. package/packs/nrel/policy.json +96 -96
  224. package/packs/nsf/endpoints.json +33 -0
  225. package/packs/nsf/policy.json +83 -0
  226. package/packs/nsf/source.md +59 -0
  227. package/packs/nws/endpoints.json +271 -271
  228. package/packs/nws/policy.json +82 -82
  229. package/packs/nyfed/endpoints.json +80 -80
  230. package/packs/nyfed/policy.json +92 -92
  231. package/packs/omb/endpoints.json +460 -460
  232. package/packs/omb/policy.json +106 -106
  233. package/packs/onrr/endpoints.json +198 -0
  234. package/packs/onrr/policy.json +91 -0
  235. package/packs/onrr/source.md +55 -0
  236. package/packs/open-payments/endpoints.json +297 -297
  237. package/packs/open-payments/policy.json +101 -101
  238. package/packs/opm/assets/download_opm.ps1 +125 -125
  239. package/packs/opm/docs/fields.md +184 -184
  240. package/packs/opm/docs/opm_api.md +71 -71
  241. package/packs/opm/docs/report_patterns.md +83 -83
  242. package/packs/opm/lib/data_dictionary.csv +73 -73
  243. package/packs/pbgc/endpoints.json +483 -483
  244. package/packs/pbgc/policy.json +94 -94
  245. package/packs/philfed/endpoints.json +85 -85
  246. package/packs/philfed/policy.json +94 -94
  247. package/packs/port.json +65 -0
  248. package/packs/regulations/endpoints.json +287 -287
  249. package/packs/regulations/policy.json +86 -86
  250. package/packs/sba/endpoints.json +34 -0
  251. package/packs/sba/policy.json +86 -0
  252. package/packs/sba/source.md +60 -0
  253. package/packs/sec/endpoints.json +236 -236
  254. package/packs/sec/policy.json +86 -86
  255. package/packs/senate-lobbying/endpoints.json +553 -553
  256. package/packs/senate-lobbying/policy.json +99 -99
  257. package/packs/snapqc/endpoints.json +1426 -1426
  258. package/packs/snapqc/policy.json +92 -92
  259. package/packs/treasury/catalog.json +2267 -2267
  260. package/packs/treasury/docs/api_guide.md +245 -245
  261. package/packs/treasury/docs/datasets.md +56 -56
  262. package/packs/treasury/docs/report_patterns.md +126 -126
  263. package/packs/treasury/policy.json +159 -159
  264. package/packs/treasury/source.md +170 -165
  265. package/packs/treasury-tic/endpoints.json +77 -0
  266. package/packs/treasury-tic/policy.json +89 -0
  267. package/packs/treasury-tic/source.md +80 -0
  268. package/packs/treasury-yields/endpoints.json +226 -226
  269. package/packs/treasury-yields/policy.json +86 -86
  270. package/packs/usaspending/endpoints.json +1315 -1315
  271. package/packs/usaspending/policy.json +109 -109
  272. package/packs/uscourts/endpoints.json +22 -0
  273. package/packs/uscourts/policy.json +87 -0
  274. package/packs/uscourts/source.md +56 -0
  275. package/packs/usda-fna/policy.json +133 -133
  276. package/packs/usda-fooddata/endpoints.json +180 -180
  277. package/packs/usda-fooddata/policy.json +94 -94
  278. package/packs/usda-nass/endpoints.json +323 -323
  279. package/packs/usda-nass/policy.json +95 -95
  280. package/packs/usda-outlook/endpoints.json +86 -86
  281. package/packs/usda-outlook/policy.json +109 -109
  282. package/packs/usgs/endpoints.json +313 -313
  283. package/packs/usgs/policy.json +95 -95
  284. package/packs/usitc/endpoints.json +74 -74
  285. package/packs/usitc/policy.json +111 -111
  286. package/packs/uspto/endpoints.json +141 -141
  287. package/packs/uspto/policy.json +95 -95
  288. package/packs/uspto/source.md +1 -1
  289. package/packs/va/endpoints.json +414 -414
  290. package/packs/va/policy.json +101 -101
  291. package/packs/world-bank/endpoints.json +122 -122
  292. package/packs/world-bank/policy.json +101 -101
@@ -1,253 +1,253 @@
1
- {
2
- "id": "fred",
3
- "title": "FRED, ALFRED and GeoFRED (Federal Reserve Bank of St. Louis)",
4
- "agency": "Federal Reserve Bank of St. Louis",
5
- "depth": "deep",
6
- "domains": [
7
- "economy",
8
- "finance",
9
- "federal budget",
10
- "prices",
11
- "interest rates",
12
- "revisions"
13
- ],
14
- "keywords": [
15
- "trade balance",
16
- "trade deficit",
17
- "exports",
18
- "imports",
19
- "fred",
20
- "alfred",
21
- "geofred",
22
- "gdp",
23
- "real gdp",
24
- "potential gdp",
25
- "output gap",
26
- "inflation",
27
- "pce",
28
- "cpi",
29
- "cpi-w",
30
- "chained cpi",
31
- "interest rates",
32
- "treasury yield",
33
- "10-year",
34
- "federal funds",
35
- "mortgage rate",
36
- "deficit",
37
- "federal debt",
38
- "net interest",
39
- "outlays",
40
- "receipts",
41
- "unemployment",
42
- "recession",
43
- "nber",
44
- "vintage",
45
- "first release",
46
- "revision",
47
- "real-time",
48
- "release calendar",
49
- "state comparison",
50
- "fiscal year",
51
- "fed balance sheet",
52
- "federal reserve balance sheet",
53
- "h.4.1",
54
- "quantitative tightening",
55
- "quantitative easing",
56
- "reserve balances",
57
- "breakeven",
58
- "inflation expectations",
59
- "5y5y",
60
- "tips spread",
61
- "debt service ratio",
62
- "household debt service",
63
- "financial obligations ratio",
64
- "initial claims",
65
- "jobless claims",
66
- "unemployment claims",
67
- "industrial production",
68
- "capacity utilization",
69
- "manufacturing output",
70
- "g.17",
71
- "housing starts",
72
- "building permits",
73
- "new residential construction",
74
- "money supply",
75
- "m2",
76
- "m1",
77
- "money stock",
78
- "h.6",
79
- "consumer sentiment",
80
- "university of michigan",
81
- "exchange rate",
82
- "case-shiller",
83
- "home prices",
84
- "house prices",
85
- "house price index",
86
- "net international investment position",
87
- "niip",
88
- "exchange rates",
89
- "dollar index",
90
- "trade-weighted dollar",
91
- "broad dollar",
92
- "h.10",
93
- "value of the dollar"
94
- ],
95
- "questions": [
96
- "how big is the output gap",
97
- "net interest as a share of GDP by fiscal year",
98
- "how much was 2020 Q2 GDP revised",
99
- "the 10-year Treasury yield since 2000",
100
- "when is the next CPI release",
101
- "real disposable income since 2019"
102
- ],
103
- "homepage": "https://fred.stlouisfed.org/",
104
- "terms_url": "https://fred.stlouisfed.org/docs/api/terms_of_use.html",
105
- "auth": {
106
- "env": "FRED_API_KEY",
107
- "required": "optional",
108
- "placement": "query",
109
- "param": "api_key",
110
- "prefix": "",
111
- "home": "fred",
112
- "signup_url": "https://fredaccount.stlouisfed.org/apikeys",
113
- "echoes_key": false,
114
- "key_only": [
115
- "series search",
116
- "first-release vintages",
117
- "full revision history (ALFRED real-time periods)",
118
- "GeoFRED regional cross-sections",
119
- "source agency, notes and copyright status of each series",
120
- "release calendar and whole-release downloads"
121
- ],
122
- "extra": {},
123
- "demo_key": null
124
- },
125
- "limits": {
126
- "rps": 1.8,
127
- "burst": 4,
128
- "daily_quota": null,
129
- "requests_per_minute": 120,
130
- "graph_max_series": 12,
131
- "max_rows": 100000,
132
- "note": "API: 120 requests a minute, 100,000 observations per call (paged). Graph downloads: at most 12 series per graph (more are silently dropped); fetch sends one series per CSV."
133
- },
134
- "routes": {
135
- "api": {
136
- "base": "https://api.stlouisfed.org/fred/",
137
- "probe": "https://api.stlouisfed.org/fred/series?series_id=GNPCA&file_type=json",
138
- "hosts": [
139
- "api.stlouisfed.org"
140
- ]
141
- },
142
- "api_keyless": {
143
- "base": "https://fred.stlouisfed.org/graph/fredgraph.csv",
144
- "probe": "https://fred.stlouisfed.org/graph/fredgraph.csv?id=GNPCA&cosd=2020-01-01",
145
- "hosts": [
146
- "fred.stlouisfed.org",
147
- "alfred.stlouisfed.org"
148
- ]
149
- },
150
- "manual": {
151
- "how": "Call manual_bundle: manual_download/INSTRUCTIONS.md lists one browser link per series (fredgraph.csv / alfredgraph.csv, no key; or the series page's Download button, CSV) and download_data.sh / .ps1 with the request built in (one command each, e.g. bash ~/Downloads/download_data.sh), asking for a key with hidden input only for key-only files. Send INSTRUCTIONS.md, both scripts and spec.json; the user uploads the files unchanged, then call ingest."
152
- }
153
- },
154
- "cache": {
155
- "mode": "none",
156
- "ttl_hours": null,
157
- "why": "FRED's terms of use forbid storing or caching FRED content beyond what a use needs and building an archive of it; only the analysis folder's own data/fred/ copy for this request is kept."
158
- },
159
- "redistribution": {
160
- "mode": "allowed",
161
- "withhold": {
162
- "meta": "series.csv",
163
- "key": "series_id",
164
- "column": "copyright",
165
- "shareable": [
166
- "no_copyright_notice",
167
- "public_domain",
168
- "citation_required"
169
- ]
170
- },
171
- "why": "FRED's terms (https://fred.stlouisfed.org/docs/api/terms_of_use.html, https://fred.stlouisfed.org/legal/) let users share public-domain series with a citation and copyrighted series marked Citation Required with the owner's citation; series marked Copyrighted: Pre-Approval Required (S&P, some Moody's and ICE indexes) may not be republished without the owner's written permission, so their rows are withheld from shared files."
172
- },
173
- "notices": [
174
- "This product uses the FRED® API but is not endorsed or certified by the Federal Reserve Bank of St. Louis."
175
- ],
176
- "retention": null,
177
- "citation": "{dataset}, retrieved from FRED, Federal Reserve Bank of St. Louis; https://fred.stlouisfed.org/, {retrieved_long}. Per-series citations are in data/fred/series.csv.",
178
- "audit_hooks": [
179
- {
180
- "id": "fred_request",
181
- "kind": "require_file",
182
- "glob": "data/fred/request.json",
183
- "why": "The retrieval date, route and vintage of each series must be stated; request.json records them."
184
- },
185
- {
186
- "id": "fred_series_citations",
187
- "kind": "require_file",
188
- "glob": "data/fred/[sr]e*.csv",
189
- "why": "FRED's terms ask that each series be cited; series.csv holds the citation and copyright status (regional.csv, for GeoFRED-only specs, the group titles)."
190
- },
191
- {
192
- "id": "fred_api_notice",
193
- "kind": "require_text",
194
- "when_route": [
195
- "api"
196
- ],
197
- "any": [
198
- "not endorsed or certified by the Federal Reserve Bank of St. Louis"
199
- ],
200
- "why": "FRED's API terms of use require this notice in any product that uses the API (route api in data/fred/request.json)."
201
- },
202
- {
203
- "id": "fred_retrieved",
204
- "kind": "require_text",
205
- "any": [
206
- "retrieved from fred"
207
- ],
208
- "any_pattern": [
209
- "retrieved[^\\n]{0,80}\\bfred\\b",
210
- "\\bfred\\b[^\\n]{0,80}retrieved"
211
- ],
212
- "why": "FRED's suggested citation names FRED and the retrieval date."
213
- }
214
- ],
215
- "clarify": [
216
- "Calendar or fiscal years? Default: fiscal years (October to September) for budget amounts and their shares of GDP (fiscal-year GDP = mean of the four quarters); calendar years otherwise.",
217
- "Which vintage: latest data, as published on a date, or as first reported? Default: latest, unless the question is about what was known at a time; then the vintage just before it.",
218
- "Which measure (PCE or CPI; debt held by the public or total public debt; budget-basis or NIPA interest)? Default: the measure the question's institution uses; indexing questions use the index the law names.",
219
- "Which growth measure (Q4 over Q4, annual average, quarterly annualized)? Default: the publishing agency's own measure: BEA's annual growth is annual average over annual average (Q4 over Q4 only when comparing with Fed or CBO projections, which use it); annual averages for rates; name it every time."
220
- ],
221
- "formats": [
222
- "json",
223
- "csv",
224
- "xlsx",
225
- "zip"
226
- ],
227
- "use_instead": [
228
- {
229
- "question": "BLS detail with preliminary flags, footnotes and gaps",
230
- "source": "bls",
231
- "terms": [
232
- "preliminary"
233
- ],
234
- "why": "The bls pack keeps BLS's own flags."
235
- },
236
- {
237
- "question": "BEA tables with line numbers and vintages",
238
- "source": "bea",
239
- "terms": [
240
- "NIPA"
241
- ],
242
- "why": "The bea pack reads BEA tables as published."
243
- },
244
- {
245
- "question": "Treasury daily statements and auctions",
246
- "source": "treasury",
247
- "terms": [
248
- "auction"
249
- ],
250
- "why": "Treasury Fiscal Data."
251
- }
252
- ]
253
- }
1
+ {
2
+ "id": "fred",
3
+ "title": "FRED, ALFRED and GeoFRED (Federal Reserve Bank of St. Louis)",
4
+ "agency": "Federal Reserve Bank of St. Louis",
5
+ "depth": "deep",
6
+ "domains": [
7
+ "economy",
8
+ "finance",
9
+ "federal budget",
10
+ "prices",
11
+ "interest rates",
12
+ "revisions"
13
+ ],
14
+ "keywords": [
15
+ "trade balance",
16
+ "trade deficit",
17
+ "exports",
18
+ "imports",
19
+ "fred",
20
+ "alfred",
21
+ "geofred",
22
+ "gdp",
23
+ "real gdp",
24
+ "potential gdp",
25
+ "output gap",
26
+ "inflation",
27
+ "pce",
28
+ "cpi",
29
+ "cpi-w",
30
+ "chained cpi",
31
+ "interest rates",
32
+ "treasury yield",
33
+ "10-year",
34
+ "federal funds",
35
+ "mortgage rate",
36
+ "deficit",
37
+ "federal debt",
38
+ "net interest",
39
+ "outlays",
40
+ "receipts",
41
+ "unemployment",
42
+ "recession",
43
+ "nber",
44
+ "vintage",
45
+ "first release",
46
+ "revision",
47
+ "real-time",
48
+ "release calendar",
49
+ "state comparison",
50
+ "fiscal year",
51
+ "fed balance sheet",
52
+ "federal reserve balance sheet",
53
+ "h.4.1",
54
+ "quantitative tightening",
55
+ "quantitative easing",
56
+ "reserve balances",
57
+ "breakeven",
58
+ "inflation expectations",
59
+ "5y5y",
60
+ "tips spread",
61
+ "debt service ratio",
62
+ "household debt service",
63
+ "financial obligations ratio",
64
+ "initial claims",
65
+ "jobless claims",
66
+ "unemployment claims",
67
+ "industrial production",
68
+ "capacity utilization",
69
+ "manufacturing output",
70
+ "g.17",
71
+ "housing starts",
72
+ "building permits",
73
+ "new residential construction",
74
+ "money supply",
75
+ "m2",
76
+ "m1",
77
+ "money stock",
78
+ "h.6",
79
+ "consumer sentiment",
80
+ "university of michigan",
81
+ "exchange rate",
82
+ "case-shiller",
83
+ "home prices",
84
+ "house prices",
85
+ "house price index",
86
+ "net international investment position",
87
+ "niip",
88
+ "exchange rates",
89
+ "dollar index",
90
+ "trade-weighted dollar",
91
+ "broad dollar",
92
+ "h.10",
93
+ "value of the dollar"
94
+ ],
95
+ "questions": [
96
+ "how big is the output gap",
97
+ "net interest as a share of GDP by fiscal year",
98
+ "how much was 2020 Q2 GDP revised",
99
+ "the 10-year Treasury yield since 2000",
100
+ "when is the next CPI release",
101
+ "real disposable income since 2019"
102
+ ],
103
+ "homepage": "https://fred.stlouisfed.org/",
104
+ "terms_url": "https://fred.stlouisfed.org/docs/api/terms_of_use.html",
105
+ "auth": {
106
+ "env": "FRED_API_KEY",
107
+ "required": "optional",
108
+ "placement": "query",
109
+ "param": "api_key",
110
+ "prefix": "",
111
+ "home": "fred",
112
+ "signup_url": "https://fredaccount.stlouisfed.org/apikeys",
113
+ "echoes_key": false,
114
+ "key_only": [
115
+ "series search",
116
+ "first-release vintages",
117
+ "full revision history (ALFRED real-time periods)",
118
+ "GeoFRED regional cross-sections",
119
+ "source agency, notes and copyright status of each series",
120
+ "release calendar and whole-release downloads"
121
+ ],
122
+ "extra": {},
123
+ "demo_key": null
124
+ },
125
+ "limits": {
126
+ "rps": 1.8,
127
+ "burst": 4,
128
+ "daily_quota": null,
129
+ "requests_per_minute": 120,
130
+ "graph_max_series": 12,
131
+ "max_rows": 100000,
132
+ "note": "API: 120 requests a minute, 100,000 observations per call (paged). Graph downloads: at most 12 series per graph (more are silently dropped); fetch sends one series per CSV."
133
+ },
134
+ "routes": {
135
+ "api": {
136
+ "base": "https://api.stlouisfed.org/fred/",
137
+ "probe": "https://api.stlouisfed.org/fred/series?series_id=GNPCA&file_type=json",
138
+ "hosts": [
139
+ "api.stlouisfed.org"
140
+ ]
141
+ },
142
+ "api_keyless": {
143
+ "base": "https://fred.stlouisfed.org/graph/fredgraph.csv",
144
+ "probe": "https://fred.stlouisfed.org/graph/fredgraph.csv?id=GNPCA&cosd=2020-01-01",
145
+ "hosts": [
146
+ "fred.stlouisfed.org",
147
+ "alfred.stlouisfed.org"
148
+ ]
149
+ },
150
+ "manual": {
151
+ "how": "Call manual_bundle: manual_download/INSTRUCTIONS.md lists one browser link per series (fredgraph.csv / alfredgraph.csv, no key; or the series page's Download button, CSV) and download_data.sh / .ps1 with the request built in (one command each, e.g. bash ~/Downloads/download_data.sh), asking for a key with hidden input only for key-only files. Send INSTRUCTIONS.md, both scripts and spec.json; the user uploads the files unchanged, then call ingest."
152
+ }
153
+ },
154
+ "cache": {
155
+ "mode": "none",
156
+ "ttl_hours": null,
157
+ "why": "FRED's terms of use forbid storing or caching FRED content beyond what a use needs and building an archive of it; only the analysis folder's own data/fred/ copy for this request is kept."
158
+ },
159
+ "redistribution": {
160
+ "mode": "allowed",
161
+ "withhold": {
162
+ "meta": "series.csv",
163
+ "key": "series_id",
164
+ "column": "copyright",
165
+ "shareable": [
166
+ "no_copyright_notice",
167
+ "public_domain",
168
+ "citation_required"
169
+ ]
170
+ },
171
+ "why": "FRED's terms (https://fred.stlouisfed.org/docs/api/terms_of_use.html, https://fred.stlouisfed.org/legal/) let users share public-domain series with a citation and copyrighted series marked Citation Required with the owner's citation; series marked Copyrighted: Pre-Approval Required (S&P, some Moody's and ICE indexes) may not be republished without the owner's written permission, so their rows are withheld from shared files."
172
+ },
173
+ "notices": [
174
+ "This product uses the FRED® API but is not endorsed or certified by the Federal Reserve Bank of St. Louis."
175
+ ],
176
+ "retention": null,
177
+ "citation": "{dataset}, retrieved from FRED, Federal Reserve Bank of St. Louis; https://fred.stlouisfed.org/, {retrieved_long}. Per-series citations are in data/fred/series.csv.",
178
+ "audit_hooks": [
179
+ {
180
+ "id": "fred_request",
181
+ "kind": "require_file",
182
+ "glob": "data/fred/request.json",
183
+ "why": "The retrieval date, route and vintage of each series must be stated; request.json records them."
184
+ },
185
+ {
186
+ "id": "fred_series_citations",
187
+ "kind": "require_file",
188
+ "glob": "data/fred/[sr]e*.csv",
189
+ "why": "FRED's terms ask that each series be cited; series.csv holds the citation and copyright status (regional.csv, for GeoFRED-only specs, the group titles)."
190
+ },
191
+ {
192
+ "id": "fred_api_notice",
193
+ "kind": "require_text",
194
+ "when_route": [
195
+ "api"
196
+ ],
197
+ "any": [
198
+ "not endorsed or certified by the Federal Reserve Bank of St. Louis"
199
+ ],
200
+ "why": "FRED's API terms of use require this notice in any product that uses the API (route api in data/fred/request.json)."
201
+ },
202
+ {
203
+ "id": "fred_retrieved",
204
+ "kind": "require_text",
205
+ "any": [
206
+ "retrieved from fred"
207
+ ],
208
+ "any_pattern": [
209
+ "retrieved[^\\n]{0,80}\\bfred\\b",
210
+ "\\bfred\\b[^\\n]{0,80}retrieved"
211
+ ],
212
+ "why": "FRED's suggested citation names FRED and the retrieval date."
213
+ }
214
+ ],
215
+ "clarify": [
216
+ "Calendar or fiscal years? Default: fiscal years (October to September) for budget amounts and their shares of GDP (fiscal-year GDP = mean of the four quarters); calendar years otherwise.",
217
+ "Which vintage: latest data, as published on a date, or as first reported? Default: latest, unless the question is about what was known at a time; then the vintage just before it.",
218
+ "Which measure (PCE or CPI; debt held by the public or total public debt; budget-basis or NIPA interest)? Default: the measure the question's institution uses; indexing questions use the index the law names.",
219
+ "Which growth measure (Q4 over Q4, annual average, quarterly annualized)? Default: the publishing agency's own measure: BEA's annual growth is annual average over annual average (Q4 over Q4 only when comparing with Fed or CBO projections, which use it); annual averages for rates; name it every time."
220
+ ],
221
+ "formats": [
222
+ "json",
223
+ "csv",
224
+ "xlsx",
225
+ "zip"
226
+ ],
227
+ "use_instead": [
228
+ {
229
+ "question": "BLS detail with preliminary flags, footnotes and gaps",
230
+ "source": "bls",
231
+ "terms": [
232
+ "preliminary"
233
+ ],
234
+ "why": "The bls pack keeps BLS's own flags."
235
+ },
236
+ {
237
+ "question": "BEA tables with line numbers and vintages",
238
+ "source": "bea",
239
+ "terms": [
240
+ "NIPA"
241
+ ],
242
+ "why": "The bea pack reads BEA tables as published."
243
+ },
244
+ {
245
+ "question": "Treasury daily statements and auctions",
246
+ "source": "treasury",
247
+ "terms": [
248
+ "auction"
249
+ ],
250
+ "why": "Treasury Fiscal Data."
251
+ }
252
+ ]
253
+ }