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,93 +1,93 @@
1
- {
2
- "id": "fec",
3
- "title": "OpenFEC (Federal Election Commission API)",
4
- "agency": "Federal Election Commission",
5
- "depth": "standard",
6
- "domains": [
7
- "elections",
8
- "campaign finance",
9
- "legislation"
10
- ],
11
- "keywords": [
12
- "fec",
13
- "campaign finance",
14
- "campaign contributions",
15
- "donors",
16
- "fundraising",
17
- "pac",
18
- "super pac",
19
- "political action committee",
20
- "candidate",
21
- "independent expenditures",
22
- "outside spending",
23
- "itemized contributions",
24
- "small donors",
25
- "disbursements",
26
- "election",
27
- "race"
28
- ],
29
- "questions": [
30
- "how much did each Senate candidate raise in a race",
31
- "outside spending for or against a candidate",
32
- "share of a candidate's money from small donors",
33
- "contributions from employees of a company",
34
- "where a PAC's money went"
35
- ],
36
- "homepage": "https://www.fec.gov/data/",
37
- "terms_url": "https://www.fec.gov/updates/sale-or-use-contributor-information/",
38
- "auth": {
39
- "env": "DATA_GOV_API_KEY",
40
- "required": "optional",
41
- "placement": "query",
42
- "param": "api_key",
43
- "home": "data-gov",
44
- "signup_url": "https://api.data.gov/signup/",
45
- "echoes_key": false,
46
- "demo_key": "DEMO_KEY",
47
- "key_only": [
48
- "more than a few requests an hour (DEMO_KEY limit); itemized schedules page 100 rows per request"
49
- ]
50
- },
51
- "limits": {
52
- "rps": 1,
53
- "burst": 4,
54
- "daily_quota": null,
55
- "max_rows": 50000
56
- },
57
- "routes": {
58
- "api": {
59
- "base": "https://api.open.fec.gov/v1",
60
- "probe": "https://api.open.fec.gov/v1/candidates/?per_page=1",
61
- "hosts": [
62
- "api.open.fec.gov"
63
- ]
64
- },
65
- "manual": {
66
- "how": "Open the links in INSTRUCTIONS.md in a browser (they carry the public DEMO_KEY; put your own api.data.gov key in its place for more) and save each JSON file; or use https://www.fec.gov/data/ (candidates, committees, receipts, disbursements, independent expenditures), set the same filters, click Export to download a CSV, and upload it. Bulk files: https://www.fec.gov/data/browse-data/?tab=bulk-data."
67
- }
68
- },
69
- "cache": {
70
- "mode": "run_only",
71
- "ttl_hours": null,
72
- "why": "Filings and amendments arrive daily and totals are revised; data/ is reused within a run."
73
- },
74
- "redistribution": {
75
- "mode": "allowed",
76
- "why": "FEC data are public records and U.S. government works. Federal law (52 U.S.C. 30111(a)(4)) forbids selling or using information about individual contributors (names, addresses) to solicit contributions or for any commercial purpose; aggregate tables and committee data may be published freely. Keep contributor-level rows out of anything used for solicitation or commercial purposes."
77
- },
78
- "notices": [
79
- "Contributor information from FEC reports may not be sold or used by any person to solicit contributions or for commercial purposes (52 U.S.C. 30111(a)(4)); this analysis uses it only for research."
80
- ],
81
- "retention": null,
82
- "citation": "Federal Election Commission, OpenFEC API, {dataset}, api.open.fec.gov, retrieved {retrieved_long}.",
83
- "audit_hooks": [],
84
- "clarify": [
85
- "Two-year cycle or the whole election period? Senate totals over 6 years differ from one 2-year cycle; default election_full=true for races.",
86
- "Candidate committees only, or outside spending too (super PACs, independent expenditures)?",
87
- "Itemized contributions only (over $200) or totals including unitemized small donations? Itemized rows miss most small donors."
88
- ],
89
- "formats": [
90
- "json",
91
- "csv"
92
- ]
93
- }
1
+ {
2
+ "id": "fec",
3
+ "title": "OpenFEC (Federal Election Commission API)",
4
+ "agency": "Federal Election Commission",
5
+ "depth": "standard",
6
+ "domains": [
7
+ "elections",
8
+ "campaign finance",
9
+ "legislation"
10
+ ],
11
+ "keywords": [
12
+ "fec",
13
+ "campaign finance",
14
+ "campaign contributions",
15
+ "donors",
16
+ "fundraising",
17
+ "pac",
18
+ "super pac",
19
+ "political action committee",
20
+ "candidate",
21
+ "independent expenditures",
22
+ "outside spending",
23
+ "itemized contributions",
24
+ "small donors",
25
+ "disbursements",
26
+ "election",
27
+ "race"
28
+ ],
29
+ "questions": [
30
+ "how much did each Senate candidate raise in a race",
31
+ "outside spending for or against a candidate",
32
+ "share of a candidate's money from small donors",
33
+ "contributions from employees of a company",
34
+ "where a PAC's money went"
35
+ ],
36
+ "homepage": "https://www.fec.gov/data/",
37
+ "terms_url": "https://www.fec.gov/updates/sale-or-use-contributor-information/",
38
+ "auth": {
39
+ "env": "DATA_GOV_API_KEY",
40
+ "required": "optional",
41
+ "placement": "query",
42
+ "param": "api_key",
43
+ "home": "data-gov",
44
+ "signup_url": "https://api.data.gov/signup/",
45
+ "echoes_key": false,
46
+ "demo_key": "DEMO_KEY",
47
+ "key_only": [
48
+ "more than a few requests an hour (DEMO_KEY limit); itemized schedules page 100 rows per request"
49
+ ]
50
+ },
51
+ "limits": {
52
+ "rps": 1,
53
+ "burst": 4,
54
+ "daily_quota": null,
55
+ "max_rows": 50000
56
+ },
57
+ "routes": {
58
+ "api": {
59
+ "base": "https://api.open.fec.gov/v1",
60
+ "probe": "https://api.open.fec.gov/v1/candidates/?per_page=1",
61
+ "hosts": [
62
+ "api.open.fec.gov"
63
+ ]
64
+ },
65
+ "manual": {
66
+ "how": "Open the links in INSTRUCTIONS.md in a browser (they carry the public DEMO_KEY; put your own api.data.gov key in its place for more) and save each JSON file; or use https://www.fec.gov/data/ (candidates, committees, receipts, disbursements, independent expenditures), set the same filters, click Export to download a CSV, and upload it. Bulk files: https://www.fec.gov/data/browse-data/?tab=bulk-data."
67
+ }
68
+ },
69
+ "cache": {
70
+ "mode": "run_only",
71
+ "ttl_hours": null,
72
+ "why": "Filings and amendments arrive daily and totals are revised; data/ is reused within a run."
73
+ },
74
+ "redistribution": {
75
+ "mode": "allowed",
76
+ "why": "FEC data are public records and U.S. government works. Federal law (52 U.S.C. 30111(a)(4)) forbids selling or using information about individual contributors (names, addresses) to solicit contributions or for any commercial purpose; aggregate tables and committee data may be published freely. Keep contributor-level rows out of anything used for solicitation or commercial purposes."
77
+ },
78
+ "notices": [
79
+ "Contributor information from FEC reports may not be sold or used by any person to solicit contributions or for commercial purposes (52 U.S.C. 30111(a)(4)); this analysis uses it only for research."
80
+ ],
81
+ "retention": null,
82
+ "citation": "Federal Election Commission, OpenFEC API, {dataset}, api.open.fec.gov, retrieved {retrieved_long}.",
83
+ "audit_hooks": [],
84
+ "clarify": [
85
+ "Two-year cycle or the whole election period? Senate totals over 6 years differ from one 2-year cycle; default election_full=true for races.",
86
+ "Candidate committees only, or outside spending too (super PACs, independent expenditures)?",
87
+ "Itemized contributions only (over $200) or totals including unitemized small donations? Itemized rows miss most small donors."
88
+ ],
89
+ "formats": [
90
+ "json",
91
+ "csv"
92
+ ]
93
+ }
@@ -1,89 +1,89 @@
1
- {
2
- "base_url": "https://www.federalreserve.gov",
3
- "timeout": 120,
4
- "endpoints": {
5
- "ddp": {
6
- "path": "/datadownload/Output.aspx",
7
- "description": "One preformatted Data Download Program package of a Board release as CSV, reshaped to one row per series and date: date, series, value, value_flag (ND = no data), description, unit, multiplier, currency, unique_id. The value times multiplier is in unit (Currency x 1000000 = millions of dollars).",
8
- "params": {
9
- "rel": {"in": "spec", "desc": "release code: G19 (consumer credit), Z1 (Financial Accounts), SLOOS, SCOOS, H8 (bank balance sheets), H6 (money stock), H15 (interest rates), H41 (Fed balance sheet), G17 (industrial production), G20 (finance companies), CHGDEL (charge-offs and delinquencies), DSR / FOR (debt service ratios), CP (commercial paper), H10 (exchange rates), H3, E2, PRATES. Optional with a catalog package alias"},
10
- "package": {"in": "spec", "required": true, "catalog": true, "desc": "the package: its 32-character id, its title as listed by ddp_packages (exact, or a unique start or part: 'Consumer Credit Outstanding (S.A.)', 'S1M.b (Q)'), or a catalog alias (g19_all, g19_sa, sloos, z1_b101 ...)"},
11
- "series_ids": {"in": "spec", "desc": "optional list of series codes (the Time Period header, e.g. DTCTL.M) or unique identifiers (G19/CCOUT/DTCTL.M) to keep"},
12
- "lastobs": {"in": "spec", "desc": "optional: only the last N observations of each series (applied by the pack to the whole package)"},
13
- "from": {"in": "spec", "desc": "optional first date: YYYY, YYYY-MM, YYYY-MM-DD or YYYYQn (applied by the pack)"},
14
- "to": {"in": "spec", "desc": "optional last date, inclusive: YYYY, YYYY-MM, YYYY-MM-DD or YYYYQn"}
15
- },
16
- "records": "$csv",
17
- "paging": {"type": "none"},
18
- "max_rows": 300000
19
- },
20
- "ddp_packages": {
21
- "path": "/datadownload/Choose.aspx",
22
- "description": "The preformatted packages of one release (scraped from its Choose page): package_title, package (id), listed (format, default observations, size).",
23
- "params": {
24
- "rel": {"in": "query", "required": true, "desc": "release code, e.g. G19, Z1 (435 packages), SLOOS"}
25
- },
26
- "records": "$csv",
27
- "paging": {"type": "none"}
28
- },
29
- "z1": {
30
- "path": "/releases/z1/current/z1_csv_files.zip",
31
- "description": "One table of the Financial Accounts of the United States (Z.1) from the Board's bulk CSV zip (8 MB, current release), one row per series and date: date (1945:Q4 ... 2026:Q2), series, value (millions of dollars unless the units say otherwise), value_flag (ND), description, line, units, table, table_published.",
32
- "params": {
33
- "table": {"in": "spec", "required": true, "desc": "table code, new style (S1M.b, S1M.s, F3.2.s, S1311.s) or the published name it replaced (B.101, L.101, F.101, L.210, L.106); z1_tables lists both"},
34
- "series_ids": {"in": "spec", "desc": "optional list of series codes to keep, e.g. FL152000005.Q (with or without the .Q)"},
35
- "start": {"in": "spec", "desc": "optional first date, YYYY or YYYY:Qn"},
36
- "end": {"in": "spec", "desc": "optional last date, YYYY or YYYY:Qn"}
37
- },
38
- "records": "$zip:csv/*.csv",
39
- "paging": {"type": "none"}
40
- },
41
- "z1_tables": {
42
- "path": "/releases/z1/current/z1_table_mapping.csv",
43
- "description": "Z.1 table list: new (the code the zip and DDP use, e.g. S1M.b), old (the published table name, e.g. B.101), title.",
44
- "params": {},
45
- "records": "$csv",
46
- "paging": {"type": "none"}
47
- },
48
- "scf_chart": {
49
- "path": "/econres/scf/dataviz/download/zips/scf.zip",
50
- "description": "Survey of Consumer Finances interactive chart data, 1989-2025 (triennial): one row per survey year and group (Category), one column per item (Before_Tax_Income, Net_Worth, Assets, Financial_Assets, Retirement_Accounts, Primary_Residence, Debt, Credit_Card_Balances, Education_Installment_Loans ...). Mean and median in thousands of 2025 dollars; have = percent of families holding the item.",
51
- "params": {
52
- "group": {"in": "spec", "required": true, "enum": ["all", "agecl", "edcl", "famstruct", "housecl", "inccat", "nwcat", "occat1", "occat2", "racecl4"], "desc": "family grouping: all, agecl (age of head), edcl (education), famstruct, housecl (owner/renter), inccat (income percentile), nwcat (net worth percentile), occat1 / occat2 (work status / occupation), racecl4 (race and ethnicity)"},
53
- "stat": {"in": "spec", "required": true, "enum": ["median", "mean", "have"], "desc": "median or mean (among families that hold the item, thousands of 2025 dollars) or have (percent of families holding it)"}
54
- },
55
- "records": "$zip:*.csv",
56
- "paging": {"type": "none"}
57
- },
58
- "scf_table": {
59
- "path": "/econres/files/{file}.xlsx",
60
- "description": "One sheet of the 2025 SCF published summary tables (1989-2025), as a raw grid: row (sheet row number) and c1..cN (cells as stored); the sheets have titles and multi-row headers, so read the grid, do not expect tidy columns.",
61
- "params": {
62
- "file": {"in": "path", "required": true, "enum": ["scf2025_tables_public_real_historical", "scf2025_tables_public_nominal_historical"], "desc": "real = thousands of 2025 dollars; nominal = dollars of each survey year"},
63
- "sheet": {"in": "spec", "required": true, "desc": "sheet name, e.g. 'Table 4' (net worth by family characteristics), 'Table 1 01-25' (income); a wrong name lists the sheets"}
64
- },
65
- "records": "$xlsx",
66
- "paging": {"type": "none"}
67
- }
68
- },
69
- "catalog": {
70
- "g19_all": {"id": "56a37b655eef16e2ede83467282a6e95", "rel": "G19", "endpoint": "ddp", "name": "G.19 Consumer Credit Outstanding - All", "description": "monthly since 1943: totals, revolving, nonrevolving, SA and NSA levels, percent changes, holders (millions of dollars)"},
71
- "g19_sa": {"id": "696245eb361e0a8bc89b8e5b01cc971b", "rel": "G19", "endpoint": "ddp", "name": "G.19 Consumer Credit Outstanding (S.A.)", "description": "seasonally adjusted totals and percent changes (headline)"},
72
- "g19_terms": {"id": "10264fd36110a9c4906bd99f1daccf29", "rel": "G19", "endpoint": "ddp", "name": "G.19 Terms of Credit", "description": "interest rates on credit cards, auto loans, personal loans; loan terms"},
73
- "g19_holders_nsa": {"id": "417121472f75218035c6ba3770a5ebf5", "rel": "G19", "endpoint": "ddp", "name": "G.19 Major Holders (N.S.A.)", "description": "consumer credit by holder: banks, finance companies, credit unions, federal government (student loans), ..."},
74
- "g19_flows": {"id": "8605d1da650f3e18ed4d8ebd31c1cab2", "rel": "G19", "endpoint": "ddp", "name": "G.19 Consumer Credit Outstanding - (Flow)", "description": "monthly changes (flows)"},
75
- "sloos": {"id": "e64f07187815f0e7ed89237d8cb91eeb", "rel": "SLOOS", "endpoint": "ddp", "name": "Senior Loan Officer Opinion Survey - All chart data", "description": "quarterly net percentages of banks tightening standards and reporting stronger demand, by loan type"},
76
- "scoos": {"id": "d7ddcd636ef03b879c632a42477a0535", "rel": "SCOOS", "endpoint": "ddp", "name": "Senior Credit Officer Opinion Survey - all active questions", "description": "dealer financing terms, quarterly since 2010:Q2"},
77
- "z1_b101": {"id": "551e7dfea97fff844e2d605f0716a500", "rel": "Z1", "endpoint": "ddp", "name": "Z.1 S1M.b (Q) Households and nonprofit organizations balance sheet (B.101)", "description": "quarterly balance sheet, net worth, millions of dollars"},
78
- "z1_l101": {"id": "fe354c3d420803392448004ea863b975", "rel": "Z1", "endpoint": "ddp", "name": "Z.1 S1M.s (Q) Households and nonprofit organizations levels (L.101)", "description": "financial assets and liabilities outstanding"},
79
- "z1_f101": {"id": "088b1e81bdf443c73231e042c3a744db", "rel": "Z1", "endpoint": "ddp", "name": "Z.1 S1M.t (Q) Households and nonprofit organizations transactions (F.101)", "description": "flows, seasonally adjusted annual rates"},
80
- "z1_l106": {"id": "43e1df4e46d36e9501b35cd92bc7266f", "rel": "Z1", "endpoint": "ddp", "name": "Z.1 S1311.s (Q) Federal government levels (L.106)", "description": "federal financial assets and liabilities"},
81
- "h15_treasury_cmt": {"id": "bf17364827e38702b42a58cf8eaa3f78", "rel": "H15", "endpoint": "ddp", "name": "H.15 Treasury Constant Maturities", "description": "daily market yields, 1-month to 30-year (also in treasury-yields and fred)"},
82
- "h6_monthly": {"id": "798e2796917702a5f8423426ba7e6b42", "rel": "H6", "endpoint": "ddp", "name": "H.6 M1, M2 and other release data, monthly", "description": "billions of dollars"},
83
- "h8_all_banks_sa": {"id": "17951c643555bee48d63bb6957a4a92e", "rel": "H8", "endpoint": "ddp", "name": "H.8 All Commercial Banks, SA (Weekly)", "description": "assets and liabilities of commercial banks, weekly, seasonally adjusted"},
84
- "g17_summary": {"id": "809009461b1cba2fd5b4cf5557d9d663", "rel": "G17", "endpoint": "ddp", "name": "G.17 Summary Table Data", "description": "industrial production and capacity utilization summary"},
85
- "chgdel_rates_all": {"id": "929faaa8d5e6bf375839d7fc2b7760fe", "rel": "CHGDEL", "endpoint": "ddp", "name": "Charge-off rates/All banks", "description": "quarterly charge-off rates by loan type, percent"},
86
- "debt_service": {"id": "e38200c11a744800391ad51150cee181", "rel": "DSR", "endpoint": "ddp", "name": "Household Debt Service Ratios", "description": "quarterly, percent of disposable income"},
87
- "prates_daily": {"id": "c27939ee810cb2e929a920a6bd77d9f6", "rel": "PRATES", "endpoint": "ddp", "name": "Policy Rates - Daily", "description": "interest on reserve balances, discount rate, ON RRP rate"}
88
- }
89
- }
1
+ {
2
+ "base_url": "https://www.federalreserve.gov",
3
+ "timeout": 120,
4
+ "endpoints": {
5
+ "ddp": {
6
+ "path": "/datadownload/Output.aspx",
7
+ "description": "One preformatted Data Download Program package of a Board release as CSV, reshaped to one row per series and date: date, series, value, value_flag (ND = no data), description, unit, multiplier, currency, unique_id. The value times multiplier is in unit (Currency x 1000000 = millions of dollars).",
8
+ "params": {
9
+ "rel": {"in": "spec", "desc": "release code: G19 (consumer credit), Z1 (Financial Accounts), SLOOS, SCOOS, H8 (bank balance sheets), H6 (money stock), H15 (interest rates), H41 (Fed balance sheet), G17 (industrial production), G20 (finance companies), CHGDEL (charge-offs and delinquencies), DSR / FOR (debt service ratios), CP (commercial paper), H10 (exchange rates), H3, E2, PRATES. Optional with a catalog package alias"},
10
+ "package": {"in": "spec", "required": true, "catalog": true, "desc": "the package: its 32-character id, its title as listed by ddp_packages (exact, or a unique start or part: 'Consumer Credit Outstanding (S.A.)', 'S1M.b (Q)'), or a catalog alias (g19_all, g19_sa, sloos, z1_b101 ...)"},
11
+ "series_ids": {"in": "spec", "desc": "optional list of series codes (the Time Period header, e.g. DTCTL.M) or unique identifiers (G19/CCOUT/DTCTL.M) to keep"},
12
+ "lastobs": {"in": "spec", "desc": "optional: only the last N observations of each series (applied by the pack to the whole package)"},
13
+ "from": {"in": "spec", "desc": "optional first date: YYYY, YYYY-MM, YYYY-MM-DD or YYYYQn (applied by the pack)"},
14
+ "to": {"in": "spec", "desc": "optional last date, inclusive: YYYY, YYYY-MM, YYYY-MM-DD or YYYYQn"}
15
+ },
16
+ "records": "$csv",
17
+ "paging": {"type": "none"},
18
+ "max_rows": 300000
19
+ },
20
+ "ddp_packages": {
21
+ "path": "/datadownload/Choose.aspx",
22
+ "description": "The preformatted packages of one release (scraped from its Choose page): package_title, package (id), listed (format, default observations, size).",
23
+ "params": {
24
+ "rel": {"in": "query", "required": true, "desc": "release code, e.g. G19, Z1 (435 packages), SLOOS"}
25
+ },
26
+ "records": "$csv",
27
+ "paging": {"type": "none"}
28
+ },
29
+ "z1": {
30
+ "path": "/releases/z1/current/z1_csv_files.zip",
31
+ "description": "One table of the Financial Accounts of the United States (Z.1) from the Board's bulk CSV zip (8 MB, current release), one row per series and date: date (1945:Q4 ... 2026:Q2), series, value (millions of dollars unless the units say otherwise), value_flag (ND), description, line, units, table, table_published.",
32
+ "params": {
33
+ "table": {"in": "spec", "required": true, "desc": "table code, new style (S1M.b, S1M.s, F3.2.s, S1311.s) or the published name it replaced (B.101, L.101, F.101, L.210, L.106); z1_tables lists both"},
34
+ "series_ids": {"in": "spec", "desc": "optional list of series codes to keep, e.g. FL152000005.Q (with or without the .Q)"},
35
+ "start": {"in": "spec", "desc": "optional first date, YYYY or YYYY:Qn"},
36
+ "end": {"in": "spec", "desc": "optional last date, YYYY or YYYY:Qn"}
37
+ },
38
+ "records": "$zip:csv/*.csv",
39
+ "paging": {"type": "none"}
40
+ },
41
+ "z1_tables": {
42
+ "path": "/releases/z1/current/z1_table_mapping.csv",
43
+ "description": "Z.1 table list: new (the code the zip and DDP use, e.g. S1M.b), old (the published table name, e.g. B.101), title.",
44
+ "params": {},
45
+ "records": "$csv",
46
+ "paging": {"type": "none"}
47
+ },
48
+ "scf_chart": {
49
+ "path": "/econres/scf/dataviz/download/zips/scf.zip",
50
+ "description": "Survey of Consumer Finances interactive chart data, 1989-2025 (triennial): one row per survey year and group (Category), one column per item (Before_Tax_Income, Net_Worth, Assets, Financial_Assets, Retirement_Accounts, Primary_Residence, Debt, Credit_Card_Balances, Education_Installment_Loans ...). Mean and median in thousands of 2025 dollars; have = percent of families holding the item.",
51
+ "params": {
52
+ "group": {"in": "spec", "required": true, "enum": ["all", "agecl", "edcl", "famstruct", "housecl", "inccat", "nwcat", "occat1", "occat2", "racecl4"], "desc": "family grouping: all, agecl (age of head), edcl (education), famstruct, housecl (owner/renter), inccat (income percentile), nwcat (net worth percentile), occat1 / occat2 (work status / occupation), racecl4 (race and ethnicity)"},
53
+ "stat": {"in": "spec", "required": true, "enum": ["median", "mean", "have"], "desc": "median or mean (among families that hold the item, thousands of 2025 dollars) or have (percent of families holding it)"}
54
+ },
55
+ "records": "$zip:*.csv",
56
+ "paging": {"type": "none"}
57
+ },
58
+ "scf_table": {
59
+ "path": "/econres/files/{file}.xlsx",
60
+ "description": "One sheet of the 2025 SCF published summary tables (1989-2025), as a raw grid: row (sheet row number) and c1..cN (cells as stored); the sheets have titles and multi-row headers, so read the grid, do not expect tidy columns.",
61
+ "params": {
62
+ "file": {"in": "path", "required": true, "enum": ["scf2025_tables_public_real_historical", "scf2025_tables_public_nominal_historical"], "desc": "real = thousands of 2025 dollars; nominal = dollars of each survey year"},
63
+ "sheet": {"in": "spec", "required": true, "desc": "sheet name, e.g. 'Table 4' (net worth by family characteristics), 'Table 1 01-25' (income); a wrong name lists the sheets"}
64
+ },
65
+ "records": "$xlsx",
66
+ "paging": {"type": "none"}
67
+ }
68
+ },
69
+ "catalog": {
70
+ "g19_all": {"id": "56a37b655eef16e2ede83467282a6e95", "rel": "G19", "endpoint": "ddp", "name": "G.19 Consumer Credit Outstanding - All", "description": "monthly since 1943: totals, revolving, nonrevolving, SA and NSA levels, percent changes, holders (millions of dollars)"},
71
+ "g19_sa": {"id": "696245eb361e0a8bc89b8e5b01cc971b", "rel": "G19", "endpoint": "ddp", "name": "G.19 Consumer Credit Outstanding (S.A.)", "description": "seasonally adjusted totals and percent changes (headline)"},
72
+ "g19_terms": {"id": "10264fd36110a9c4906bd99f1daccf29", "rel": "G19", "endpoint": "ddp", "name": "G.19 Terms of Credit", "description": "interest rates on credit cards, auto loans, personal loans; loan terms"},
73
+ "g19_holders_nsa": {"id": "417121472f75218035c6ba3770a5ebf5", "rel": "G19", "endpoint": "ddp", "name": "G.19 Major Holders (N.S.A.)", "description": "consumer credit by holder: banks, finance companies, credit unions, federal government (student loans), ..."},
74
+ "g19_flows": {"id": "8605d1da650f3e18ed4d8ebd31c1cab2", "rel": "G19", "endpoint": "ddp", "name": "G.19 Consumer Credit Outstanding - (Flow)", "description": "monthly changes (flows)"},
75
+ "sloos": {"id": "e64f07187815f0e7ed89237d8cb91eeb", "rel": "SLOOS", "endpoint": "ddp", "name": "Senior Loan Officer Opinion Survey - All chart data", "description": "quarterly net percentages of banks tightening standards and reporting stronger demand, by loan type"},
76
+ "scoos": {"id": "d7ddcd636ef03b879c632a42477a0535", "rel": "SCOOS", "endpoint": "ddp", "name": "Senior Credit Officer Opinion Survey - all active questions", "description": "dealer financing terms, quarterly since 2010:Q2"},
77
+ "z1_b101": {"id": "551e7dfea97fff844e2d605f0716a500", "rel": "Z1", "endpoint": "ddp", "name": "Z.1 S1M.b (Q) Households and nonprofit organizations balance sheet (B.101)", "description": "quarterly balance sheet, net worth, millions of dollars"},
78
+ "z1_l101": {"id": "fe354c3d420803392448004ea863b975", "rel": "Z1", "endpoint": "ddp", "name": "Z.1 S1M.s (Q) Households and nonprofit organizations levels (L.101)", "description": "financial assets and liabilities outstanding"},
79
+ "z1_f101": {"id": "088b1e81bdf443c73231e042c3a744db", "rel": "Z1", "endpoint": "ddp", "name": "Z.1 S1M.t (Q) Households and nonprofit organizations transactions (F.101)", "description": "flows, seasonally adjusted annual rates"},
80
+ "z1_l106": {"id": "43e1df4e46d36e9501b35cd92bc7266f", "rel": "Z1", "endpoint": "ddp", "name": "Z.1 S1311.s (Q) Federal government levels (L.106)", "description": "federal financial assets and liabilities"},
81
+ "h15_treasury_cmt": {"id": "bf17364827e38702b42a58cf8eaa3f78", "rel": "H15", "endpoint": "ddp", "name": "H.15 Treasury Constant Maturities", "description": "daily market yields, 1-month to 30-year (also in treasury-yields and fred)"},
82
+ "h6_monthly": {"id": "798e2796917702a5f8423426ba7e6b42", "rel": "H6", "endpoint": "ddp", "name": "H.6 M1, M2 and other release data, monthly", "description": "billions of dollars"},
83
+ "h8_all_banks_sa": {"id": "17951c643555bee48d63bb6957a4a92e", "rel": "H8", "endpoint": "ddp", "name": "H.8 All Commercial Banks, SA (Weekly)", "description": "assets and liabilities of commercial banks, weekly, seasonally adjusted"},
84
+ "g17_summary": {"id": "809009461b1cba2fd5b4cf5557d9d663", "rel": "G17", "endpoint": "ddp", "name": "G.17 Summary Table Data", "description": "industrial production and capacity utilization summary"},
85
+ "chgdel_rates_all": {"id": "929faaa8d5e6bf375839d7fc2b7760fe", "rel": "CHGDEL", "endpoint": "ddp", "name": "Charge-off rates/All banks", "description": "quarterly charge-off rates by loan type, percent"},
86
+ "debt_service": {"id": "e38200c11a744800391ad51150cee181", "rel": "DSR", "endpoint": "ddp", "name": "Household Debt Service Ratios", "description": "quarterly, percent of disposable income"},
87
+ "prates_daily": {"id": "c27939ee810cb2e929a920a6bd77d9f6", "rel": "PRATES", "endpoint": "ddp", "name": "Policy Rates - Daily", "description": "interest on reserve balances, discount rate, ON RRP rate"}
88
+ }
89
+ }