data-analyst-mcp 0.3.0 → 0.3.1

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