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,292 +1,292 @@
1
- {
2
- "base_url": "https://data.epa.gov/dmapservice",
3
- "endpoints": {
4
- "envirofacts": {
5
- "path": "/{table}",
6
- "kind": "dmap",
7
- "description": "Any Envirofacts table (DMAP): TRI, GHGRP, SDWIS, SEMS/Superfund, RCRAInfo, FRS ... filtered by column values.",
8
- "params": {
9
- "table": {
10
- "in": "path",
11
- "required": true,
12
- "catalog": true,
13
- "desc": "catalog alias (tri_facility, ghg_emitters, sdwis_systems ...) or schema.table"
14
- },
15
- "filters": {
16
- "desc": "{\"column\": \"value\"} for equals, or [[column, operator, value], ...]; operators: equals, notEquals, lessThan, greaterThan, greaterThanEqual, beginsWith, endsWith, contains"
17
- }
18
- },
19
- "records": "",
20
- "paging": {
21
- "type": "none",
22
- "size": 5000
23
- },
24
- "max_rows": 200000,
25
- "method": "GET",
26
- "missing": [
27
- ""
28
- ],
29
- "flatten": true
30
- },
31
- "uv_daily": {
32
- "path": "/getEnvirofactsUVDAILY/ZIP/{zip}/JSON",
33
- "description": "Today's UV index forecast for a ZIP code (forecast, not history).",
34
- "params": {
35
- "zip": {
36
- "in": "path",
37
- "required": true,
38
- "desc": "5-digit ZIP"
39
- }
40
- },
41
- "records": "",
42
- "paging": {
43
- "type": "none"
44
- },
45
- "method": "GET",
46
- "missing": [
47
- ""
48
- ],
49
- "flatten": true
50
- },
51
- "uv_daily_city": {
52
- "path": "/getEnvirofactsUVDAILY/CITY/{city}/STATE/{state}/JSON",
53
- "description": "Today's UV index forecast for a city.",
54
- "params": {
55
- "city": {
56
- "in": "path",
57
- "required": true,
58
- "desc": "city name"
59
- },
60
- "state": {
61
- "in": "path",
62
- "required": true,
63
- "desc": "two-letter state code"
64
- }
65
- },
66
- "records": "",
67
- "paging": {
68
- "type": "none"
69
- },
70
- "method": "GET",
71
- "missing": [
72
- ""
73
- ],
74
- "flatten": true
75
- },
76
- "uv_hourly": {
77
- "path": "/getEnvirofactsUVHOURLY/ZIP/{zip}/JSON",
78
- "description": "Today's hourly UV index forecast for a ZIP code.",
79
- "params": {
80
- "zip": {
81
- "in": "path",
82
- "required": true,
83
- "desc": "5-digit ZIP"
84
- }
85
- },
86
- "records": "",
87
- "paging": {
88
- "type": "none"
89
- },
90
- "method": "GET",
91
- "missing": [
92
- ""
93
- ],
94
- "flatten": true
95
- },
96
- "echo_facilities": {
97
- "path": "https://echodata.epa.gov/echo/{program}_rest_services.get_facilities",
98
- "kind": "echo",
99
- "description": "ECHO facility compliance search (two steps: query, then pages of rows): air (CAA), cwa (CWA/NPDES), rcra (hazardous waste), sdw (drinking water systems), echo (all programs).",
100
- "params": {
101
- "program": {
102
- "in": "path",
103
- "required": true,
104
- "enum": [
105
- "air",
106
- "cwa",
107
- "rcra",
108
- "sdw",
109
- "echo"
110
- ],
111
- "desc": "air, cwa, rcra, sdw or echo"
112
- },
113
- "p_st": {
114
- "desc": "state code, e.g. TX"
115
- },
116
- "p_co": {
117
- "desc": "county name, with p_st (returns 0 rows for program air, verified 2026-10: use p_fips there)"
118
- },
119
- "p_fips": {
120
- "desc": "5-digit state+county FIPS, e.g. 35015 (air, cwa, rcra, echo)"
121
- },
122
- "p_ct": {
123
- "desc": "city"
124
- },
125
- "p_zip": {
126
- "desc": "5-digit ZIP"
127
- },
128
- "p_fn": {
129
- "desc": "facility name (contains)"
130
- },
131
- "p_act": {
132
- "desc": "Y: active facilities only"
133
- },
134
- "p_maj": {
135
- "desc": "Y: major facilities only (air, cwa)"
136
- },
137
- "p_ncs": {
138
- "desc": "NAICS code, 2 to 6 digits (shorter matches every code it begins; p_naics is ignored by ECHO)"
139
- },
140
- "p_sic": {
141
- "desc": "SIC code"
142
- },
143
- "p_qiv": {
144
- "desc": "quarters in violation, e.g. GT4"
145
- },
146
- "p_impw": {
147
- "desc": "cwa: Y impaired waters"
148
- },
149
- "p_pen": {
150
- "desc": "penalty range"
151
- },
152
- "qcolumns": {
153
- "desc": "comma-separated column ids to return (ids: <program>_rest_services.metadata?output=JSON, ResultColumns); sent to the search and to every get_qid page"
154
- }
155
- },
156
- "records": "Facilities",
157
- "paging": {
158
- "type": "none",
159
- "size": 1000
160
- },
161
- "max_rows": 100000,
162
- "method": "GET",
163
- "missing": [
164
- ""
165
- ],
166
- "flatten": true
167
- },
168
- "echo_cases": {
169
- "path": "https://echodata.epa.gov/echo/case_rest_services.get_case_info",
170
- "kind": "echo",
171
- "description": "EPA civil and criminal enforcement cases (ICIS): penalties, settlements, outcomes (two steps like echo_facilities).",
172
- "params": {
173
- "p_state": {
174
- "desc": "state code (note: p_state here, p_st is ignored)"
175
- },
176
- "p_law": {
177
- "desc": "CAA, CWA, RCRA, SDWA, CERCLA, EPCRA, TSCA, FIFRA"
178
- },
179
- "p_case_category": {
180
- "desc": "JDC judicial, AFR administrative formal ..."
181
- },
182
- "p_case_status": {
183
- "desc": "case status code(s), comma-separated: CLS closed, CNC concluded, FOI final order issued, CFL complaint filed ... (codes, not words: Closed matches nothing)"
184
- },
185
- "p_milestone_fy": {
186
- "desc": "one fiscal year: cases with an administrative or judicial milestone in that FY (p_fy is ignored by ECHO)"
187
- },
188
- "p_milestone": {
189
- "desc": "milestone code(s) to go with p_milestone_fy (codes are not listed in ECHO's service description; unverified)"
190
- },
191
- "p_civil_criminal_indicator": {
192
- "desc": "CI civil, CR criminal, ALL both (p_crim is ignored by ECHO)",
193
- "enum": [
194
- "CI",
195
- "CR",
196
- "ALL"
197
- ]
198
- },
199
- "p_fed_penalty": {
200
- "desc": "federal penalty assessed: ANY, LE5000, GT5000, GT50000, GT100000, GT500000, GT1000000, GT2500000",
201
- "enum": [
202
- "ANY",
203
- "LE5000",
204
- "GT5000",
205
- "GT50000",
206
- "GT100000",
207
- "GT500000",
208
- "GT1000000",
209
- "GT2500000"
210
- ]
211
- }
212
- },
213
- "records": "Cases",
214
- "paging": {
215
- "type": "none",
216
- "size": 1000
217
- },
218
- "max_rows": 100000,
219
- "method": "GET",
220
- "missing": [
221
- ""
222
- ],
223
- "flatten": true
224
- },
225
- "echo_facility_detail": {
226
- "path": "https://echodata.epa.gov/echo/dfr_rest_services.get_dfr",
227
- "description": "Detailed Facility Report for one FRS registry id: permits, inspections, violations, enforcement (one row; sections as JSON text).",
228
- "params": {
229
- "p_id": {
230
- "required": true,
231
- "desc": "FRS RegistryID, e.g. 110008205307"
232
- }
233
- },
234
- "defaults": {
235
- "output": "JSON"
236
- },
237
- "records": "Results",
238
- "paging": {
239
- "type": "none"
240
- },
241
- "method": "GET",
242
- "missing": [
243
- ""
244
- ],
245
- "flatten": true
246
- }
247
- },
248
- "catalog": {
249
- "tri_facility": {
250
- "id": "tri.tri_facility",
251
- "name": "tri.tri_facility",
252
- "description": "TRI reporting facilities: name, address, county, parent company, FRS id (useful filter columns: state_abbr, county_name)",
253
- "endpoint": "envirofacts"
254
- },
255
- "tri_reporting_form": {
256
- "id": "tri.tri_reporting_form",
257
- "name": "tri.tri_reporting_form",
258
- "description": "TRI Form R/A submissions: chemical, reporting year, facility (doc_ctrl_num links releases) (useful filter columns: reporting_year, tri_facility_id, cas_chem_name)",
259
- "endpoint": "envirofacts"
260
- },
261
- "tri_release_qty": {
262
- "id": "tri.tri_release_qty",
263
- "name": "tri.tri_release_qty",
264
- "description": "TRI release quantities by environmental medium per form (doc_ctrl_num) (useful filter columns: doc_ctrl_num, environmental_medium)",
265
- "endpoint": "envirofacts"
266
- },
267
- "ghg_emitters": {
268
- "id": "ghg.ghg_emitter_sector",
269
- "name": "ghg.ghg_emitter_sector",
270
- "description": "GHGRP large emitters: facility, sector, gas, CO2e emissions (metric tons) by year (useful filter columns: state, year, sector_name, gas_code)",
271
- "endpoint": "envirofacts"
272
- },
273
- "sdwis_systems": {
274
- "id": "sdwis.water_system",
275
- "name": "sdwis.water_system",
276
- "description": "SDWIS public water systems: type (CWS, NTNCWS, TNCWS), population served, source, activity (useful filter columns: state_code, primacy_agency_code, pws_type_code)",
277
- "endpoint": "envirofacts"
278
- },
279
- "sdwis_violations": {
280
- "id": "sdwis.violation",
281
- "name": "sdwis.violation",
282
- "description": "SDWIS drinking water violations: rule, contaminant, health-based flag, compliance period (useful filter columns: primacy_agency_code, pwsid, is_health_based_ind)",
283
- "endpoint": "envirofacts"
284
- },
285
- "superfund_sites": {
286
- "id": "sems.envirofacts_site",
287
- "name": "sems.envirofacts_site",
288
- "description": "SEMS Superfund (CERCLA) sites: NPL status, location, federal facility flag (useful filter columns: fk_ref_state_code, npl_status_code)",
289
- "endpoint": "envirofacts"
290
- }
291
- }
1
+ {
2
+ "base_url": "https://data.epa.gov/dmapservice",
3
+ "endpoints": {
4
+ "envirofacts": {
5
+ "path": "/{table}",
6
+ "kind": "dmap",
7
+ "description": "Any Envirofacts table (DMAP): TRI, GHGRP, SDWIS, SEMS/Superfund, RCRAInfo, FRS ... filtered by column values.",
8
+ "params": {
9
+ "table": {
10
+ "in": "path",
11
+ "required": true,
12
+ "catalog": true,
13
+ "desc": "catalog alias (tri_facility, ghg_emitters, sdwis_systems ...) or schema.table"
14
+ },
15
+ "filters": {
16
+ "desc": "{\"column\": \"value\"} for equals, or [[column, operator, value], ...]; operators: equals, notEquals, lessThan, greaterThan, greaterThanEqual, beginsWith, endsWith, contains"
17
+ }
18
+ },
19
+ "records": "",
20
+ "paging": {
21
+ "type": "none",
22
+ "size": 5000
23
+ },
24
+ "max_rows": 200000,
25
+ "method": "GET",
26
+ "missing": [
27
+ ""
28
+ ],
29
+ "flatten": true
30
+ },
31
+ "uv_daily": {
32
+ "path": "/getEnvirofactsUVDAILY/ZIP/{zip}/JSON",
33
+ "description": "Today's UV index forecast for a ZIP code (forecast, not history).",
34
+ "params": {
35
+ "zip": {
36
+ "in": "path",
37
+ "required": true,
38
+ "desc": "5-digit ZIP"
39
+ }
40
+ },
41
+ "records": "",
42
+ "paging": {
43
+ "type": "none"
44
+ },
45
+ "method": "GET",
46
+ "missing": [
47
+ ""
48
+ ],
49
+ "flatten": true
50
+ },
51
+ "uv_daily_city": {
52
+ "path": "/getEnvirofactsUVDAILY/CITY/{city}/STATE/{state}/JSON",
53
+ "description": "Today's UV index forecast for a city.",
54
+ "params": {
55
+ "city": {
56
+ "in": "path",
57
+ "required": true,
58
+ "desc": "city name"
59
+ },
60
+ "state": {
61
+ "in": "path",
62
+ "required": true,
63
+ "desc": "two-letter state code"
64
+ }
65
+ },
66
+ "records": "",
67
+ "paging": {
68
+ "type": "none"
69
+ },
70
+ "method": "GET",
71
+ "missing": [
72
+ ""
73
+ ],
74
+ "flatten": true
75
+ },
76
+ "uv_hourly": {
77
+ "path": "/getEnvirofactsUVHOURLY/ZIP/{zip}/JSON",
78
+ "description": "Today's hourly UV index forecast for a ZIP code.",
79
+ "params": {
80
+ "zip": {
81
+ "in": "path",
82
+ "required": true,
83
+ "desc": "5-digit ZIP"
84
+ }
85
+ },
86
+ "records": "",
87
+ "paging": {
88
+ "type": "none"
89
+ },
90
+ "method": "GET",
91
+ "missing": [
92
+ ""
93
+ ],
94
+ "flatten": true
95
+ },
96
+ "echo_facilities": {
97
+ "path": "https://echodata.epa.gov/echo/{program}_rest_services.get_facilities",
98
+ "kind": "echo",
99
+ "description": "ECHO facility compliance search (two steps: query, then pages of rows): air (CAA), cwa (CWA/NPDES), rcra (hazardous waste), sdw (drinking water systems), echo (all programs).",
100
+ "params": {
101
+ "program": {
102
+ "in": "path",
103
+ "required": true,
104
+ "enum": [
105
+ "air",
106
+ "cwa",
107
+ "rcra",
108
+ "sdw",
109
+ "echo"
110
+ ],
111
+ "desc": "air, cwa, rcra, sdw or echo"
112
+ },
113
+ "p_st": {
114
+ "desc": "state code, e.g. TX"
115
+ },
116
+ "p_co": {
117
+ "desc": "county name, with p_st (returns 0 rows for program air, verified 2026-10: use p_fips there)"
118
+ },
119
+ "p_fips": {
120
+ "desc": "5-digit state+county FIPS, e.g. 35015 (air, cwa, rcra, echo)"
121
+ },
122
+ "p_ct": {
123
+ "desc": "city"
124
+ },
125
+ "p_zip": {
126
+ "desc": "5-digit ZIP"
127
+ },
128
+ "p_fn": {
129
+ "desc": "facility name (contains)"
130
+ },
131
+ "p_act": {
132
+ "desc": "Y: active facilities only"
133
+ },
134
+ "p_maj": {
135
+ "desc": "Y: major facilities only (air, cwa)"
136
+ },
137
+ "p_ncs": {
138
+ "desc": "NAICS code, 2 to 6 digits (shorter matches every code it begins; p_naics is ignored by ECHO)"
139
+ },
140
+ "p_sic": {
141
+ "desc": "SIC code"
142
+ },
143
+ "p_qiv": {
144
+ "desc": "quarters in violation, e.g. GT4"
145
+ },
146
+ "p_impw": {
147
+ "desc": "cwa: Y impaired waters"
148
+ },
149
+ "p_pen": {
150
+ "desc": "penalty range"
151
+ },
152
+ "qcolumns": {
153
+ "desc": "comma-separated column ids to return (ids: <program>_rest_services.metadata?output=JSON, ResultColumns); sent to the search and to every get_qid page"
154
+ }
155
+ },
156
+ "records": "Facilities",
157
+ "paging": {
158
+ "type": "none",
159
+ "size": 1000
160
+ },
161
+ "max_rows": 100000,
162
+ "method": "GET",
163
+ "missing": [
164
+ ""
165
+ ],
166
+ "flatten": true
167
+ },
168
+ "echo_cases": {
169
+ "path": "https://echodata.epa.gov/echo/case_rest_services.get_case_info",
170
+ "kind": "echo",
171
+ "description": "EPA civil and criminal enforcement cases (ICIS): penalties, settlements, outcomes (two steps like echo_facilities).",
172
+ "params": {
173
+ "p_state": {
174
+ "desc": "state code (note: p_state here, p_st is ignored)"
175
+ },
176
+ "p_law": {
177
+ "desc": "CAA, CWA, RCRA, SDWA, CERCLA, EPCRA, TSCA, FIFRA"
178
+ },
179
+ "p_case_category": {
180
+ "desc": "JDC judicial, AFR administrative formal ..."
181
+ },
182
+ "p_case_status": {
183
+ "desc": "case status code(s), comma-separated: CLS closed, CNC concluded, FOI final order issued, CFL complaint filed ... (codes, not words: Closed matches nothing)"
184
+ },
185
+ "p_milestone_fy": {
186
+ "desc": "one fiscal year: cases with an administrative or judicial milestone in that FY (p_fy is ignored by ECHO)"
187
+ },
188
+ "p_milestone": {
189
+ "desc": "milestone code(s) to go with p_milestone_fy (codes are not listed in ECHO's service description; unverified)"
190
+ },
191
+ "p_civil_criminal_indicator": {
192
+ "desc": "CI civil, CR criminal, ALL both (p_crim is ignored by ECHO)",
193
+ "enum": [
194
+ "CI",
195
+ "CR",
196
+ "ALL"
197
+ ]
198
+ },
199
+ "p_fed_penalty": {
200
+ "desc": "federal penalty assessed: ANY, LE5000, GT5000, GT50000, GT100000, GT500000, GT1000000, GT2500000",
201
+ "enum": [
202
+ "ANY",
203
+ "LE5000",
204
+ "GT5000",
205
+ "GT50000",
206
+ "GT100000",
207
+ "GT500000",
208
+ "GT1000000",
209
+ "GT2500000"
210
+ ]
211
+ }
212
+ },
213
+ "records": "Cases",
214
+ "paging": {
215
+ "type": "none",
216
+ "size": 1000
217
+ },
218
+ "max_rows": 100000,
219
+ "method": "GET",
220
+ "missing": [
221
+ ""
222
+ ],
223
+ "flatten": true
224
+ },
225
+ "echo_facility_detail": {
226
+ "path": "https://echodata.epa.gov/echo/dfr_rest_services.get_dfr",
227
+ "description": "Detailed Facility Report for one FRS registry id: permits, inspections, violations, enforcement (one row; sections as JSON text).",
228
+ "params": {
229
+ "p_id": {
230
+ "required": true,
231
+ "desc": "FRS RegistryID, e.g. 110008205307"
232
+ }
233
+ },
234
+ "defaults": {
235
+ "output": "JSON"
236
+ },
237
+ "records": "Results",
238
+ "paging": {
239
+ "type": "none"
240
+ },
241
+ "method": "GET",
242
+ "missing": [
243
+ ""
244
+ ],
245
+ "flatten": true
246
+ }
247
+ },
248
+ "catalog": {
249
+ "tri_facility": {
250
+ "id": "tri.tri_facility",
251
+ "name": "tri.tri_facility",
252
+ "description": "TRI reporting facilities: name, address, county, parent company, FRS id (useful filter columns: state_abbr, county_name)",
253
+ "endpoint": "envirofacts"
254
+ },
255
+ "tri_reporting_form": {
256
+ "id": "tri.tri_reporting_form",
257
+ "name": "tri.tri_reporting_form",
258
+ "description": "TRI Form R/A submissions: chemical, reporting year, facility (doc_ctrl_num links releases) (useful filter columns: reporting_year, tri_facility_id, cas_chem_name)",
259
+ "endpoint": "envirofacts"
260
+ },
261
+ "tri_release_qty": {
262
+ "id": "tri.tri_release_qty",
263
+ "name": "tri.tri_release_qty",
264
+ "description": "TRI release quantities by environmental medium per form (doc_ctrl_num) (useful filter columns: doc_ctrl_num, environmental_medium)",
265
+ "endpoint": "envirofacts"
266
+ },
267
+ "ghg_emitters": {
268
+ "id": "ghg.ghg_emitter_sector",
269
+ "name": "ghg.ghg_emitter_sector",
270
+ "description": "GHGRP large emitters: facility, sector, gas, CO2e emissions (metric tons) by year (useful filter columns: state, year, sector_name, gas_code)",
271
+ "endpoint": "envirofacts"
272
+ },
273
+ "sdwis_systems": {
274
+ "id": "sdwis.water_system",
275
+ "name": "sdwis.water_system",
276
+ "description": "SDWIS public water systems: type (CWS, NTNCWS, TNCWS), population served, source, activity (useful filter columns: state_code, primacy_agency_code, pws_type_code)",
277
+ "endpoint": "envirofacts"
278
+ },
279
+ "sdwis_violations": {
280
+ "id": "sdwis.violation",
281
+ "name": "sdwis.violation",
282
+ "description": "SDWIS drinking water violations: rule, contaminant, health-based flag, compliance period (useful filter columns: primacy_agency_code, pwsid, is_health_based_ind)",
283
+ "endpoint": "envirofacts"
284
+ },
285
+ "superfund_sites": {
286
+ "id": "sems.envirofacts_site",
287
+ "name": "sems.envirofacts_site",
288
+ "description": "SEMS Superfund (CERCLA) sites: NPL status, location, federal facility flag (useful filter columns: fk_ref_state_code, npl_status_code)",
289
+ "endpoint": "envirofacts"
290
+ }
291
+ }
292
292
  }