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,109 +1,109 @@
1
- {
2
- "id": "fhfa",
3
- "title": "FHFA House Price Index, conforming loan limits and Public Use Databases (fhfa.gov files)",
4
- "agency": "Federal Housing Finance Agency",
5
- "depth": "standard",
6
- "domains": [
7
- "housing",
8
- "house prices",
9
- "mortgage finance"
10
- ],
11
- "keywords": [
12
- "fhfa",
13
- "house price index",
14
- "hpi",
15
- "home prices",
16
- "house prices",
17
- "home values",
18
- "purchase-only index",
19
- "all-transactions index",
20
- "conforming loan limit",
21
- "loan limit",
22
- "jumbo",
23
- "high-cost area",
24
- "fannie mae",
25
- "freddie mac",
26
- "enterprises",
27
- "gse",
28
- "federal home loan bank",
29
- "fhlbank",
30
- "public use database",
31
- "pudb",
32
- "mortgage"
33
- ],
34
- "questions": [
35
- "latest FHFA house price index for the U.S., seasonally adjusted",
36
- "house price growth by state over the last year",
37
- "home price appreciation in a metro area since 2020",
38
- "annual house price index by county",
39
- "2026 conforming loan limit for a one-unit home in a county",
40
- "which counties have high-cost loan limits"
41
- ],
42
- "homepage": "https://www.fhfa.gov/data",
43
- "terms_url": "https://www.fhfa.gov/about/fhfa-policies",
44
- "auth": {
45
- "env": null,
46
- "required": "none",
47
- "placement": "none",
48
- "param": null,
49
- "prefix": "",
50
- "home": null,
51
- "signup_url": null,
52
- "echoes_key": false,
53
- "key_only": [],
54
- "extra": {},
55
- "demo_key": null
56
- },
57
- "limits": {
58
- "rps": 1,
59
- "burst": 2,
60
- "daily_quota": null,
61
- "errors_per_min": null,
62
- "bytes_per_min": null,
63
- "max_rows": 400000
64
- },
65
- "routes": {
66
- "api": {
67
- "base": "https://www.fhfa.gov",
68
- "probe": "https://www.fhfa.gov/hpi/download/quarterly_datasets/hpi_at_state.csv",
69
- "hosts": [
70
- "www.fhfa.gov"
71
- ]
72
- },
73
- "manual": {
74
- "how": "Open each link in manual_download/INSTRUCTIONS.md in a browser; the file downloads (hpi_master.csv is 17 MB). Upload it under the name shown; the pack applies the request's filters to the uploaded file. Without the links: HPI files are listed on https://www.fhfa.gov/data/hpi/datasets, conforming loan limits on https://www.fhfa.gov/data/conforming-loan-limit, Public Use Databases on https://www.fhfa.gov/data/pudb."
75
- }
76
- },
77
- "cache": {
78
- "mode": "run_only",
79
- "ttl_hours": null,
80
- "why": "Files are overwritten in place at each release (monthly HPI, quarterly, annual); data/ is reused only within a run."
81
- },
82
- "redistribution": {
83
- "mode": "allowed",
84
- "why": "FHFA data are works of a U.S. government agency, in the public domain (17 U.S.C. 105); cite FHFA as the source."
85
- },
86
- "notices": [],
87
- "retention": null,
88
- "citation": "Federal Housing Finance Agency, {dataset}, www.fhfa.gov, retrieved {retrieved_long}.",
89
- "audit_hooks": [],
90
- "clarify": [
91
- "Which index: purchase-only (the flagship, sales only) or all-transactions (adds refinance appraisals, longer history)? Default: purchase-only.",
92
- "Seasonally adjusted or not? Default: seasonally adjusted for month-to-month or quarter-to-quarter changes, not adjusted for year-over-year changes.",
93
- "Which loan limit: the baseline (most counties) or a specific county's limit (high-cost areas are higher), and for how many units? Default: one-unit."
94
- ],
95
- "formats": [
96
- "csv",
97
- "xlsx"
98
- ],
99
- "use_instead": [
100
- {
101
- "question": "One FHFA house price series for the U.S. or a state, with no index flavor choice",
102
- "source": "fred",
103
- "terms": [
104
- "USSTHPI"
105
- ],
106
- "why": "FRED carries the all-transactions and purchase-only HPI series under stable IDs."
107
- }
108
- ]
109
- }
1
+ {
2
+ "id": "fhfa",
3
+ "title": "FHFA House Price Index, conforming loan limits and Public Use Databases (fhfa.gov files)",
4
+ "agency": "Federal Housing Finance Agency",
5
+ "depth": "standard",
6
+ "domains": [
7
+ "housing",
8
+ "house prices",
9
+ "mortgage finance"
10
+ ],
11
+ "keywords": [
12
+ "fhfa",
13
+ "house price index",
14
+ "hpi",
15
+ "home prices",
16
+ "house prices",
17
+ "home values",
18
+ "purchase-only index",
19
+ "all-transactions index",
20
+ "conforming loan limit",
21
+ "loan limit",
22
+ "jumbo",
23
+ "high-cost area",
24
+ "fannie mae",
25
+ "freddie mac",
26
+ "enterprises",
27
+ "gse",
28
+ "federal home loan bank",
29
+ "fhlbank",
30
+ "public use database",
31
+ "pudb",
32
+ "mortgage"
33
+ ],
34
+ "questions": [
35
+ "latest FHFA house price index for the U.S., seasonally adjusted",
36
+ "house price growth by state over the last year",
37
+ "home price appreciation in a metro area since 2020",
38
+ "annual house price index by county",
39
+ "2026 conforming loan limit for a one-unit home in a county",
40
+ "which counties have high-cost loan limits"
41
+ ],
42
+ "homepage": "https://www.fhfa.gov/data",
43
+ "terms_url": "https://www.fhfa.gov/about/fhfa-policies",
44
+ "auth": {
45
+ "env": null,
46
+ "required": "none",
47
+ "placement": "none",
48
+ "param": null,
49
+ "prefix": "",
50
+ "home": null,
51
+ "signup_url": null,
52
+ "echoes_key": false,
53
+ "key_only": [],
54
+ "extra": {},
55
+ "demo_key": null
56
+ },
57
+ "limits": {
58
+ "rps": 1,
59
+ "burst": 2,
60
+ "daily_quota": null,
61
+ "errors_per_min": null,
62
+ "bytes_per_min": null,
63
+ "max_rows": 400000
64
+ },
65
+ "routes": {
66
+ "api": {
67
+ "base": "https://www.fhfa.gov",
68
+ "probe": "https://www.fhfa.gov/hpi/download/quarterly_datasets/hpi_at_state.csv",
69
+ "hosts": [
70
+ "www.fhfa.gov"
71
+ ]
72
+ },
73
+ "manual": {
74
+ "how": "Open each link in manual_download/INSTRUCTIONS.md in a browser; the file downloads (hpi_master.csv is 17 MB). Upload it under the name shown; the pack applies the request's filters to the uploaded file. Without the links: HPI files are listed on https://www.fhfa.gov/data/hpi/datasets, conforming loan limits on https://www.fhfa.gov/data/conforming-loan-limit, Public Use Databases on https://www.fhfa.gov/data/pudb."
75
+ }
76
+ },
77
+ "cache": {
78
+ "mode": "run_only",
79
+ "ttl_hours": null,
80
+ "why": "Files are overwritten in place at each release (monthly HPI, quarterly, annual); data/ is reused only within a run."
81
+ },
82
+ "redistribution": {
83
+ "mode": "allowed",
84
+ "why": "FHFA data are works of a U.S. government agency, in the public domain (17 U.S.C. 105); cite FHFA as the source."
85
+ },
86
+ "notices": [],
87
+ "retention": null,
88
+ "citation": "Federal Housing Finance Agency, {dataset}, www.fhfa.gov, retrieved {retrieved_long}.",
89
+ "audit_hooks": [],
90
+ "clarify": [
91
+ "Which index: purchase-only (the flagship, sales only) or all-transactions (adds refinance appraisals, longer history)? Default: purchase-only.",
92
+ "Seasonally adjusted or not? Default: seasonally adjusted for month-to-month or quarter-to-quarter changes, not adjusted for year-over-year changes.",
93
+ "Which loan limit: the baseline (most counties) or a specific county's limit (high-cost areas are higher), and for how many units? Default: one-unit."
94
+ ],
95
+ "formats": [
96
+ "csv",
97
+ "xlsx"
98
+ ],
99
+ "use_instead": [
100
+ {
101
+ "question": "One FHFA house price series for the U.S. or a state, with no index flavor choice",
102
+ "source": "fred",
103
+ "terms": [
104
+ "USSTHPI"
105
+ ],
106
+ "why": "FRED carries the all-transactions and purchase-only HPI series under stable IDs."
107
+ }
108
+ ]
109
+ }
@@ -0,0 +1,48 @@
1
+ {
2
+ "base_url": "https://www.fhwa.dot.gov/policyinformation/statistics",
3
+ "timeout": 90,
4
+ "endpoints": {
5
+ "table": {
6
+ "path": "/{year}/xls/{table}.xlsx",
7
+ "method": "GET",
8
+ "description": "One Highway Statistics table as FHWA publishes it (Excel): travel (VM-2 vehicle-miles by state and functional system), drivers (DL-22 by age and sex), vehicles (MV-1 registrations), roads (HM-20 public road length), motor fuel (MF-1 state fuel taxes) and Highway Trust Fund (FE-9) ... Default: every line numbered (row, col1...) to find the header lines; then header_lines names the columns.",
9
+ "params": {
10
+ "year": {
11
+ "in": "path",
12
+ "required": true,
13
+ "desc": "the Highway Statistics edition year, e.g. 2023 (the data year for most tables)"
14
+ },
15
+ "table": {
16
+ "in": "path",
17
+ "required": true,
18
+ "desc": "table id in lower case without the hyphen: vm2, dl22, mv1, hm20, mf1, fe9 ..."
19
+ },
20
+ "sheet": {
21
+ "in": "records",
22
+ "desc": "sheet name or number (default 1, not counting the hidden CRYSTAL_PERSIST sheet); DL-22 has MALES, FEMALES, TOTAL"
23
+ },
24
+ "header_lines": {
25
+ "in": "records",
26
+ "desc": "the header line numbers, e.g. '5-8' for VM-2"
27
+ },
28
+ "header_row": {
29
+ "in": "records",
30
+ "desc": "one header line instead; 0 (default) returns every line numbered"
31
+ },
32
+ "carry": {
33
+ "in": "records",
34
+ "desc": "which header lines span to the right over blank cells: top (default), all, none; check the names against the numbered lines"
35
+ }
36
+ },
37
+ "defaults": {
38
+ "header_row": 0
39
+ },
40
+ "records": "$xlsx",
41
+ "skip_sheets": "^CRYSTAL_PERSIST$",
42
+ "paging": {
43
+ "type": "none"
44
+ },
45
+ "max_rows": 20000
46
+ }
47
+ }
48
+ }
@@ -0,0 +1,91 @@
1
+ {
2
+ "id": "fhwa",
3
+ "title": "FHWA Highway Statistics: travel, drivers, vehicles, roads, motor fuel and highway finance by state",
4
+ "agency": "U.S. Department of Transportation, Federal Highway Administration",
5
+ "depth": "standard",
6
+ "domains": [
7
+ "transportation",
8
+ "highways",
9
+ "energy"
10
+ ],
11
+ "keywords": [
12
+ "fhwa",
13
+ "federal highway administration",
14
+ "highway statistics",
15
+ "vehicle miles traveled",
16
+ "vmt",
17
+ "miles driven",
18
+ "licensed drivers",
19
+ "drivers by age",
20
+ "registered vehicles",
21
+ "vehicle registrations",
22
+ "public road mileage",
23
+ "road length",
24
+ "lane miles",
25
+ "functional system",
26
+ "gas tax",
27
+ "motor fuel tax",
28
+ "highway trust fund",
29
+ "highway finance"
30
+ ],
31
+ "questions": [
32
+ "vehicle miles traveled by state",
33
+ "miles driven per capita by state",
34
+ "licensed drivers by age and sex",
35
+ "registered vehicles by state",
36
+ "public road miles by state and functional system",
37
+ "state motor fuel tax receipts",
38
+ "Highway Trust Fund receipts attributable to each state"
39
+ ],
40
+ "homepage": "https://www.fhwa.dot.gov/policyinformation/statistics.cfm",
41
+ "terms_url": "https://www.fhwa.dot.gov/policyinformation/statistics.cfm",
42
+ "auth": {
43
+ "env": null,
44
+ "required": "none",
45
+ "placement": "none",
46
+ "signup_url": null,
47
+ "echoes_key": false
48
+ },
49
+ "limits": {
50
+ "rps": 1,
51
+ "burst": 3,
52
+ "max_rows": 20000
53
+ },
54
+ "routes": {
55
+ "api": {
56
+ "base": "https://www.fhwa.dot.gov/policyinformation/statistics",
57
+ "probe": "https://www.fhwa.dot.gov/policyinformation/statistics/2023/xls/vm2.xlsx",
58
+ "hosts": [
59
+ "www.fhwa.dot.gov"
60
+ ]
61
+ },
62
+ "manual": {
63
+ "how": "Open https://www.fhwa.dot.gov/policyinformation/statistics/<year>/<table>.cfm (e.g. 2023/vm2.cfm), click the XLSX link, save the workbook and upload it with ingest."
64
+ }
65
+ },
66
+ "cache": {
67
+ "mode": "run_only",
68
+ "ttl_hours": null,
69
+ "why": "Tables are revised in place during the year; data/ is reused within a run."
70
+ },
71
+ "redistribution": {
72
+ "mode": "allowed",
73
+ "why": "FHWA statistics are U.S. government works in the public domain (17 U.S.C. 105)."
74
+ },
75
+ "notices": [],
76
+ "retention": null,
77
+ "citation": "U.S. Department of Transportation, Federal Highway Administration, Highway Statistics {dataset}, retrieved {retrieved_long}.",
78
+ "audit_hooks": [],
79
+ "clarify": [
80
+ "Which edition and year? Highway Statistics <year> tables mostly hold that year's data (VM-2 2023 = travel in 2023); tables are revised in later editions. Default: the latest edition that has the table.",
81
+ "Which table? Travel VM-2 (by functional system), drivers DL-22, vehicles MV-1, road length HM-20, motor fuel MF-1, trust fund FE-9. Default: the table whose title matches the question, named in the answer."
82
+ ],
83
+ "formats": [
84
+ "xlsx"
85
+ ],
86
+ "aliases": [
87
+ "FHWA",
88
+ "Highway Statistics",
89
+ "Federal Highway Administration"
90
+ ]
91
+ }
@@ -0,0 +1,59 @@
1
+ # FHWA Highway Statistics: travel, drivers, vehicles, roads, motor fuel and highway finance by state
2
+ Depth: standard. Key: none. The tables of FHWA's annual Highway Statistics series, as the Excel files FHWA
3
+ publishes, read line by line or with a named stacked header. Examples: VM-2 (vehicle-miles of travel by state
4
+ and functional system), DL-22 (licensed drivers by age and sex), MV-1 (registered vehicles), HM-20 (public road
5
+ length), MF-1 (state motor-fuel tax receipts), FE-9 (Highway Trust Fund receipts attributable to each state).
6
+
7
+ ## When to use
8
+ - Driving and roads by state: vehicle-miles traveled, per capita (with census population), licensed drivers,
9
+ registered vehicles, road miles, fuel tax receipts, Highway Trust Fund flows.
10
+ - Not here: national monthly travel and transportation indicators (bts); fuel prices and consumption totals
11
+ (eia); traffic deaths and recalls (nhtsa); federal highway grants by recipient (usaspending).
12
+
13
+ ## Endpoints
14
+ | Endpoint | Returns | Parameters |
15
+ |---|---|---|
16
+ | `table` | one Highway Statistics table: without `header_lines`, every line numbered (`row`, `col1`...); with it, named columns | `year` (edition, e.g. `2023`), `table` (`vm2`, `dl22`, `mv1`, `hm20`, `mf1`, `fe9` ...), `sheet`, `header_lines`, `header_row`, `carry` |
17
+
18
+ The table list is at https://www.fhwa.dot.gov/policyinformation/statistics/2023/ (each table page has an XLSX
19
+ link). Verified 2026-11-07: vm2 (2023, 2024), dl22, mv1, hm20, mf1, fe9 (2023). `mf2` is not a 2023 file.
20
+
21
+ ## Spec examples
22
+ ```json
23
+ {"description": "Vehicle-miles traveled by state, 2023 (VM-2)",
24
+ "requests": [{"name": "vm2_2023", "endpoint": "table", "params": {"year": "2023", "table": "vm2", "header_lines": "5-8"}}]}
25
+ ```
26
+ ```json
27
+ {"description": "Licensed drivers by age, 2023 (DL-22, all drivers): first look at the lines",
28
+ "requests": [{"name": "dl22_total", "endpoint": "table", "params": {"year": "2023", "table": "dl22", "sheet": "TOTAL"}}]}
29
+ ```
30
+
31
+ ## Data format and traps
32
+ - Read the raw lines first. Each table has its own layout:
33
+ - VM-2 and HM-20: title lines, the date line, then a four-line header (lines 5-8).
34
+ - MV-1 and MF-1: the header starts on line 4 or 5.
35
+ - DL-22: one sheet per sex (MALES, FEMALES, TOTAL).
36
+ - FE-9: two pages.
37
+ Some workbooks have a hidden CRYSTAL_PERSIST sheet first; it is left out of the sheet numbering.
38
+ - Stacked headers: only the top header line spans right by default (`carry: "top"`), because FHWA centers labels
39
+ over columns without merging them. In VM-2 2023:
40
+ - the RURAL and URBAN spans come out right;
41
+ - column 18, the grand TOTAL of rural and urban, is named `URBAN | TOTAL_col18`; rename it;
42
+ - the columns after it (`URBAN | State Cd`, `URBAN | RINT` ...) are a hidden copy with database codes; drop
43
+ them.
44
+ Always compare names with the numbered lines.
45
+ - Units are in each table's title or date line: VM-2 is in millions of vehicle-miles, MF-1 in thousands of dollars.
46
+ Values are stored numbers as text, often with float noise (`5798.6313300000002`): round to the published
47
+ precision.
48
+ - Rows include state rows, a Total row, and footnote or blank rows below; Puerto Rico and DC appear in some tables.
49
+ Keep state rows by name before ranking. Footnotes are on a separate `footnotes` sheet or below the table.
50
+ - Editions: "Highway Statistics 2023" holds mostly 2023 data; tables are revised in later editions and some are
51
+ published later than others. State the edition and table.
52
+
53
+ ## Access
54
+ No key. `fetch` reads https://www.fhwa.dot.gov/policyinformation/statistics/<year>/xls/<table>.xlsx (verified
55
+ 2026-11-07). Manual: open the table page and click XLSX, then `ingest`.
56
+
57
+ ## Citation and terms
58
+ "U.S. Department of Transportation, Federal Highway Administration, Highway Statistics 2023, Table VM-2,
59
+ retrieved <date>." Public domain (17 U.S.C. 105).
@@ -0,0 +1,166 @@
1
+ {
2
+ "base_url": "https://foreignassistance.gov",
3
+ "timeout": 180,
4
+ "endpoints": {
5
+ "by_country": {
6
+ "path": "/static/us_foreign_aid_country.csv",
7
+ "method": "GET",
8
+ "description": "U.S. foreign assistance by recipient country (and regional or worldwide programs), transaction type and fiscal year, current and constant dollars (ForeignAssistance.gov Data page, 'By Country').",
9
+ "params": {
10
+ "country": {
11
+ "in": "spec",
12
+ "desc": "keep these countries: ISO3 code (UKR) or name as published (Ukraine); a list works"
13
+ },
14
+ "fiscal_year": {
15
+ "in": "spec",
16
+ "desc": "keep these fiscal years (a year or a list)"
17
+ },
18
+ "from": {
19
+ "in": "spec",
20
+ "desc": "first fiscal year to keep"
21
+ },
22
+ "to": {
23
+ "in": "spec",
24
+ "desc": "last fiscal year to keep"
25
+ },
26
+ "transaction_type": {
27
+ "in": "spec",
28
+ "desc": "keep these transaction types: Obligations, Disbursements, Appropriated and Planned, President's Budget Requests (or their ids 2, 3, 1, 18)"
29
+ }
30
+ },
31
+ "records": "$csv",
32
+ "paging": {
33
+ "type": "none"
34
+ },
35
+ "max_rows": 300000
36
+ },
37
+ "by_dac_sector": {
38
+ "path": "/static/us_foreign_aid_dac_sector.csv",
39
+ "method": "GET",
40
+ "description": "U.S. foreign assistance by OECD DAC (international) category and sector, transaction type and fiscal year, all countries together.",
41
+ "params": {
42
+ "country": {
43
+ "in": "spec",
44
+ "desc": "keep these countries: ISO3 code (UKR) or name as published (Ukraine); a list works"
45
+ },
46
+ "fiscal_year": {
47
+ "in": "spec",
48
+ "desc": "keep these fiscal years (a year or a list)"
49
+ },
50
+ "from": {
51
+ "in": "spec",
52
+ "desc": "first fiscal year to keep"
53
+ },
54
+ "to": {
55
+ "in": "spec",
56
+ "desc": "last fiscal year to keep"
57
+ },
58
+ "transaction_type": {
59
+ "in": "spec",
60
+ "desc": "keep these transaction types: Obligations, Disbursements, Appropriated and Planned, President's Budget Requests (or their ids 2, 3, 1, 18)"
61
+ }
62
+ },
63
+ "records": "$csv",
64
+ "paging": {
65
+ "type": "none"
66
+ },
67
+ "max_rows": 300000
68
+ },
69
+ "by_usg_sector": {
70
+ "path": "/static/us_foreign_aid_usg_sector.csv",
71
+ "method": "GET",
72
+ "description": "U.S. foreign assistance by U.S. government category and sector (health, peace and security, humanitarian, economic development ...) and country, by transaction type and fiscal year.",
73
+ "params": {
74
+ "country": {
75
+ "in": "spec",
76
+ "desc": "keep these countries: ISO3 code (UKR) or name as published (Ukraine); a list works"
77
+ },
78
+ "fiscal_year": {
79
+ "in": "spec",
80
+ "desc": "keep these fiscal years (a year or a list)"
81
+ },
82
+ "from": {
83
+ "in": "spec",
84
+ "desc": "first fiscal year to keep"
85
+ },
86
+ "to": {
87
+ "in": "spec",
88
+ "desc": "last fiscal year to keep"
89
+ },
90
+ "transaction_type": {
91
+ "in": "spec",
92
+ "desc": "keep these transaction types: Obligations, Disbursements, Appropriated and Planned, President's Budget Requests (or their ids 2, 3, 1, 18)"
93
+ }
94
+ },
95
+ "records": "$csv",
96
+ "paging": {
97
+ "type": "none"
98
+ },
99
+ "max_rows": 300000
100
+ },
101
+ "by_managing_agency": {
102
+ "path": "/static/us_foreign_aid_implementing.csv",
103
+ "method": "GET",
104
+ "description": "U.S. foreign assistance by managing agency (USAID, State, Defense, HHS ...) and country, by transaction type and fiscal year.",
105
+ "params": {
106
+ "country": {
107
+ "in": "spec",
108
+ "desc": "keep these countries: ISO3 code (UKR) or name as published (Ukraine); a list works"
109
+ },
110
+ "fiscal_year": {
111
+ "in": "spec",
112
+ "desc": "keep these fiscal years (a year or a list)"
113
+ },
114
+ "from": {
115
+ "in": "spec",
116
+ "desc": "first fiscal year to keep"
117
+ },
118
+ "to": {
119
+ "in": "spec",
120
+ "desc": "last fiscal year to keep"
121
+ },
122
+ "transaction_type": {
123
+ "in": "spec",
124
+ "desc": "keep these transaction types: Obligations, Disbursements, Appropriated and Planned, President's Budget Requests (or their ids 2, 3, 1, 18)"
125
+ }
126
+ },
127
+ "records": "$csv",
128
+ "paging": {
129
+ "type": "none"
130
+ },
131
+ "max_rows": 300000
132
+ },
133
+ "by_funding_agency": {
134
+ "path": "/static/us_foreign_aid_funding.csv",
135
+ "method": "GET",
136
+ "description": "U.S. foreign assistance by funding agency and funding account (appropriation account) and country, by transaction type and fiscal year.",
137
+ "params": {
138
+ "country": {
139
+ "in": "spec",
140
+ "desc": "keep these countries: ISO3 code (UKR) or name as published (Ukraine); a list works"
141
+ },
142
+ "fiscal_year": {
143
+ "in": "spec",
144
+ "desc": "keep these fiscal years (a year or a list)"
145
+ },
146
+ "from": {
147
+ "in": "spec",
148
+ "desc": "first fiscal year to keep"
149
+ },
150
+ "to": {
151
+ "in": "spec",
152
+ "desc": "last fiscal year to keep"
153
+ },
154
+ "transaction_type": {
155
+ "in": "spec",
156
+ "desc": "keep these transaction types: Obligations, Disbursements, Appropriated and Planned, President's Budget Requests (or their ids 2, 3, 1, 18)"
157
+ }
158
+ },
159
+ "records": "$csv",
160
+ "paging": {
161
+ "type": "none"
162
+ },
163
+ "max_rows": 300000
164
+ }
165
+ }
166
+ }
@@ -0,0 +1,80 @@
1
+ {
2
+ "id": "foreign-assistance",
3
+ "title": "ForeignAssistance.gov: U.S. foreign aid by country, sector and agency",
4
+ "agency": "U.S. Department of State, Office of Foreign Assistance",
5
+ "depth": "standard",
6
+ "domains": [
7
+ "foreign aid",
8
+ "federal spending",
9
+ "international"
10
+ ],
11
+ "keywords": [
12
+ "foreign aid",
13
+ "foreign assistance",
14
+ "foreignassistance.gov",
15
+ "usaid",
16
+ "aid to ukraine",
17
+ "aid to israel",
18
+ "military aid",
19
+ "humanitarian assistance",
20
+ "development assistance",
21
+ "global health aid",
22
+ "aid by country",
23
+ "aid by sector",
24
+ "obligations and disbursements",
25
+ "oda",
26
+ "dac sector"
27
+ ],
28
+ "questions": [
29
+ "how much U.S. foreign aid a country received by year",
30
+ "largest recipients of U.S. foreign assistance",
31
+ "foreign aid by sector (health, security, humanitarian)",
32
+ "aid managed by USAID vs State vs Defense",
33
+ "foreign assistance budget requests by account"
34
+ ],
35
+ "homepage": "https://foreignassistance.gov/",
36
+ "terms_url": "https://foreignassistance.gov/data",
37
+ "auth": {
38
+ "env": null,
39
+ "required": "none",
40
+ "placement": "none",
41
+ "signup_url": null,
42
+ "echoes_key": false
43
+ },
44
+ "limits": {
45
+ "rps": 1,
46
+ "burst": 2,
47
+ "max_rows": 300000
48
+ },
49
+ "routes": {
50
+ "manual": {
51
+ "how": "Open https://foreignassistance.gov/data (Data Download), download the CSV (By Country, By DAC Sector, By USG Sector, By Managing Agency, By Funding Agency), and upload it with ingest."
52
+ }
53
+ },
54
+ "cache": {
55
+ "mode": "run_only",
56
+ "ttl_hours": null,
57
+ "why": "Files are refreshed with the site (data last updated date shown on every page)."
58
+ },
59
+ "redistribution": {
60
+ "mode": "allowed",
61
+ "why": "U.S. government data; the site states an Open Data License."
62
+ },
63
+ "notices": [],
64
+ "retention": null,
65
+ "citation": "U.S. Department of State and USAID, ForeignAssistance.gov, {dataset}, retrieved {retrieved_long}.",
66
+ "audit_hooks": [],
67
+ "clarify": [
68
+ "Which transaction type? Obligations (commitments), Disbursements (money spent), Appropriated and Planned, or President's Budget Requests: never add them together. Default: obligations for 'how much aid', disbursements for 'how much was spent'.",
69
+ "Current or constant dollars? current_amount is nominal; constant_amount is inflation-adjusted. Default: current for one year, constant for trends.",
70
+ "Which years? Fiscal years (October-September); the latest year is incomplete until reporting closes."
71
+ ],
72
+ "formats": [
73
+ "csv"
74
+ ],
75
+ "aliases": [
76
+ "ForeignAssistance.gov",
77
+ "FA.gov",
78
+ "U.S. foreign aid"
79
+ ]
80
+ }