data-analyst-mcp 0.3.0 → 0.3.1

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 (153) hide show
  1. package/README.md +262 -262
  2. package/dist/report/method_audit.js +7 -1
  3. package/dist/report/method_audit.js.map +1 -1
  4. package/dist/report/scan_secrets.d.ts +4 -1
  5. package/dist/report/scan_secrets.js +36 -5
  6. package/dist/report/scan_secrets.js.map +1 -1
  7. package/dist/server.d.ts +1 -1
  8. package/dist/server.js +3 -2
  9. package/dist/server.js.map +1 -1
  10. package/guide/WORKFLOW.md +134 -134
  11. package/guide/assets/disclaimer.txt +1 -1
  12. package/guide/assets/download_data.ps1 +162 -162
  13. package/guide/assets/report_template.html +597 -597
  14. package/guide/references/routing.md +171 -171
  15. package/guide/references/style_guide.md +398 -398
  16. package/package.json +56 -56
  17. package/packs/acf/endpoints.json +114 -114
  18. package/packs/acf/policy.json +104 -104
  19. package/packs/actuaries/endpoints.json +82 -82
  20. package/packs/actuaries/policy.json +109 -109
  21. package/packs/bea/assets/download_bea.ps1 +182 -182
  22. package/packs/bea/docs/bea_api.md +461 -461
  23. package/packs/bea/docs/datasets.md +157 -157
  24. package/packs/bea/docs/report_patterns.md +112 -112
  25. package/packs/bea/policy.json +170 -170
  26. package/packs/bea/source.md +152 -152
  27. package/packs/bls/assets/download_bls.ps1 +152 -152
  28. package/packs/bls/docs/analysis_patterns.md +108 -108
  29. package/packs/bls/docs/bls_api.md +73 -73
  30. package/packs/bls/docs/series_ids.md +149 -149
  31. package/packs/bls/policy.json +238 -238
  32. package/packs/bts/endpoints.json +346 -346
  33. package/packs/bts/policy.json +94 -94
  34. package/packs/cdc/endpoints.json +197 -197
  35. package/packs/cdc/policy.json +83 -83
  36. package/packs/census/endpoints.json +99 -99
  37. package/packs/cfpb/endpoints.json +326 -326
  38. package/packs/cfpb/policy.json +119 -119
  39. package/packs/clinical-trials/endpoints.json +166 -166
  40. package/packs/clinical-trials/policy.json +84 -84
  41. package/packs/cms/endpoints.json +69 -69
  42. package/packs/cms/policy.json +96 -96
  43. package/packs/college-scorecard/endpoints.json +252 -252
  44. package/packs/college-scorecard/policy.json +106 -106
  45. package/packs/congress/endpoints.json +1701 -1701
  46. package/packs/congress/policy.json +117 -117
  47. package/packs/dhs-ohss/endpoints.json +66 -66
  48. package/packs/dhs-ohss/policy.json +107 -107
  49. package/packs/doj-news/endpoints.json +59 -59
  50. package/packs/doj-news/policy.json +96 -96
  51. package/packs/dol/endpoints.json +817 -817
  52. package/packs/dol/policy.json +135 -135
  53. package/packs/eia/endpoints.json +717 -717
  54. package/packs/eia/policy.json +112 -112
  55. package/packs/epa/endpoints.json +291 -291
  56. package/packs/epa/policy.json +99 -99
  57. package/packs/epa-aqs/endpoints.json +173 -173
  58. package/packs/epa-aqs/policy.json +96 -96
  59. package/packs/fbi/endpoints.json +1841 -1841
  60. package/packs/fbi/policy.json +118 -118
  61. package/packs/fda/endpoints.json +237 -237
  62. package/packs/fda/policy.json +121 -121
  63. package/packs/fdic/endpoints.json +416 -416
  64. package/packs/fdic/policy.json +83 -83
  65. package/packs/fec/endpoints.json +707 -707
  66. package/packs/fec/policy.json +93 -93
  67. package/packs/fed-board/endpoints.json +89 -89
  68. package/packs/fed-board/policy.json +136 -136
  69. package/packs/federal-register/endpoints.json +143 -143
  70. package/packs/federal-register/policy.json +86 -86
  71. package/packs/fema/endpoints.json +645 -645
  72. package/packs/fema/policy.json +103 -103
  73. package/packs/fhfa/endpoints.json +105 -105
  74. package/packs/fhfa/policy.json +109 -109
  75. package/packs/fred/assets/download_fred.ps1 +122 -122
  76. package/packs/fred/docs/analysis_patterns.md +124 -124
  77. package/packs/fred/docs/fred_api.md +94 -94
  78. package/packs/fred/docs/series.md +188 -188
  79. package/packs/fred/policy.json +253 -253
  80. package/packs/fsa/endpoints.json +150 -150
  81. package/packs/fsa/policy.json +99 -99
  82. package/packs/govinfo/endpoints.json +519 -519
  83. package/packs/gsa-calc/endpoints.json +93 -93
  84. package/packs/gsa-calc/policy.json +97 -97
  85. package/packs/hud/endpoints.json +146 -146
  86. package/packs/hud/policy.json +84 -84
  87. package/packs/ipums/docs/report_patterns.md +117 -117
  88. package/packs/irs-soi/endpoints.json +114 -114
  89. package/packs/irs-soi/policy.json +107 -107
  90. package/packs/medicaid/endpoints.json +412 -412
  91. package/packs/medicaid/policy.json +108 -108
  92. package/packs/naep/endpoints.json +217 -217
  93. package/packs/naep/policy.json +100 -100
  94. package/packs/nhtsa/endpoints.json +132 -132
  95. package/packs/nhtsa/policy.json +93 -93
  96. package/packs/nih/endpoints.json +452 -452
  97. package/packs/nih/policy.json +86 -86
  98. package/packs/noaa/endpoints.json +431 -431
  99. package/packs/noaa/policy.json +95 -95
  100. package/packs/nrel/endpoints.json +327 -327
  101. package/packs/nrel/policy.json +96 -96
  102. package/packs/nws/endpoints.json +271 -271
  103. package/packs/nws/policy.json +82 -82
  104. package/packs/nyfed/endpoints.json +80 -80
  105. package/packs/nyfed/policy.json +92 -92
  106. package/packs/omb/endpoints.json +460 -460
  107. package/packs/omb/policy.json +106 -106
  108. package/packs/open-payments/endpoints.json +297 -297
  109. package/packs/open-payments/policy.json +101 -101
  110. package/packs/opm/assets/download_opm.ps1 +125 -125
  111. package/packs/opm/docs/fields.md +184 -184
  112. package/packs/opm/docs/opm_api.md +71 -71
  113. package/packs/opm/docs/report_patterns.md +83 -83
  114. package/packs/opm/lib/data_dictionary.csv +73 -73
  115. package/packs/pbgc/endpoints.json +483 -483
  116. package/packs/pbgc/policy.json +94 -94
  117. package/packs/philfed/endpoints.json +85 -85
  118. package/packs/philfed/policy.json +94 -94
  119. package/packs/regulations/endpoints.json +287 -287
  120. package/packs/regulations/policy.json +86 -86
  121. package/packs/sec/endpoints.json +236 -236
  122. package/packs/sec/policy.json +86 -86
  123. package/packs/senate-lobbying/endpoints.json +553 -553
  124. package/packs/senate-lobbying/policy.json +99 -99
  125. package/packs/snapqc/endpoints.json +1426 -1426
  126. package/packs/snapqc/policy.json +92 -92
  127. package/packs/treasury/catalog.json +2267 -2267
  128. package/packs/treasury/docs/api_guide.md +245 -245
  129. package/packs/treasury/docs/datasets.md +56 -56
  130. package/packs/treasury/docs/report_patterns.md +126 -126
  131. package/packs/treasury/policy.json +159 -159
  132. package/packs/treasury/source.md +170 -165
  133. package/packs/treasury-yields/endpoints.json +226 -226
  134. package/packs/treasury-yields/policy.json +86 -86
  135. package/packs/usaspending/endpoints.json +1315 -1315
  136. package/packs/usaspending/policy.json +109 -109
  137. package/packs/usda-fna/policy.json +133 -133
  138. package/packs/usda-fooddata/endpoints.json +180 -180
  139. package/packs/usda-fooddata/policy.json +94 -94
  140. package/packs/usda-nass/endpoints.json +323 -323
  141. package/packs/usda-nass/policy.json +95 -95
  142. package/packs/usda-outlook/endpoints.json +86 -86
  143. package/packs/usda-outlook/policy.json +109 -109
  144. package/packs/usgs/endpoints.json +313 -313
  145. package/packs/usgs/policy.json +95 -95
  146. package/packs/usitc/endpoints.json +74 -74
  147. package/packs/usitc/policy.json +111 -111
  148. package/packs/uspto/endpoints.json +141 -141
  149. package/packs/uspto/policy.json +95 -95
  150. package/packs/va/endpoints.json +414 -414
  151. package/packs/va/policy.json +101 -101
  152. package/packs/world-bank/endpoints.json +122 -122
  153. 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
+ }