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,136 +1,136 @@
1
- {
2
- "id": "fed-board",
3
- "title": "Federal Reserve Board data (Data Download Program releases, Z.1 Financial Accounts, Survey of Consumer Finances)",
4
- "agency": "Board of Governors of the Federal Reserve System",
5
- "depth": "standard",
6
- "domains": [
7
- "household finance",
8
- "credit",
9
- "financial accounts",
10
- "wealth",
11
- "banking",
12
- "monetary policy"
13
- ],
14
- "keywords": [
15
- "federal reserve board",
16
- "consumer credit",
17
- "g.19",
18
- "revolving credit",
19
- "student loans",
20
- "auto loans",
21
- "financial accounts",
22
- "flow of funds",
23
- "z.1",
24
- "household net worth",
25
- "household balance sheet",
26
- "household debt",
27
- "sector balance sheets",
28
- "federal government debt holders",
29
- "senior loan officer",
30
- "sloos",
31
- "lending standards",
32
- "survey of consumer finances",
33
- "scf",
34
- "wealth distribution",
35
- "median net worth",
36
- "family income",
37
- "h.8",
38
- "h.6",
39
- "money stock",
40
- "g.17",
41
- "industrial production",
42
- "charge-off",
43
- "delinquency",
44
- "debt service ratio"
45
- ],
46
- "questions": [
47
- "total consumer credit outstanding, latest month",
48
- "household and nonprofit net worth from the Financial Accounts (B.101)",
49
- "median family net worth by age or race in the 2025 Survey of Consumer Finances",
50
- "share of banks tightening standards on commercial and industrial loans (SLOOS)",
51
- "who holds Treasury securities by sector (Z.1)"
52
- ],
53
- "homepage": "https://www.federalreserve.gov/data.htm",
54
- "terms_url": "https://www.federalreserve.gov/disclaimer.htm",
55
- "auth": {
56
- "env": null,
57
- "required": "none",
58
- "placement": "none",
59
- "signup_url": null,
60
- "echoes_key": false
61
- },
62
- "limits": {
63
- "rps": 1,
64
- "burst": 3,
65
- "max_rows": 200000
66
- },
67
- "routes": {
68
- "api": {
69
- "base": "https://www.federalreserve.gov",
70
- "probe": "https://www.federalreserve.gov/releases/z1/current/z1_table_mapping.csv",
71
- "hosts": [
72
- "www.federalreserve.gov"
73
- ]
74
- },
75
- "manual": {
76
- "how": "Open each link in manual_download/INSTRUCTIONS.md in a browser and save the file under the name shown, then upload it. A Data Download Program (DDP) link given by package title opens the release's Choose page (https://www.federalreserve.gov/datadownload/Choose.aspx?rel=<release>): pick that preformatted package, click Format package, keep CSV, then Download file. Z.1 tables: https://www.federalreserve.gov/releases/z1/current/z1_csv_files.zip (upload the zip, or the one table CSV from its csv/ folder). SCF: https://www.federalreserve.gov/econres/scfindex.htm (interactive chart data scf.zip, summary tables workbook)."
77
- }
78
- },
79
- "cache": {
80
- "mode": "run_only",
81
- "ttl_hours": null,
82
- "why": "Releases update weekly to quarterly (SCF every three years); data/ is reused only within a run."
83
- },
84
- "redistribution": {
85
- "mode": "allowed",
86
- "why": "Board website terms (https://www.federalreserve.gov/disclaimer.htm): information on the Board's website is in the public domain unless otherwise indicated and may be copied and distributed without permission; cite the Board as the source."
87
- },
88
- "notices": [],
89
- "retention": null,
90
- "citation": "Board of Governors of the Federal Reserve System, {dataset}, federalreserve.gov, retrieved {retrieved_long}.",
91
- "audit_hooks": [],
92
- "clarify": [
93
- "Seasonally adjusted or not? G.19 publishes both; the headline is seasonally adjusted. Default: seasonally adjusted where it exists, named in the answer.",
94
- "Levels (amounts outstanding) or flows (transactions, often at seasonally adjusted annual rates)? Default: levels.",
95
- "SCF dollars: survey-year (nominal) or inflation-adjusted 2025 dollars? Default: 2025 dollars for comparisons across surveys, nominal for one survey year."
96
- ],
97
- "formats": [
98
- "csv",
99
- "xlsx"
100
- ],
101
- "use_instead": [
102
- {
103
- "question": "One Board series' long history or its past vintages",
104
- "source": "fred",
105
- "terms": [
106
- "ALFRED"
107
- ],
108
- "why": "FRED mirrors most Board series; ALFRED keeps vintages."
109
- },
110
- {
111
- "question": "SOFR, EFFR, SOMA holdings, primary dealer positions",
112
- "source": "nyfed",
113
- "terms": [
114
- "SOFR",
115
- "SOMA"
116
- ],
117
- "why": "The New York Fed publishes these."
118
- },
119
- {
120
- "question": "Forecasts of these series",
121
- "source": "philfed",
122
- "terms": [
123
- "Greenbook"
124
- ],
125
- "why": "SPF and Greenbook forecasts."
126
- },
127
- {
128
- "question": "Bank-level balance sheets and income",
129
- "source": "fdic",
130
- "terms": [
131
- "call report"
132
- ],
133
- "why": "FDIC institution financials."
134
- }
135
- ]
136
- }
1
+ {
2
+ "id": "fed-board",
3
+ "title": "Federal Reserve Board data (Data Download Program releases, Z.1 Financial Accounts, Survey of Consumer Finances)",
4
+ "agency": "Board of Governors of the Federal Reserve System",
5
+ "depth": "standard",
6
+ "domains": [
7
+ "household finance",
8
+ "credit",
9
+ "financial accounts",
10
+ "wealth",
11
+ "banking",
12
+ "monetary policy"
13
+ ],
14
+ "keywords": [
15
+ "federal reserve board",
16
+ "consumer credit",
17
+ "g.19",
18
+ "revolving credit",
19
+ "student loans",
20
+ "auto loans",
21
+ "financial accounts",
22
+ "flow of funds",
23
+ "z.1",
24
+ "household net worth",
25
+ "household balance sheet",
26
+ "household debt",
27
+ "sector balance sheets",
28
+ "federal government debt holders",
29
+ "senior loan officer",
30
+ "sloos",
31
+ "lending standards",
32
+ "survey of consumer finances",
33
+ "scf",
34
+ "wealth distribution",
35
+ "median net worth",
36
+ "family income",
37
+ "h.8",
38
+ "h.6",
39
+ "money stock",
40
+ "g.17",
41
+ "industrial production",
42
+ "charge-off",
43
+ "delinquency",
44
+ "debt service ratio"
45
+ ],
46
+ "questions": [
47
+ "total consumer credit outstanding, latest month",
48
+ "household and nonprofit net worth from the Financial Accounts (B.101)",
49
+ "median family net worth by age or race in the 2025 Survey of Consumer Finances",
50
+ "share of banks tightening standards on commercial and industrial loans (SLOOS)",
51
+ "who holds Treasury securities by sector (Z.1)"
52
+ ],
53
+ "homepage": "https://www.federalreserve.gov/data.htm",
54
+ "terms_url": "https://www.federalreserve.gov/disclaimer.htm",
55
+ "auth": {
56
+ "env": null,
57
+ "required": "none",
58
+ "placement": "none",
59
+ "signup_url": null,
60
+ "echoes_key": false
61
+ },
62
+ "limits": {
63
+ "rps": 1,
64
+ "burst": 3,
65
+ "max_rows": 200000
66
+ },
67
+ "routes": {
68
+ "api": {
69
+ "base": "https://www.federalreserve.gov",
70
+ "probe": "https://www.federalreserve.gov/releases/z1/current/z1_table_mapping.csv",
71
+ "hosts": [
72
+ "www.federalreserve.gov"
73
+ ]
74
+ },
75
+ "manual": {
76
+ "how": "Open each link in manual_download/INSTRUCTIONS.md in a browser and save the file under the name shown, then upload it. A Data Download Program (DDP) link given by package title opens the release's Choose page (https://www.federalreserve.gov/datadownload/Choose.aspx?rel=<release>): pick that preformatted package, click Format package, keep CSV, then Download file. Z.1 tables: https://www.federalreserve.gov/releases/z1/current/z1_csv_files.zip (upload the zip, or the one table CSV from its csv/ folder). SCF: https://www.federalreserve.gov/econres/scfindex.htm (interactive chart data scf.zip, summary tables workbook)."
77
+ }
78
+ },
79
+ "cache": {
80
+ "mode": "run_only",
81
+ "ttl_hours": null,
82
+ "why": "Releases update weekly to quarterly (SCF every three years); data/ is reused only within a run."
83
+ },
84
+ "redistribution": {
85
+ "mode": "allowed",
86
+ "why": "Board website terms (https://www.federalreserve.gov/disclaimer.htm): information on the Board's website is in the public domain unless otherwise indicated and may be copied and distributed without permission; cite the Board as the source."
87
+ },
88
+ "notices": [],
89
+ "retention": null,
90
+ "citation": "Board of Governors of the Federal Reserve System, {dataset}, federalreserve.gov, retrieved {retrieved_long}.",
91
+ "audit_hooks": [],
92
+ "clarify": [
93
+ "Seasonally adjusted or not? G.19 publishes both; the headline is seasonally adjusted. Default: seasonally adjusted where it exists, named in the answer.",
94
+ "Levels (amounts outstanding) or flows (transactions, often at seasonally adjusted annual rates)? Default: levels.",
95
+ "SCF dollars: survey-year (nominal) or inflation-adjusted 2025 dollars? Default: 2025 dollars for comparisons across surveys, nominal for one survey year."
96
+ ],
97
+ "formats": [
98
+ "csv",
99
+ "xlsx"
100
+ ],
101
+ "use_instead": [
102
+ {
103
+ "question": "One Board series' long history or its past vintages",
104
+ "source": "fred",
105
+ "terms": [
106
+ "ALFRED"
107
+ ],
108
+ "why": "FRED mirrors most Board series; ALFRED keeps vintages."
109
+ },
110
+ {
111
+ "question": "SOFR, EFFR, SOMA holdings, primary dealer positions",
112
+ "source": "nyfed",
113
+ "terms": [
114
+ "SOFR",
115
+ "SOMA"
116
+ ],
117
+ "why": "The New York Fed publishes these."
118
+ },
119
+ {
120
+ "question": "Forecasts of these series",
121
+ "source": "philfed",
122
+ "terms": [
123
+ "Greenbook"
124
+ ],
125
+ "why": "SPF and Greenbook forecasts."
126
+ },
127
+ {
128
+ "question": "Bank-level balance sheets and income",
129
+ "source": "fdic",
130
+ "terms": [
131
+ "call report"
132
+ ],
133
+ "why": "FDIC institution financials."
134
+ }
135
+ ]
136
+ }
@@ -1,143 +1,143 @@
1
- {
2
- "base_url": "https://www.federalregister.gov/api/v1",
3
- "endpoints": {
4
- "documents": {
5
- "path": "/documents.json",
6
- "method": "GET",
7
- "description": "Search published Federal Register documents (rules, proposed rules, notices, presidential documents) since 1994. Filters are conditions[...] parameters; at most 10,000 documents per query.",
8
- "params": {
9
- "conditions[term]": {"desc": "full-text words, e.g. 'tariff' or '\"greenhouse gas\"'"},
10
- "conditions[type][]": {"desc": "RULE | PRORULE | NOTICE | PRESDOCU (a list gives several)"},
11
- "conditions[agencies][]": {"desc": "agency slug(s), e.g. environmental-protection-agency (endpoint 'agencies' lists them)"},
12
- "conditions[presidential_document_type][]": {"desc": "executive_order | memorandum | proclamation | notice | determination | ..."},
13
- "conditions[president][]": {"desc": "president slug: donald-trump, joe-biden, barack-obama, george-w-bush, william-j-clinton"},
14
- "conditions[publication_date][gte]": {"desc": "published on or after YYYY-MM-DD"},
15
- "conditions[publication_date][lte]": {"desc": "published on or before YYYY-MM-DD"},
16
- "conditions[publication_date][year]": {"desc": "publication year, e.g. 2025"},
17
- "conditions[effective_date][gte]": {"desc": "effective on or after YYYY-MM-DD"},
18
- "conditions[signing_date][gte]": {"desc": "presidential documents signed on or after YYYY-MM-DD"},
19
- "conditions[significant]": {"desc": "1 = deemed significant under EO 12866 (Unified Agenda flag)"},
20
- "conditions[docket_id]": {"desc": "agency docket number, e.g. EPA-HQ-OAR-2023-0072"},
21
- "conditions[regulation_id_number]": {"desc": "RIN, e.g. 2060-AV09"},
22
- "conditions[cfr][title]": {"desc": "CFR title number affected"},
23
- "conditions[cfr][part]": {"desc": "CFR part affected (with conditions[cfr][title])"},
24
- "conditions[correction]": {"desc": "0 = leave out correction notices (default), 1 = only corrections"},
25
- "order": {"desc": "newest (default) | oldest | relevance | executive_order_number"},
26
- "fields[]": {"desc": "list of fields to return (default: a useful set; see source.md)"}
27
- },
28
- "defaults": {
29
- "order": "newest",
30
- "conditions[correction]": "0",
31
- "fields[]": ["document_number", "citation", "publication_date", "signing_date", "effective_on", "type", "subtype",
32
- "title", "abstract", "action", "agency_names", "executive_order_number", "proclamation_number",
33
- "president", "docket_ids", "regulation_id_numbers", "significant", "comments_close_on",
34
- "page_length", "start_page", "end_page", "html_url", "pdf_url"]
35
- },
36
- "records": "results",
37
- "total": "count",
38
- "paging": {"type": "page", "page_param": "page", "size_param": "per_page", "size": 1000, "start": 1},
39
- "max_rows": 10000,
40
- "missing": [""]
41
- },
42
- "executive_orders": {
43
- "path": "/documents.json",
44
- "method": "GET",
45
- "description": "Executive orders (documents with type PRESDOCU and presidential_document_type executive_order); filter by president, year or words.",
46
- "params": {
47
- "conditions[president][]": {"desc": "president slug, e.g. donald-trump, joe-biden, barack-obama"},
48
- "conditions[term]": {"desc": "full-text words"},
49
- "conditions[publication_date][year]": {"desc": "publication year"},
50
- "conditions[publication_date][gte]": {"desc": "YYYY-MM-DD"},
51
- "conditions[publication_date][lte]": {"desc": "YYYY-MM-DD"},
52
- "conditions[signing_date][gte]": {"desc": "signed on or after YYYY-MM-DD"},
53
- "conditions[signing_date][lte]": {"desc": "signed on or before YYYY-MM-DD"},
54
- "order": {"desc": "newest (default) | oldest | executive_order_number"},
55
- "fields[]": {"desc": "fields to return"}
56
- },
57
- "defaults": {
58
- "conditions[type][]": "PRESDOCU",
59
- "conditions[presidential_document_type][]": "executive_order",
60
- "conditions[correction]": "0",
61
- "order": "newest",
62
- "fields[]": ["executive_order_number", "document_number", "citation", "title", "signing_date", "publication_date",
63
- "president", "disposition_notes", "html_url", "pdf_url"]
64
- },
65
- "records": "results",
66
- "total": "count",
67
- "paging": {"type": "page", "page_param": "page", "size_param": "per_page", "size": 1000, "start": 1},
68
- "max_rows": 10000
69
- },
70
- "document_counts": {
71
- "path": "/documents/facets/{facet}",
72
- "method": "GET",
73
- "description": "Counts of documents matching the same conditions[...] filters, grouped by a facet: daily, weekly, monthly, quarterly, yearly, agency, topic, section, type, subtype. One row per group (key, name, count).",
74
- "params": {
75
- "facet": {"in": "path", "required": true, "enum": ["daily", "weekly", "monthly", "quarterly", "yearly", "agency", "topic", "section", "type", "subtype"], "desc": "grouping"},
76
- "conditions[term]": {"desc": "full-text words"},
77
- "conditions[type][]": {"desc": "RULE | PRORULE | NOTICE | PRESDOCU"},
78
- "conditions[agencies][]": {"desc": "agency slug(s)"},
79
- "conditions[presidential_document_type][]": {"desc": "executive_order, ..."},
80
- "conditions[president][]": {"desc": "president slug"},
81
- "conditions[publication_date][gte]": {"desc": "YYYY-MM-DD"},
82
- "conditions[publication_date][lte]": {"desc": "YYYY-MM-DD"},
83
- "conditions[publication_date][year]": {"desc": "year"},
84
- "conditions[significant]": {"desc": "1 = significant only"},
85
- "conditions[correction]": {"desc": "0 = leave out corrections (counts include them by default, as OFR's statistics do)"}
86
- },
87
- "defaults": {},
88
- "records": "",
89
- "paging": {"type": "none"},
90
- "flatten": true
91
- },
92
- "document": {
93
- "path": "/documents/{document_number}.json",
94
- "method": "GET",
95
- "description": "One document's full metadata: dates, docket, RIN, CFR references, comment deadline, links to full text.",
96
- "params": {"document_number": {"in": "path", "required": true, "desc": "e.g. 2025-01759"}},
97
- "records": "",
98
- "paging": {"type": "none"}
99
- },
100
- "public_inspection_current": {
101
- "path": "/public-inspection-documents/current.json",
102
- "method": "GET",
103
- "description": "Documents on public inspection now: filed and scheduled for publication (usually the next business day).",
104
- "params": {},
105
- "records": "results",
106
- "total": "count",
107
- "paging": {"type": "none"}
108
- },
109
- "public_inspection": {
110
- "path": "/public-inspection-documents.json",
111
- "method": "GET",
112
- "description": "Documents that were on public inspection on a given date.",
113
- "params": {
114
- "conditions[available_on]": {"required": true, "desc": "YYYY-MM-DD"},
115
- "conditions[agencies][]": {"desc": "agency slug(s)"},
116
- "conditions[type][]": {"desc": "RULE | PRORULE | NOTICE | PRESDOCU"},
117
- "conditions[special_filing]": {"desc": "1 = special (expedited) filings only"}
118
- },
119
- "records": "results",
120
- "total": "count",
121
- "paging": {"type": "none"}
122
- },
123
- "agencies": {
124
- "path": "/agencies",
125
- "method": "GET",
126
- "description": "Every Federal Register agency: id, name, short name, slug (use the slug in conditions[agencies][]), parent.",
127
- "params": {},
128
- "records": "",
129
- "paging": {"type": "none"}
130
- }
131
- },
132
- "catalog": {
133
- "rules": {"id": "RULE", "name": "Final rules", "description": "conditions[type][] = RULE: final rules and interim final rules", "endpoint": "documents"},
134
- "proposed_rules": {"id": "PRORULE", "name": "Proposed rules", "description": "conditions[type][] = PRORULE: notices of proposed rulemaking, ANPRMs", "endpoint": "documents"},
135
- "notices": {"id": "NOTICE", "name": "Notices", "description": "conditions[type][] = NOTICE: agency notices (meetings, grants, determinations)", "endpoint": "documents"},
136
- "presidential_documents": {"id": "PRESDOCU", "name": "Presidential documents", "description": "conditions[type][] = PRESDOCU: executive orders, proclamations, memoranda, determinations", "endpoint": "documents"},
137
- "executive_orders": {"id": "executive_order", "name": "Executive orders", "description": "endpoint executive_orders: EOs by president, year or words", "endpoint": "executive_orders"},
138
- "counts_by_year": {"id": "yearly", "name": "Document counts by year", "description": "endpoint document_counts with facet yearly: rule or EO counts per year", "endpoint": "document_counts"},
139
- "counts_by_agency": {"id": "agency", "name": "Document counts by agency", "description": "endpoint document_counts with facet agency", "endpoint": "document_counts"},
140
- "public_inspection": {"id": "current", "name": "Public inspection", "description": "documents filed for publication tomorrow (public_inspection_current)", "endpoint": "public_inspection_current"},
141
- "president_slugs": {"id": "donald-trump; joe-biden; barack-obama; george-w-bush; william-j-clinton", "name": "President slugs", "description": "values for conditions[president][]", "endpoint": "executive_orders"}
142
- }
143
- }
1
+ {
2
+ "base_url": "https://www.federalregister.gov/api/v1",
3
+ "endpoints": {
4
+ "documents": {
5
+ "path": "/documents.json",
6
+ "method": "GET",
7
+ "description": "Search published Federal Register documents (rules, proposed rules, notices, presidential documents) since 1994. Filters are conditions[...] parameters; at most 10,000 documents per query.",
8
+ "params": {
9
+ "conditions[term]": {"desc": "full-text words, e.g. 'tariff' or '\"greenhouse gas\"'"},
10
+ "conditions[type][]": {"desc": "RULE | PRORULE | NOTICE | PRESDOCU (a list gives several)"},
11
+ "conditions[agencies][]": {"desc": "agency slug(s), e.g. environmental-protection-agency (endpoint 'agencies' lists them)"},
12
+ "conditions[presidential_document_type][]": {"desc": "executive_order | memorandum | proclamation | notice | determination | ..."},
13
+ "conditions[president][]": {"desc": "president slug: donald-trump, joe-biden, barack-obama, george-w-bush, william-j-clinton"},
14
+ "conditions[publication_date][gte]": {"desc": "published on or after YYYY-MM-DD"},
15
+ "conditions[publication_date][lte]": {"desc": "published on or before YYYY-MM-DD"},
16
+ "conditions[publication_date][year]": {"desc": "publication year, e.g. 2025"},
17
+ "conditions[effective_date][gte]": {"desc": "effective on or after YYYY-MM-DD"},
18
+ "conditions[signing_date][gte]": {"desc": "presidential documents signed on or after YYYY-MM-DD"},
19
+ "conditions[significant]": {"desc": "1 = deemed significant under EO 12866 (Unified Agenda flag)"},
20
+ "conditions[docket_id]": {"desc": "agency docket number, e.g. EPA-HQ-OAR-2023-0072"},
21
+ "conditions[regulation_id_number]": {"desc": "RIN, e.g. 2060-AV09"},
22
+ "conditions[cfr][title]": {"desc": "CFR title number affected"},
23
+ "conditions[cfr][part]": {"desc": "CFR part affected (with conditions[cfr][title])"},
24
+ "conditions[correction]": {"desc": "0 = leave out correction notices (default), 1 = only corrections"},
25
+ "order": {"desc": "newest (default) | oldest | relevance | executive_order_number"},
26
+ "fields[]": {"desc": "list of fields to return (default: a useful set; see source.md)"}
27
+ },
28
+ "defaults": {
29
+ "order": "newest",
30
+ "conditions[correction]": "0",
31
+ "fields[]": ["document_number", "citation", "publication_date", "signing_date", "effective_on", "type", "subtype",
32
+ "title", "abstract", "action", "agency_names", "executive_order_number", "proclamation_number",
33
+ "president", "docket_ids", "regulation_id_numbers", "significant", "comments_close_on",
34
+ "page_length", "start_page", "end_page", "html_url", "pdf_url"]
35
+ },
36
+ "records": "results",
37
+ "total": "count",
38
+ "paging": {"type": "page", "page_param": "page", "size_param": "per_page", "size": 1000, "start": 1},
39
+ "max_rows": 10000,
40
+ "missing": [""]
41
+ },
42
+ "executive_orders": {
43
+ "path": "/documents.json",
44
+ "method": "GET",
45
+ "description": "Executive orders (documents with type PRESDOCU and presidential_document_type executive_order); filter by president, year or words.",
46
+ "params": {
47
+ "conditions[president][]": {"desc": "president slug, e.g. donald-trump, joe-biden, barack-obama"},
48
+ "conditions[term]": {"desc": "full-text words"},
49
+ "conditions[publication_date][year]": {"desc": "publication year"},
50
+ "conditions[publication_date][gte]": {"desc": "YYYY-MM-DD"},
51
+ "conditions[publication_date][lte]": {"desc": "YYYY-MM-DD"},
52
+ "conditions[signing_date][gte]": {"desc": "signed on or after YYYY-MM-DD"},
53
+ "conditions[signing_date][lte]": {"desc": "signed on or before YYYY-MM-DD"},
54
+ "order": {"desc": "newest (default) | oldest | executive_order_number"},
55
+ "fields[]": {"desc": "fields to return"}
56
+ },
57
+ "defaults": {
58
+ "conditions[type][]": "PRESDOCU",
59
+ "conditions[presidential_document_type][]": "executive_order",
60
+ "conditions[correction]": "0",
61
+ "order": "newest",
62
+ "fields[]": ["executive_order_number", "document_number", "citation", "title", "signing_date", "publication_date",
63
+ "president", "disposition_notes", "html_url", "pdf_url"]
64
+ },
65
+ "records": "results",
66
+ "total": "count",
67
+ "paging": {"type": "page", "page_param": "page", "size_param": "per_page", "size": 1000, "start": 1},
68
+ "max_rows": 10000
69
+ },
70
+ "document_counts": {
71
+ "path": "/documents/facets/{facet}",
72
+ "method": "GET",
73
+ "description": "Counts of documents matching the same conditions[...] filters, grouped by a facet: daily, weekly, monthly, quarterly, yearly, agency, topic, section, type, subtype. One row per group (key, name, count).",
74
+ "params": {
75
+ "facet": {"in": "path", "required": true, "enum": ["daily", "weekly", "monthly", "quarterly", "yearly", "agency", "topic", "section", "type", "subtype"], "desc": "grouping"},
76
+ "conditions[term]": {"desc": "full-text words"},
77
+ "conditions[type][]": {"desc": "RULE | PRORULE | NOTICE | PRESDOCU"},
78
+ "conditions[agencies][]": {"desc": "agency slug(s)"},
79
+ "conditions[presidential_document_type][]": {"desc": "executive_order, ..."},
80
+ "conditions[president][]": {"desc": "president slug"},
81
+ "conditions[publication_date][gte]": {"desc": "YYYY-MM-DD"},
82
+ "conditions[publication_date][lte]": {"desc": "YYYY-MM-DD"},
83
+ "conditions[publication_date][year]": {"desc": "year"},
84
+ "conditions[significant]": {"desc": "1 = significant only"},
85
+ "conditions[correction]": {"desc": "0 = leave out corrections (counts include them by default, as OFR's statistics do)"}
86
+ },
87
+ "defaults": {},
88
+ "records": "",
89
+ "paging": {"type": "none"},
90
+ "flatten": true
91
+ },
92
+ "document": {
93
+ "path": "/documents/{document_number}.json",
94
+ "method": "GET",
95
+ "description": "One document's full metadata: dates, docket, RIN, CFR references, comment deadline, links to full text.",
96
+ "params": {"document_number": {"in": "path", "required": true, "desc": "e.g. 2025-01759"}},
97
+ "records": "",
98
+ "paging": {"type": "none"}
99
+ },
100
+ "public_inspection_current": {
101
+ "path": "/public-inspection-documents/current.json",
102
+ "method": "GET",
103
+ "description": "Documents on public inspection now: filed and scheduled for publication (usually the next business day).",
104
+ "params": {},
105
+ "records": "results",
106
+ "total": "count",
107
+ "paging": {"type": "none"}
108
+ },
109
+ "public_inspection": {
110
+ "path": "/public-inspection-documents.json",
111
+ "method": "GET",
112
+ "description": "Documents that were on public inspection on a given date.",
113
+ "params": {
114
+ "conditions[available_on]": {"required": true, "desc": "YYYY-MM-DD"},
115
+ "conditions[agencies][]": {"desc": "agency slug(s)"},
116
+ "conditions[type][]": {"desc": "RULE | PRORULE | NOTICE | PRESDOCU"},
117
+ "conditions[special_filing]": {"desc": "1 = special (expedited) filings only"}
118
+ },
119
+ "records": "results",
120
+ "total": "count",
121
+ "paging": {"type": "none"}
122
+ },
123
+ "agencies": {
124
+ "path": "/agencies",
125
+ "method": "GET",
126
+ "description": "Every Federal Register agency: id, name, short name, slug (use the slug in conditions[agencies][]), parent.",
127
+ "params": {},
128
+ "records": "",
129
+ "paging": {"type": "none"}
130
+ }
131
+ },
132
+ "catalog": {
133
+ "rules": {"id": "RULE", "name": "Final rules", "description": "conditions[type][] = RULE: final rules and interim final rules", "endpoint": "documents"},
134
+ "proposed_rules": {"id": "PRORULE", "name": "Proposed rules", "description": "conditions[type][] = PRORULE: notices of proposed rulemaking, ANPRMs", "endpoint": "documents"},
135
+ "notices": {"id": "NOTICE", "name": "Notices", "description": "conditions[type][] = NOTICE: agency notices (meetings, grants, determinations)", "endpoint": "documents"},
136
+ "presidential_documents": {"id": "PRESDOCU", "name": "Presidential documents", "description": "conditions[type][] = PRESDOCU: executive orders, proclamations, memoranda, determinations", "endpoint": "documents"},
137
+ "executive_orders": {"id": "executive_order", "name": "Executive orders", "description": "endpoint executive_orders: EOs by president, year or words", "endpoint": "executive_orders"},
138
+ "counts_by_year": {"id": "yearly", "name": "Document counts by year", "description": "endpoint document_counts with facet yearly: rule or EO counts per year", "endpoint": "document_counts"},
139
+ "counts_by_agency": {"id": "agency", "name": "Document counts by agency", "description": "endpoint document_counts with facet agency", "endpoint": "document_counts"},
140
+ "public_inspection": {"id": "current", "name": "Public inspection", "description": "documents filed for publication tomorrow (public_inspection_current)", "endpoint": "public_inspection_current"},
141
+ "president_slugs": {"id": "donald-trump; joe-biden; barack-obama; george-w-bush; william-j-clinton", "name": "President slugs", "description": "values for conditions[president][]", "endpoint": "executive_orders"}
142
+ }
143
+ }