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,313 +1,313 @@
1
- {
2
- "base_url": "https://api.waterdata.usgs.gov/ogcapi/v1",
3
- "endpoints": {
4
- "earthquakes": {
5
- "path": "https://earthquake.usgs.gov/fdsnws/event/1/query",
6
- "description": "Earthquake catalog search (ComCat, FDSN event service): one row per event.",
7
- "params": {
8
- "starttime": {
9
- "desc": "YYYY-MM-DD or ISO time (UTC); default 30 days ago"
10
- },
11
- "endtime": {
12
- "desc": "YYYY-MM-DD (UTC); default now"
13
- },
14
- "minmagnitude": {
15
- "desc": "e.g. 2.5"
16
- },
17
- "maxmagnitude": {},
18
- "mindepth": {
19
- "desc": "km"
20
- },
21
- "maxdepth": {
22
- "desc": "km"
23
- },
24
- "latitude": {
25
- "desc": "circle center"
26
- },
27
- "longitude": {},
28
- "maxradiuskm": {
29
- "desc": "circle radius, km (max 20001.6)"
30
- },
31
- "minlatitude": {
32
- "desc": "box"
33
- },
34
- "maxlatitude": {},
35
- "minlongitude": {},
36
- "maxlongitude": {},
37
- "alertlevel": {
38
- "desc": "PAGER level: green, yellow, orange, red"
39
- },
40
- "eventtype": {
41
- "desc": "earthquake (default all: also quarry blast, explosion ...)"
42
- },
43
- "minfelt": {
44
- "desc": "minimum Did You Feel It? reports"
45
- },
46
- "reviewstatus": {
47
- "desc": "automatic or reviewed"
48
- },
49
- "orderby": {
50
- "desc": "time (default), time-asc, magnitude, magnitude-asc"
51
- },
52
- "eventid": {
53
- "desc": "one event id"
54
- }
55
- },
56
- "defaults": {
57
- "format": "geojson",
58
- "orderby": "time",
59
- "offset": 1
60
- },
61
- "records": "features",
62
- "paging": {
63
- "type": "offset",
64
- "limit_param": "limit",
65
- "offset_param": "offset",
66
- "size": 20000
67
- },
68
- "max_rows": 100000,
69
- "method": "GET",
70
- "missing": [
71
- ""
72
- ],
73
- "flatten": true
74
- },
75
- "earthquake_count": {
76
- "path": "https://earthquake.usgs.gov/fdsnws/event/1/count",
77
- "description": "Number of events matching the same filters (one row: count, maxAllowed).",
78
- "params": {
79
- "starttime": {
80
- "desc": "YYYY-MM-DD or ISO time (UTC); default 30 days ago"
81
- },
82
- "endtime": {
83
- "desc": "YYYY-MM-DD (UTC); default now"
84
- },
85
- "minmagnitude": {
86
- "desc": "e.g. 2.5"
87
- },
88
- "maxmagnitude": {},
89
- "mindepth": {
90
- "desc": "km"
91
- },
92
- "maxdepth": {
93
- "desc": "km"
94
- },
95
- "latitude": {
96
- "desc": "circle center"
97
- },
98
- "longitude": {},
99
- "maxradiuskm": {
100
- "desc": "circle radius, km (max 20001.6)"
101
- },
102
- "minlatitude": {
103
- "desc": "box"
104
- },
105
- "maxlatitude": {},
106
- "minlongitude": {},
107
- "maxlongitude": {},
108
- "alertlevel": {
109
- "desc": "PAGER level: green, yellow, orange, red"
110
- },
111
- "eventtype": {
112
- "desc": "earthquake (default all: also quarry blast, explosion ...)"
113
- },
114
- "minfelt": {
115
- "desc": "minimum Did You Feel It? reports"
116
- },
117
- "reviewstatus": {
118
- "desc": "automatic or reviewed"
119
- },
120
- "orderby": {
121
- "desc": "time (default), time-asc, magnitude, magnitude-asc"
122
- },
123
- "eventid": {
124
- "desc": "one event id"
125
- }
126
- },
127
- "defaults": {
128
- "format": "geojson"
129
- },
130
- "records": "",
131
- "paging": {
132
- "type": "none"
133
- },
134
- "method": "GET",
135
- "missing": [
136
- ""
137
- ],
138
- "flatten": true
139
- },
140
- "earthquake_feed": {
141
- "path": "https://earthquake.usgs.gov/earthquakes/feed/v1.0/summary/{feed}.geojson",
142
- "description": "Real-time summary feeds: significant_month, 4.5_week, 2.5_day, all_hour ...",
143
- "params": {
144
- "feed": {
145
- "in": "path",
146
- "required": true,
147
- "desc": "{significant|4.5|2.5|1.0|all}_{hour|day|week|month}"
148
- }
149
- },
150
- "records": "features",
151
- "paging": {
152
- "type": "none"
153
- },
154
- "method": "GET",
155
- "missing": [
156
- ""
157
- ],
158
- "flatten": true
159
- },
160
- "water": {
161
- "path": "/collections/{collection}/items",
162
- "description": "USGS Water Data OGC API (v1): daily values, continuous (15-minute) values, latest values, monitoring locations, field measurements, annual peaks.",
163
- "params": {
164
- "collection": {
165
- "in": "path",
166
- "required": true,
167
- "catalog": true,
168
- "desc": "daily, continuous, latest-continuous, latest-daily, monitoring-locations, field-measurements, peaks, time-series-metadata, parameter-codes ..."
169
- },
170
- "monitoring_location_id": {
171
- "desc": "USGS-01646500 (bare site numbers get the USGS- prefix); comma-separated"
172
- },
173
- "parameter_code": {
174
- "desc": "00060 discharge, 00065 gage height, 00010 water temperature, 72019 depth to water ..."
175
- },
176
- "statistic_id": {
177
- "desc": "daily: 00003 mean, 00001 max, 00002 min"
178
- },
179
- "time": {
180
- "desc": "ISO 8601 interval: 2024-01-01/2024-12-31, 2024-01-01/.., or a duration such as P7D"
181
- },
182
- "state_code": {
183
- "desc": "state FIPS (VT or Vermont are converted)"
184
- },
185
- "county_code": {
186
- "desc": "3-digit county FIPS"
187
- },
188
- "site_type_code": {
189
- "desc": "ST stream, GW well, LK lake, SP spring, AT atmosphere ..."
190
- },
191
- "hydrologic_unit_code": {
192
- "desc": "HUC"
193
- },
194
- "bbox": {
195
- "desc": "west,south,east,north"
196
- },
197
- "approval_status": {
198
- "desc": "Approved or Provisional"
199
- },
200
- "properties": {
201
- "desc": "comma-separated columns to return"
202
- },
203
- "skipGeometry": {
204
- "desc": "true drops coordinates (default true except for monitoring-locations)"
205
- },
206
- "filter": {
207
- "desc": "CQL2 text filter"
208
- }
209
- },
210
- "defaults": {
211
- "f": "json"
212
- },
213
- "records": "features",
214
- "paging": {
215
- "type": "link",
216
- "next": "$ogc_next",
217
- "size": 10000
218
- },
219
- "max_rows": 200000,
220
- "method": "GET",
221
- "missing": [
222
- ""
223
- ],
224
- "flatten": true
225
- }
226
- },
227
- "catalog": {
228
- "daily": {
229
- "id": "daily",
230
- "name": "daily",
231
- "description": "daily values (one per day: mean/max/min by statistic_id), since a site's start",
232
- "endpoint": "water"
233
- },
234
- "continuous": {
235
- "id": "continuous",
236
- "name": "continuous",
237
- "description": "continuous sensor values, usually every 15 minutes (recent years; large)",
238
- "endpoint": "water"
239
- },
240
- "latest-continuous": {
241
- "id": "latest-continuous",
242
- "name": "latest-continuous",
243
- "description": "the latest continuous value of every time series (use state_code for a whole state)",
244
- "endpoint": "water"
245
- },
246
- "latest-daily": {
247
- "id": "latest-daily",
248
- "name": "latest-daily",
249
- "description": "the latest daily value of every time series",
250
- "endpoint": "water"
251
- },
252
- "monitoring-locations": {
253
- "id": "monitoring-locations",
254
- "name": "monitoring-locations",
255
- "description": "site metadata: name, type, state, county, HUC, drainage area, coordinates",
256
- "endpoint": "water"
257
- },
258
- "field-measurements": {
259
- "id": "field-measurements",
260
- "name": "field-measurements",
261
- "description": "discrete field measurements (streamflow, groundwater levels)",
262
- "endpoint": "water"
263
- },
264
- "latest-field-measurements": {
265
- "id": "latest-field-measurements",
266
- "name": "latest-field-measurements",
267
- "description": "the latest field measurement of every series (gage height, discharge, groundwater level)",
268
- "endpoint": "water"
269
- },
270
- "channel-measurements": {
271
- "id": "channel-measurements",
272
- "name": "channel-measurements",
273
- "description": "channel geometry and velocity taken with streamflow field measurements (width, area, velocity)",
274
- "endpoint": "water"
275
- },
276
- "peaks": {
277
- "id": "peaks",
278
- "name": "peaks",
279
- "description": "annual peak streamflow and gage height",
280
- "endpoint": "water"
281
- },
282
- "time-series-metadata": {
283
- "id": "time-series-metadata",
284
- "name": "time-series-metadata",
285
- "description": "which parameters and statistics a site has, with begin/end dates",
286
- "endpoint": "water"
287
- },
288
- "parameter-codes": {
289
- "id": "parameter-codes",
290
- "name": "parameter-codes",
291
- "description": "parameter code reference table",
292
- "endpoint": "water"
293
- },
294
- "statistic-codes": {
295
- "id": "statistic-codes",
296
- "name": "statistic-codes",
297
- "description": "statistic code reference table",
298
- "endpoint": "water"
299
- },
300
- "streamflow_daily": {
301
- "id": "daily",
302
- "name": "Daily mean streamflow",
303
- "description": "daily with parameter_code 00060, statistic_id 00003 (cubic feet per second)",
304
- "endpoint": "water"
305
- },
306
- "groundwater_levels": {
307
- "id": "field-measurements",
308
- "name": "Groundwater levels",
309
- "description": "field-measurements with parameter_code 72019 (depth to water, feet below land surface)",
310
- "endpoint": "water"
311
- }
312
- }
313
- }
1
+ {
2
+ "base_url": "https://api.waterdata.usgs.gov/ogcapi/v1",
3
+ "endpoints": {
4
+ "earthquakes": {
5
+ "path": "https://earthquake.usgs.gov/fdsnws/event/1/query",
6
+ "description": "Earthquake catalog search (ComCat, FDSN event service): one row per event.",
7
+ "params": {
8
+ "starttime": {
9
+ "desc": "YYYY-MM-DD or ISO time (UTC); default 30 days ago"
10
+ },
11
+ "endtime": {
12
+ "desc": "YYYY-MM-DD (UTC); default now"
13
+ },
14
+ "minmagnitude": {
15
+ "desc": "e.g. 2.5"
16
+ },
17
+ "maxmagnitude": {},
18
+ "mindepth": {
19
+ "desc": "km"
20
+ },
21
+ "maxdepth": {
22
+ "desc": "km"
23
+ },
24
+ "latitude": {
25
+ "desc": "circle center"
26
+ },
27
+ "longitude": {},
28
+ "maxradiuskm": {
29
+ "desc": "circle radius, km (max 20001.6)"
30
+ },
31
+ "minlatitude": {
32
+ "desc": "box"
33
+ },
34
+ "maxlatitude": {},
35
+ "minlongitude": {},
36
+ "maxlongitude": {},
37
+ "alertlevel": {
38
+ "desc": "PAGER level: green, yellow, orange, red"
39
+ },
40
+ "eventtype": {
41
+ "desc": "earthquake (default all: also quarry blast, explosion ...)"
42
+ },
43
+ "minfelt": {
44
+ "desc": "minimum Did You Feel It? reports"
45
+ },
46
+ "reviewstatus": {
47
+ "desc": "automatic or reviewed"
48
+ },
49
+ "orderby": {
50
+ "desc": "time (default), time-asc, magnitude, magnitude-asc"
51
+ },
52
+ "eventid": {
53
+ "desc": "one event id"
54
+ }
55
+ },
56
+ "defaults": {
57
+ "format": "geojson",
58
+ "orderby": "time",
59
+ "offset": 1
60
+ },
61
+ "records": "features",
62
+ "paging": {
63
+ "type": "offset",
64
+ "limit_param": "limit",
65
+ "offset_param": "offset",
66
+ "size": 20000
67
+ },
68
+ "max_rows": 100000,
69
+ "method": "GET",
70
+ "missing": [
71
+ ""
72
+ ],
73
+ "flatten": true
74
+ },
75
+ "earthquake_count": {
76
+ "path": "https://earthquake.usgs.gov/fdsnws/event/1/count",
77
+ "description": "Number of events matching the same filters (one row: count, maxAllowed).",
78
+ "params": {
79
+ "starttime": {
80
+ "desc": "YYYY-MM-DD or ISO time (UTC); default 30 days ago"
81
+ },
82
+ "endtime": {
83
+ "desc": "YYYY-MM-DD (UTC); default now"
84
+ },
85
+ "minmagnitude": {
86
+ "desc": "e.g. 2.5"
87
+ },
88
+ "maxmagnitude": {},
89
+ "mindepth": {
90
+ "desc": "km"
91
+ },
92
+ "maxdepth": {
93
+ "desc": "km"
94
+ },
95
+ "latitude": {
96
+ "desc": "circle center"
97
+ },
98
+ "longitude": {},
99
+ "maxradiuskm": {
100
+ "desc": "circle radius, km (max 20001.6)"
101
+ },
102
+ "minlatitude": {
103
+ "desc": "box"
104
+ },
105
+ "maxlatitude": {},
106
+ "minlongitude": {},
107
+ "maxlongitude": {},
108
+ "alertlevel": {
109
+ "desc": "PAGER level: green, yellow, orange, red"
110
+ },
111
+ "eventtype": {
112
+ "desc": "earthquake (default all: also quarry blast, explosion ...)"
113
+ },
114
+ "minfelt": {
115
+ "desc": "minimum Did You Feel It? reports"
116
+ },
117
+ "reviewstatus": {
118
+ "desc": "automatic or reviewed"
119
+ },
120
+ "orderby": {
121
+ "desc": "time (default), time-asc, magnitude, magnitude-asc"
122
+ },
123
+ "eventid": {
124
+ "desc": "one event id"
125
+ }
126
+ },
127
+ "defaults": {
128
+ "format": "geojson"
129
+ },
130
+ "records": "",
131
+ "paging": {
132
+ "type": "none"
133
+ },
134
+ "method": "GET",
135
+ "missing": [
136
+ ""
137
+ ],
138
+ "flatten": true
139
+ },
140
+ "earthquake_feed": {
141
+ "path": "https://earthquake.usgs.gov/earthquakes/feed/v1.0/summary/{feed}.geojson",
142
+ "description": "Real-time summary feeds: significant_month, 4.5_week, 2.5_day, all_hour ...",
143
+ "params": {
144
+ "feed": {
145
+ "in": "path",
146
+ "required": true,
147
+ "desc": "{significant|4.5|2.5|1.0|all}_{hour|day|week|month}"
148
+ }
149
+ },
150
+ "records": "features",
151
+ "paging": {
152
+ "type": "none"
153
+ },
154
+ "method": "GET",
155
+ "missing": [
156
+ ""
157
+ ],
158
+ "flatten": true
159
+ },
160
+ "water": {
161
+ "path": "/collections/{collection}/items",
162
+ "description": "USGS Water Data OGC API (v1): daily values, continuous (15-minute) values, latest values, monitoring locations, field measurements, annual peaks.",
163
+ "params": {
164
+ "collection": {
165
+ "in": "path",
166
+ "required": true,
167
+ "catalog": true,
168
+ "desc": "daily, continuous, latest-continuous, latest-daily, monitoring-locations, field-measurements, peaks, time-series-metadata, parameter-codes ..."
169
+ },
170
+ "monitoring_location_id": {
171
+ "desc": "USGS-01646500 (bare site numbers get the USGS- prefix); comma-separated"
172
+ },
173
+ "parameter_code": {
174
+ "desc": "00060 discharge, 00065 gage height, 00010 water temperature, 72019 depth to water ..."
175
+ },
176
+ "statistic_id": {
177
+ "desc": "daily: 00003 mean, 00001 max, 00002 min"
178
+ },
179
+ "time": {
180
+ "desc": "ISO 8601 interval: 2024-01-01/2024-12-31, 2024-01-01/.., or a duration such as P7D"
181
+ },
182
+ "state_code": {
183
+ "desc": "state FIPS (VT or Vermont are converted)"
184
+ },
185
+ "county_code": {
186
+ "desc": "3-digit county FIPS"
187
+ },
188
+ "site_type_code": {
189
+ "desc": "ST stream, GW well, LK lake, SP spring, AT atmosphere ..."
190
+ },
191
+ "hydrologic_unit_code": {
192
+ "desc": "HUC"
193
+ },
194
+ "bbox": {
195
+ "desc": "west,south,east,north"
196
+ },
197
+ "approval_status": {
198
+ "desc": "Approved or Provisional"
199
+ },
200
+ "properties": {
201
+ "desc": "comma-separated columns to return"
202
+ },
203
+ "skipGeometry": {
204
+ "desc": "true drops coordinates (default true except for monitoring-locations)"
205
+ },
206
+ "filter": {
207
+ "desc": "CQL2 text filter"
208
+ }
209
+ },
210
+ "defaults": {
211
+ "f": "json"
212
+ },
213
+ "records": "features",
214
+ "paging": {
215
+ "type": "link",
216
+ "next": "$ogc_next",
217
+ "size": 10000
218
+ },
219
+ "max_rows": 200000,
220
+ "method": "GET",
221
+ "missing": [
222
+ ""
223
+ ],
224
+ "flatten": true
225
+ }
226
+ },
227
+ "catalog": {
228
+ "daily": {
229
+ "id": "daily",
230
+ "name": "daily",
231
+ "description": "daily values (one per day: mean/max/min by statistic_id), since a site's start",
232
+ "endpoint": "water"
233
+ },
234
+ "continuous": {
235
+ "id": "continuous",
236
+ "name": "continuous",
237
+ "description": "continuous sensor values, usually every 15 minutes (recent years; large)",
238
+ "endpoint": "water"
239
+ },
240
+ "latest-continuous": {
241
+ "id": "latest-continuous",
242
+ "name": "latest-continuous",
243
+ "description": "the latest continuous value of every time series (use state_code for a whole state)",
244
+ "endpoint": "water"
245
+ },
246
+ "latest-daily": {
247
+ "id": "latest-daily",
248
+ "name": "latest-daily",
249
+ "description": "the latest daily value of every time series",
250
+ "endpoint": "water"
251
+ },
252
+ "monitoring-locations": {
253
+ "id": "monitoring-locations",
254
+ "name": "monitoring-locations",
255
+ "description": "site metadata: name, type, state, county, HUC, drainage area, coordinates",
256
+ "endpoint": "water"
257
+ },
258
+ "field-measurements": {
259
+ "id": "field-measurements",
260
+ "name": "field-measurements",
261
+ "description": "discrete field measurements (streamflow, groundwater levels)",
262
+ "endpoint": "water"
263
+ },
264
+ "latest-field-measurements": {
265
+ "id": "latest-field-measurements",
266
+ "name": "latest-field-measurements",
267
+ "description": "the latest field measurement of every series (gage height, discharge, groundwater level)",
268
+ "endpoint": "water"
269
+ },
270
+ "channel-measurements": {
271
+ "id": "channel-measurements",
272
+ "name": "channel-measurements",
273
+ "description": "channel geometry and velocity taken with streamflow field measurements (width, area, velocity)",
274
+ "endpoint": "water"
275
+ },
276
+ "peaks": {
277
+ "id": "peaks",
278
+ "name": "peaks",
279
+ "description": "annual peak streamflow and gage height",
280
+ "endpoint": "water"
281
+ },
282
+ "time-series-metadata": {
283
+ "id": "time-series-metadata",
284
+ "name": "time-series-metadata",
285
+ "description": "which parameters and statistics a site has, with begin/end dates",
286
+ "endpoint": "water"
287
+ },
288
+ "parameter-codes": {
289
+ "id": "parameter-codes",
290
+ "name": "parameter-codes",
291
+ "description": "parameter code reference table",
292
+ "endpoint": "water"
293
+ },
294
+ "statistic-codes": {
295
+ "id": "statistic-codes",
296
+ "name": "statistic-codes",
297
+ "description": "statistic code reference table",
298
+ "endpoint": "water"
299
+ },
300
+ "streamflow_daily": {
301
+ "id": "daily",
302
+ "name": "Daily mean streamflow",
303
+ "description": "daily with parameter_code 00060, statistic_id 00003 (cubic feet per second)",
304
+ "endpoint": "water"
305
+ },
306
+ "groundwater_levels": {
307
+ "id": "field-measurements",
308
+ "name": "Groundwater levels",
309
+ "description": "field-measurements with parameter_code 72019 (depth to water, feet below land surface)",
310
+ "endpoint": "water"
311
+ }
312
+ }
313
+ }