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,147 +1,147 @@
1
- {
2
- "base_url": "https://www.huduser.gov/hudapi/public",
3
- "headers": {
4
- "Accept": "application/json"
5
- },
6
- "endpoints": {
7
- "fmr": {
8
- "path": "/fmr/data/{entityid}",
9
- "method": "GET",
10
- "description": "Fair Market Rents for one county, town or metro area: monthly gross rent by bedroom count (Efficiency to Four-Bedroom); Small Area FMR metros give one row per ZIP plus 'MSA level'.",
11
- "params": {
12
- "entityid": {
13
- "in": "path",
14
- "required": true,
15
- "desc": "10-character county code (state FIPS + county FIPS + 99999, e.g. 5100199999), a New England town code, or a metro code (METRO47900M47900)"
16
- },
17
- "year": {
18
- "desc": "fiscal year, e.g. 2027 (default: latest). FMRs take effect October 1 before the fiscal year (FY2027 on 2026-10-01)"
19
- }
20
- },
21
- "records": "data",
22
- "paging": {
23
- "type": "none"
24
- }
25
- },
26
- "fmr_state": {
27
- "path": "/fmr/statedata/{statecode}",
28
- "method": "GET",
29
- "description": "Fair Market Rents for every metro area and county (towns in New England) of a state: one row per area, area_type metro or county.",
30
- "params": {
31
- "statecode": {
32
- "in": "path",
33
- "required": true,
34
- "desc": "two-letter state code, e.g. MA"
35
- },
36
- "year": {
37
- "desc": "fiscal year, e.g. 2027 (default: latest). FMRs take effect October 1 before the fiscal year (FY2027 on 2026-10-01)"
38
- }
39
- },
40
- "records": "data",
41
- "paging": {
42
- "type": "none"
43
- }
44
- },
45
- "income_limits": {
46
- "path": "/il/data/{entityid}",
47
- "method": "GET",
48
- "description": "Section 8 income limits for one area: median family income and Very Low (50%), Extremely Low (30%) and Low (80%) limits for 1-8 person households (il50_p1 ... il80_p8).",
49
- "params": {
50
- "entityid": {
51
- "in": "path",
52
- "required": true,
53
- "desc": "10-character county code (state FIPS + county FIPS + 99999, e.g. 5100199999), a New England town code, or a metro code (METRO47900M47900)"
54
- },
55
- "year": {
56
- "desc": "fiscal year, e.g. 2026 (default: latest). Income limits take effect when HUD publishes them in spring, not October 1 (FY2026: May 1, 2026), so the latest IL year can trail the latest FMR year"
57
- }
58
- },
59
- "records": "data",
60
- "paging": {
61
- "type": "none"
62
- }
63
- },
64
- "il_state": {
65
- "path": "/il/statedata/{statecode}",
66
- "method": "GET",
67
- "description": "Income limits for every area of a state (response shape not documented by HUD; unverified).",
68
- "params": {
69
- "statecode": {
70
- "in": "path",
71
- "required": true,
72
- "desc": "two-letter state code, e.g. MA"
73
- },
74
- "year": {
75
- "desc": "fiscal year, e.g. 2026 (default: latest). Income limits take effect when HUD publishes them in spring, not October 1 (FY2026: May 1, 2026), so the latest IL year can trail the latest FMR year"
76
- }
77
- },
78
- "records": "data",
79
- "paging": {
80
- "type": "none"
81
- }
82
- },
83
- "mtspil": {
84
- "path": "/mtspil/data/{entityid}",
85
- "method": "GET",
86
- "description": "Multifamily Tax Subsidy Project (LIHTC) income limits for one area: 20% to 140% limits by household size.",
87
- "params": {
88
- "entityid": {
89
- "in": "path",
90
- "required": true,
91
- "desc": "10-character county code (state FIPS + county FIPS + 99999, e.g. 5100199999), a New England town code, or a metro code (METRO47900M47900)"
92
- },
93
- "year": {
94
- "desc": "fiscal year, e.g. 2026 (default: latest). MTSP limits are released with the income limits in spring, not October 1 (FY2026 income limits: May 1, 2026)"
95
- }
96
- },
97
- "records": "data",
98
- "paging": {
99
- "type": "none"
100
- }
101
- },
102
- "list_states": {
103
- "path": "/fmr/listStates",
104
- "method": "GET",
105
- "description": "States and territories with HUD state codes.",
106
- "params": {},
107
- "records": "data",
108
- "paging": {
109
- "type": "none"
110
- }
111
- },
112
- "list_counties": {
113
- "path": "/fmr/listCounties/{statecode}",
114
- "method": "GET",
115
- "description": "Counties (and New England towns) of a state with their 10-character fips_code entity ids.",
116
- "params": {
117
- "statecode": {
118
- "in": "path",
119
- "required": true,
120
- "desc": "two-letter state code, e.g. MA"
121
- },
122
- "updated": {
123
- "desc": "2025 = the FIPS codes used by Income Limits 2025 (some counties changed)"
124
- }
125
- },
126
- "records": "data",
127
- "paging": {
128
- "type": "none"
129
- }
130
- },
131
- "list_metro_areas": {
132
- "path": "/fmr/listMetroAreas",
133
- "method": "GET",
134
- "description": "HUD metro FMR areas with their cbsa_code entity ids (METRO10180M10180).",
135
- "params": {
136
- "updated": {
137
- "desc": "2025 = the area codes used by Income Limits 2025"
138
- }
139
- },
140
- "records": "data",
141
- "paging": {
142
- "type": "none"
143
- }
144
- }
145
- },
146
- "catalog": {}
1
+ {
2
+ "base_url": "https://www.huduser.gov/hudapi/public",
3
+ "headers": {
4
+ "Accept": "application/json"
5
+ },
6
+ "endpoints": {
7
+ "fmr": {
8
+ "path": "/fmr/data/{entityid}",
9
+ "method": "GET",
10
+ "description": "Fair Market Rents for one county, town or metro area: monthly gross rent by bedroom count (Efficiency to Four-Bedroom); Small Area FMR metros give one row per ZIP plus 'MSA level'.",
11
+ "params": {
12
+ "entityid": {
13
+ "in": "path",
14
+ "required": true,
15
+ "desc": "10-character county code (state FIPS + county FIPS + 99999, e.g. 5100199999), a New England town code, or a metro code (METRO47900M47900)"
16
+ },
17
+ "year": {
18
+ "desc": "fiscal year, e.g. 2027 (default: latest). FMRs take effect October 1 before the fiscal year (FY2027 on 2026-10-01)"
19
+ }
20
+ },
21
+ "records": "data",
22
+ "paging": {
23
+ "type": "none"
24
+ }
25
+ },
26
+ "fmr_state": {
27
+ "path": "/fmr/statedata/{statecode}",
28
+ "method": "GET",
29
+ "description": "Fair Market Rents for every metro area and county (towns in New England) of a state: one row per area, area_type metro or county.",
30
+ "params": {
31
+ "statecode": {
32
+ "in": "path",
33
+ "required": true,
34
+ "desc": "two-letter state code, e.g. MA"
35
+ },
36
+ "year": {
37
+ "desc": "fiscal year, e.g. 2027 (default: latest). FMRs take effect October 1 before the fiscal year (FY2027 on 2026-10-01)"
38
+ }
39
+ },
40
+ "records": "data",
41
+ "paging": {
42
+ "type": "none"
43
+ }
44
+ },
45
+ "income_limits": {
46
+ "path": "/il/data/{entityid}",
47
+ "method": "GET",
48
+ "description": "Section 8 income limits for one area: median family income and Very Low (50%), Extremely Low (30%) and Low (80%) limits for 1-8 person households (il50_p1 ... il80_p8).",
49
+ "params": {
50
+ "entityid": {
51
+ "in": "path",
52
+ "required": true,
53
+ "desc": "10-character county code (state FIPS + county FIPS + 99999, e.g. 5100199999), a New England town code, or a metro code (METRO47900M47900)"
54
+ },
55
+ "year": {
56
+ "desc": "fiscal year, e.g. 2026 (default: latest). Income limits take effect when HUD publishes them in spring, not October 1 (FY2026: May 1, 2026), so the latest IL year can trail the latest FMR year"
57
+ }
58
+ },
59
+ "records": "data",
60
+ "paging": {
61
+ "type": "none"
62
+ }
63
+ },
64
+ "il_state": {
65
+ "path": "/il/statedata/{statecode}",
66
+ "method": "GET",
67
+ "description": "Income limits for every area of a state (response shape not documented by HUD; unverified).",
68
+ "params": {
69
+ "statecode": {
70
+ "in": "path",
71
+ "required": true,
72
+ "desc": "two-letter state code, e.g. MA"
73
+ },
74
+ "year": {
75
+ "desc": "fiscal year, e.g. 2026 (default: latest). Income limits take effect when HUD publishes them in spring, not October 1 (FY2026: May 1, 2026), so the latest IL year can trail the latest FMR year"
76
+ }
77
+ },
78
+ "records": "data",
79
+ "paging": {
80
+ "type": "none"
81
+ }
82
+ },
83
+ "mtspil": {
84
+ "path": "/mtspil/data/{entityid}",
85
+ "method": "GET",
86
+ "description": "Multifamily Tax Subsidy Project (LIHTC) income limits for one area: 20% to 140% limits by household size.",
87
+ "params": {
88
+ "entityid": {
89
+ "in": "path",
90
+ "required": true,
91
+ "desc": "10-character county code (state FIPS + county FIPS + 99999, e.g. 5100199999), a New England town code, or a metro code (METRO47900M47900)"
92
+ },
93
+ "year": {
94
+ "desc": "fiscal year, e.g. 2026 (default: latest). MTSP limits are released with the income limits in spring, not October 1 (FY2026 income limits: May 1, 2026)"
95
+ }
96
+ },
97
+ "records": "data",
98
+ "paging": {
99
+ "type": "none"
100
+ }
101
+ },
102
+ "list_states": {
103
+ "path": "/fmr/listStates",
104
+ "method": "GET",
105
+ "description": "States and territories with HUD state codes.",
106
+ "params": {},
107
+ "records": "data",
108
+ "paging": {
109
+ "type": "none"
110
+ }
111
+ },
112
+ "list_counties": {
113
+ "path": "/fmr/listCounties/{statecode}",
114
+ "method": "GET",
115
+ "description": "Counties (and New England towns) of a state with their 10-character fips_code entity ids.",
116
+ "params": {
117
+ "statecode": {
118
+ "in": "path",
119
+ "required": true,
120
+ "desc": "two-letter state code, e.g. MA"
121
+ },
122
+ "updated": {
123
+ "desc": "2025 = the FIPS codes used by Income Limits 2025 (some counties changed)"
124
+ }
125
+ },
126
+ "records": "data",
127
+ "paging": {
128
+ "type": "none"
129
+ }
130
+ },
131
+ "list_metro_areas": {
132
+ "path": "/fmr/listMetroAreas",
133
+ "method": "GET",
134
+ "description": "HUD metro FMR areas with their cbsa_code entity ids (METRO10180M10180).",
135
+ "params": {
136
+ "updated": {
137
+ "desc": "2025 = the area codes used by Income Limits 2025"
138
+ }
139
+ },
140
+ "records": "data",
141
+ "paging": {
142
+ "type": "none"
143
+ }
144
+ }
145
+ },
146
+ "catalog": {}
147
147
  }
@@ -1,84 +1,84 @@
1
- {
2
- "id": "hud",
3
- "title": "HUD Fair Market Rents and Income Limits API (HUD User)",
4
- "agency": "U.S. Department of Housing and Urban Development, Office of Policy Development and Research",
5
- "depth": "standard",
6
- "domains": [
7
- "housing"
8
- ],
9
- "keywords": [
10
- "fair market rent",
11
- "fmr",
12
- "rent",
13
- "rents",
14
- "section 8",
15
- "housing choice voucher",
16
- "income limits",
17
- "area median income",
18
- "ami",
19
- "very low income",
20
- "extremely low income",
21
- "low income",
22
- "lihtc",
23
- "mtsp",
24
- "small area fmr",
25
- "affordable housing",
26
- "hud"
27
- ],
28
- "questions": [
29
- "fair market rent for a two-bedroom in a county",
30
- "HUD income limits for a family of four",
31
- "fair market rents for every county in a state",
32
- "Small Area FMRs by ZIP code in a metro"
33
- ],
34
- "homepage": "https://www.huduser.gov/portal/dataset/fmr-api.html",
35
- "terms_url": "https://www.huduser.gov/portal/dataset/fmr-api.html",
36
- "auth": {
37
- "env": "HUD_USER_TOKEN",
38
- "required": "required",
39
- "placement": "header",
40
- "param": "Authorization",
41
- "prefix": "Bearer ",
42
- "home": "hud",
43
- "signup_url": "https://www.huduser.gov/hudapi/public/register",
44
- "echoes_key": false,
45
- "key_only": []
46
- },
47
- "limits": {
48
- "rps": 1,
49
- "burst": 3,
50
- "max_rows": 50000
51
- },
52
- "routes": {
53
- "api": {
54
- "base": "https://www.huduser.gov/hudapi/public",
55
- "probe": "https://www.huduser.gov/hudapi/public/fmr/listStates",
56
- "hosts": [
57
- "www.huduser.gov"
58
- ]
59
- },
60
- "manual": {
61
- "how": "With a HUD User token, run the download script in the bundle (the token goes in a header, so browser links do not work). Without a token, download the published files: FMRs at https://www.huduser.gov/portal/datasets/fmr.html and income limits at https://www.huduser.gov/portal/datasets/il.html (choose the fiscal year and download its data file), save it as CSV, and upload it."
62
- }
63
- },
64
- "cache": {
65
- "mode": "run_only",
66
- "ttl_hours": null,
67
- "why": "Values change once a fiscal year (with occasional mid-year revisions); queries are small."
68
- },
69
- "redistribution": {
70
- "mode": "allowed",
71
- "why": "FMRs and income limits are U.S. government works published by HUD (17 U.S.C. 105); the HUD User API terms govern access, not reuse of the values."
72
- },
73
- "notices": [],
74
- "retention": null,
75
- "citation": "U.S. Department of Housing and Urban Development, {dataset}, HUD User FMR and Income Limits API, retrieved {retrieved_long}.",
76
- "audit_hooks": [],
77
- "clarify": [
78
- "Which fiscal year? FMRs and income limits are set per federal fiscal year; FMRs take effect October 1 (FY2027 on October 1, 2026), income limits when HUD publishes them in spring (FY2026 on May 1, 2026), so the latest years differ. The default is the latest of each.",
79
- "In a Small Area FMR metro, the metro-wide value or ZIP-code values?"
80
- ],
81
- "formats": [
82
- "json"
83
- ]
84
- }
1
+ {
2
+ "id": "hud",
3
+ "title": "HUD Fair Market Rents and Income Limits API (HUD User)",
4
+ "agency": "U.S. Department of Housing and Urban Development, Office of Policy Development and Research",
5
+ "depth": "standard",
6
+ "domains": [
7
+ "housing"
8
+ ],
9
+ "keywords": [
10
+ "fair market rent",
11
+ "fmr",
12
+ "rent",
13
+ "rents",
14
+ "section 8",
15
+ "housing choice voucher",
16
+ "income limits",
17
+ "area median income",
18
+ "ami",
19
+ "very low income",
20
+ "extremely low income",
21
+ "low income",
22
+ "lihtc",
23
+ "mtsp",
24
+ "small area fmr",
25
+ "affordable housing",
26
+ "hud"
27
+ ],
28
+ "questions": [
29
+ "fair market rent for a two-bedroom in a county",
30
+ "HUD income limits for a family of four",
31
+ "fair market rents for every county in a state",
32
+ "Small Area FMRs by ZIP code in a metro"
33
+ ],
34
+ "homepage": "https://www.huduser.gov/portal/dataset/fmr-api.html",
35
+ "terms_url": "https://www.huduser.gov/portal/dataset/fmr-api.html",
36
+ "auth": {
37
+ "env": "HUD_USER_TOKEN",
38
+ "required": "required",
39
+ "placement": "header",
40
+ "param": "Authorization",
41
+ "prefix": "Bearer ",
42
+ "home": "hud",
43
+ "signup_url": "https://www.huduser.gov/hudapi/public/register",
44
+ "echoes_key": false,
45
+ "key_only": []
46
+ },
47
+ "limits": {
48
+ "rps": 1,
49
+ "burst": 3,
50
+ "max_rows": 50000
51
+ },
52
+ "routes": {
53
+ "api": {
54
+ "base": "https://www.huduser.gov/hudapi/public",
55
+ "probe": "https://www.huduser.gov/hudapi/public/fmr/listStates",
56
+ "hosts": [
57
+ "www.huduser.gov"
58
+ ]
59
+ },
60
+ "manual": {
61
+ "how": "With a HUD User token, run the download script in the bundle (the token goes in a header, so browser links do not work). Without a token, download the published files: FMRs at https://www.huduser.gov/portal/datasets/fmr.html and income limits at https://www.huduser.gov/portal/datasets/il.html (choose the fiscal year and download its data file), save it as CSV, and upload it."
62
+ }
63
+ },
64
+ "cache": {
65
+ "mode": "run_only",
66
+ "ttl_hours": null,
67
+ "why": "Values change once a fiscal year (with occasional mid-year revisions); queries are small."
68
+ },
69
+ "redistribution": {
70
+ "mode": "allowed",
71
+ "why": "FMRs and income limits are U.S. government works published by HUD (17 U.S.C. 105); the HUD User API terms govern access, not reuse of the values."
72
+ },
73
+ "notices": [],
74
+ "retention": null,
75
+ "citation": "U.S. Department of Housing and Urban Development, {dataset}, HUD User FMR and Income Limits API, retrieved {retrieved_long}.",
76
+ "audit_hooks": [],
77
+ "clarify": [
78
+ "Which fiscal year? FMRs and income limits are set per federal fiscal year; FMRs take effect October 1 (FY2027 on October 1, 2026), income limits when HUD publishes them in spring (FY2026 on May 1, 2026), so the latest years differ. The default is the latest of each.",
79
+ "In a Small Area FMR metro, the metro-wide value or ZIP-code values?"
80
+ ],
81
+ "formats": [
82
+ "json"
83
+ ]
84
+ }
@@ -8,7 +8,7 @@ England town, metro FMR area and state, per federal fiscal year.
8
8
  income limits (30%, 50%, 80% of area median) by household size; area median family income as HUD
9
9
  sets it; MTSP (LIHTC) limits.
10
10
  - Not here: market rents and home values from surveys (census ACS median gross rent), house price
11
- indexes (fred, FHFA), homelessness counts and public housing (not covered), mortgage complaints
11
+ indexes (fred, FHFA), homelessness counts (hud-ahar), public housing (not covered), mortgage complaints
12
12
  (cfpb). FMRs are policy values (the 40th percentile gross rent standard), not observed averages.
13
13
 
14
14
  ## Endpoints and datasets
@@ -0,0 +1,92 @@
1
+ {
2
+ "base_url": "https://www.huduser.gov/portal/sites/default/files/xls",
3
+ "timeout": 60,
4
+ "files": {
5
+ "pit_by_coc": "2007-2025-PIT-Counts-by-CoC.xlsb",
6
+ "pit_by_state": "2007-2025-PIT-Counts-by-State.xlsb",
7
+ "hic_by_coc": "2007-2025-HIC-Counts-by-CoC.xlsx",
8
+ "hic_by_state": "2007-2025-HIC-Counts-by-State.xlsx",
9
+ "veterans_by_coc": "2011-2025-PIT-Veteran-Counts-by-CoC.xlsx",
10
+ "veterans_by_state": "2011-2025-PIT-Veteran-Counts-by-State.xlsx"
11
+ },
12
+ "endpoints": {
13
+ "pit_by_coc": {
14
+ "path": "/2007-2025-PIT-Counts-by-CoC.xlsb",
15
+ "method": "GET",
16
+ "description": "Point-in-Time (PIT) counts of people experiencing homelessness by Continuum of Care (CoC), one sheet per year 2007-2025 (2025 AHAR edition). Manual: huduser.gov refuses scripts; the user downloads the workbook and uploads it.",
17
+ "params": {
18
+ "year": {"in": "spec", "required": true, "desc": "the count year, i.e. the workbook sheet to read (2007-2025)"},
19
+ "sheet": {"in": "spec", "desc": "a sheet name other than the year (the workbook's other sheets, e.g. a change table)"},
20
+ "header_row": {"in": "spec", "desc": "the header row of the sheet, 1-based (default 1)"}
21
+ },
22
+ "records": "$xls",
23
+ "paging": {"type": "none"},
24
+ "max_rows": 100000
25
+ },
26
+ "pit_by_state": {
27
+ "path": "/2007-2025-PIT-Counts-by-State.xlsb",
28
+ "method": "GET",
29
+ "description": "PIT counts of people experiencing homelessness by state (and the national total), one sheet per year 2007-2025. Manual.",
30
+ "params": {
31
+ "year": {"in": "spec", "required": true, "desc": "the count year (sheet), 2007-2025"},
32
+ "sheet": {"in": "spec", "desc": "a sheet name other than the year"},
33
+ "header_row": {"in": "spec", "desc": "the header row, 1-based (default 1)"}
34
+ },
35
+ "records": "$xls",
36
+ "paging": {"type": "none"},
37
+ "max_rows": 100000
38
+ },
39
+ "hic_by_coc": {
40
+ "path": "/2007-2025-HIC-Counts-by-CoC.xlsx",
41
+ "method": "GET",
42
+ "description": "Housing Inventory Count (HIC): beds and units for people experiencing homelessness (emergency shelter, transitional, safe haven, rapid re-housing, permanent supportive housing) by CoC, one sheet per year. Manual.",
43
+ "params": {
44
+ "year": {"in": "spec", "required": true, "desc": "the count year (sheet)"},
45
+ "sheet": {"in": "spec", "desc": "a sheet name other than the year"},
46
+ "header_row": {"in": "spec", "desc": "the header row, 1-based (default 1)"}
47
+ },
48
+ "records": "$xlsx",
49
+ "paging": {"type": "none"},
50
+ "max_rows": 100000
51
+ },
52
+ "hic_by_state": {
53
+ "path": "/2007-2025-HIC-Counts-by-State.xlsx",
54
+ "method": "GET",
55
+ "description": "Housing Inventory Count by state, one sheet per year. Manual.",
56
+ "params": {
57
+ "year": {"in": "spec", "required": true, "desc": "the count year (sheet)"},
58
+ "sheet": {"in": "spec", "desc": "a sheet name other than the year"},
59
+ "header_row": {"in": "spec", "desc": "the header row, 1-based (default 1)"}
60
+ },
61
+ "records": "$xlsx",
62
+ "paging": {"type": "none"},
63
+ "max_rows": 100000
64
+ },
65
+ "veterans_by_coc": {
66
+ "path": "/2011-2025-PIT-Veteran-Counts-by-CoC.xlsx",
67
+ "method": "GET",
68
+ "description": "PIT counts of veterans experiencing homelessness by CoC, one sheet per year 2011-2025. Manual.",
69
+ "params": {
70
+ "year": {"in": "spec", "required": true, "desc": "the count year (sheet), 2011-2025"},
71
+ "sheet": {"in": "spec", "desc": "a sheet name other than the year"},
72
+ "header_row": {"in": "spec", "desc": "the header row, 1-based (default 1)"}
73
+ },
74
+ "records": "$xlsx",
75
+ "paging": {"type": "none"},
76
+ "max_rows": 100000
77
+ },
78
+ "veterans_by_state": {
79
+ "path": "/2011-2025-PIT-Veteran-Counts-by-State.xlsx",
80
+ "method": "GET",
81
+ "description": "PIT counts of veterans experiencing homelessness by state, one sheet per year 2011-2025. Manual.",
82
+ "params": {
83
+ "year": {"in": "spec", "required": true, "desc": "the count year (sheet), 2011-2025"},
84
+ "sheet": {"in": "spec", "desc": "a sheet name other than the year"},
85
+ "header_row": {"in": "spec", "desc": "the header row, 1-based (default 1)"}
86
+ },
87
+ "records": "$xlsx",
88
+ "paging": {"type": "none"},
89
+ "max_rows": 100000
90
+ }
91
+ }
92
+ }
@@ -0,0 +1,88 @@
1
+ {
2
+ "id": "hud-ahar",
3
+ "title": "HUD Annual Homelessness Assessment Report (AHAR) data: Point-in-Time and Housing Inventory Counts",
4
+ "agency": "U.S. Department of Housing and Urban Development",
5
+ "depth": "standard",
6
+ "domains": [
7
+ "homelessness",
8
+ "housing"
9
+ ],
10
+ "keywords": [
11
+ "homeless",
12
+ "homelessness",
13
+ "people experiencing homelessness",
14
+ "point-in-time count",
15
+ "pit count",
16
+ "ahar",
17
+ "annual homelessness assessment report",
18
+ "unsheltered",
19
+ "sheltered homeless",
20
+ "chronically homeless",
21
+ "homeless veterans",
22
+ "veteran homelessness",
23
+ "homeless youth",
24
+ "continuum of care",
25
+ "coc",
26
+ "housing inventory count",
27
+ "hic",
28
+ "shelter beds",
29
+ "emergency shelter",
30
+ "permanent supportive housing",
31
+ "rapid re-housing"
32
+ ],
33
+ "questions": [
34
+ "number of people experiencing homelessness by state",
35
+ "unsheltered homeless count in a city or Continuum of Care",
36
+ "change in homelessness since 2020",
37
+ "homeless veterans by state",
38
+ "chronically homeless individuals",
39
+ "emergency shelter and permanent supportive housing beds by CoC"
40
+ ],
41
+ "homepage": "https://www.huduser.gov/portal/datasets/ahar.html",
42
+ "terms_url": "https://www.huduser.gov/portal/datasets/ahar/2025-ahar-part-1-pit-estimates-of-homelessness-in-the-us.html",
43
+ "auth": {
44
+ "env": null,
45
+ "required": "none",
46
+ "placement": "none",
47
+ "signup_url": null,
48
+ "echoes_key": false
49
+ },
50
+ "limits": {
51
+ "rps": 1,
52
+ "burst": 2,
53
+ "max_rows": 100000
54
+ },
55
+ "routes": {
56
+ "manual": {
57
+ "how": "Open https://www.huduser.gov/portal/datasets/ahar/2025-ahar-part-1-pit-estimates-of-homelessness-in-the-us.html in a web browser and download the workbook (2007 - 2025 Point-in-Time Estimates by CoC or by State, Housing Inventory Count by CoC or State, PIT Veteran Counts); huduser.gov refuses scripts. Upload the workbook as saved (.xlsb or .xlsx) with ingest."
58
+ }
59
+ },
60
+ "cache": {
61
+ "mode": "run_only",
62
+ "ttl_hours": null,
63
+ "why": "Workbooks are replaced once a year with the new AHAR edition."
64
+ },
65
+ "redistribution": {
66
+ "mode": "allowed",
67
+ "why": "HUD's AHAR data are U.S. government works in the public domain (17 U.S.C. 105)."
68
+ },
69
+ "notices": [],
70
+ "retention": null,
71
+ "citation": "U.S. Department of Housing and Urban Development, Annual Homelessness Assessment Report (AHAR), {dataset}, HUD User, downloaded {retrieved_long}.",
72
+ "audit_hooks": [],
73
+ "clarify": [
74
+ "Which year? Each sheet is one count year (a single night in late January). Default: the latest year, with 2020 or the prior year for change.",
75
+ "Which population? Total, sheltered, unsheltered, individuals, people in families, chronically homeless, veterans, youth: these overlap. Default: total, split into sheltered and unsheltered.",
76
+ "Which geography? CoCs are HUD's planning areas (a city, a county or a balance of state), not cities or counties as such. Default: states, or the CoC that contains the place named, said as such."
77
+ ],
78
+ "formats": [
79
+ "xlsb",
80
+ "xlsx"
81
+ ],
82
+ "aliases": [
83
+ "AHAR",
84
+ "PIT count",
85
+ "Point-in-Time count",
86
+ "Housing Inventory Count"
87
+ ]
88
+ }