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,432 +1,432 @@
1
- {
2
- "base_url": "https://www.ncei.noaa.gov",
3
- "endpoints": {
4
- "data": {
5
- "path": "/access/services/data/v1",
6
- "method": "GET",
7
- "description": "Keyless NCEI Access Data Service: station observations (one row per station and date, one column per data type).",
8
- "params": {
9
- "dataset": {
10
- "required": true,
11
- "catalog": true,
12
- "desc": "catalog alias (daily, monthly, annual, normals_monthly ...) or ADS dataset id (daily-summaries)"
13
- },
14
- "stations": {
15
- "desc": "station id(s), comma-separated, e.g. USW00094728 (a GHCND: prefix is removed)",
16
- "required": true
17
- },
18
- "startDate": {
19
- "required": true,
20
- "desc": "YYYY-MM-DD (also for monthly and annual datasets: ADS refuses YYYY-MM; the pack pads YYYY-MM to the 1st and YYYY to Jan 1)"
21
- },
22
- "endDate": {
23
- "required": true,
24
- "desc": "YYYY-MM-DD (the pack pads YYYY-MM to the month's last day and YYYY to Dec 31)"
25
- },
26
- "dataTypes": {
27
- "desc": "comma-separated, case-sensitive: TMAX,TMIN,TAVG,PRCP,SNOW,SNWD,AWND ... (a misspelled type is silently absent)"
28
- },
29
- "units": {
30
- "desc": "standard (F, inches; default here) or metric (C, mm); never omitted: without units GHCN-Daily values come in tenths",
31
- "enum": [
32
- "standard",
33
- "metric"
34
- ]
35
- },
36
- "includeAttributes": {
37
- "desc": "true adds <TYPE>_ATTRIBUTES flag columns"
38
- },
39
- "includeStationName": {
40
- "desc": "true adds NAME"
41
- },
42
- "includeStationLocation": {
43
- "desc": "1 adds LATITUDE, LONGITUDE, ELEVATION"
44
- }
45
- },
46
- "defaults": {
47
- "format": "json",
48
- "units": "standard"
49
- },
50
- "records": "",
51
- "paging": {
52
- "type": "none"
53
- },
54
- "max_rows": 500000,
55
- "missing": [
56
- ""
57
- ],
58
- "flatten": true
59
- },
60
- "station_search": {
61
- "path": "/access/services/search/v1/data",
62
- "method": "GET",
63
- "description": "Keyless NCEI search: stations with data for a dataset in a bounding box and period (one row per station).",
64
- "params": {
65
- "dataset": {
66
- "required": true,
67
- "catalog": true,
68
- "desc": "alias or ADS dataset id"
69
- },
70
- "bbox": {
71
- "desc": "north,west,south,east"
72
- },
73
- "startDate": {
74
- "desc": "YYYY-MM-DDT00:00:00"
75
- },
76
- "endDate": {
77
- "desc": "YYYY-MM-DDT23:59:59"
78
- },
79
- "dataTypes": {
80
- "desc": "comma-separated data types the station must have"
81
- },
82
- "stations": {
83
- "desc": "station id(s), comma-separated, e.g. USW00094728: that station's period and data types (the free-text search was removed: `text` answers HTTP 400 \"Invalid search options\", verified 2026-10)"
84
- }
85
- },
86
- "records": "results",
87
- "total": "count",
88
- "paging": {
89
- "type": "offset",
90
- "limit_param": "limit",
91
- "offset_param": "offset",
92
- "size": 100
93
- },
94
- "max_rows": 5000,
95
- "missing": [
96
- ""
97
- ],
98
- "flatten": true
99
- },
100
- "cdo_data": {
101
- "path": "/cdo-web/api/v2/data",
102
- "method": "GET",
103
- "description": "Observations in long form (one row per station, date, data type) (CDO v2, needs NOAA_API_KEY)",
104
- "params": {
105
- "datasetid": {
106
- "desc": "GHCND, GSOM, GSOY, NORMAL_DLY, NORMAL_MLY ...",
107
- "required": true
108
- },
109
- "locationid": {
110
- "desc": "FIPS:36 (state), FIPS:36061 (county), CITY:US360019 ..."
111
- },
112
- "stationid": {
113
- "desc": "GHCND:USW00094728"
114
- },
115
- "datatypeid": {
116
- "desc": "TMAX, PRCP ..."
117
- },
118
- "startdate": {
119
- "desc": "YYYY-MM-DD",
120
- "required": true
121
- },
122
- "enddate": {
123
- "desc": "YYYY-MM-DD",
124
- "required": true
125
- },
126
- "sortfield": {
127
- "desc": "id, name, mindate, maxdate, datacoverage"
128
- },
129
- "sortorder": {
130
- "desc": "asc or desc"
131
- },
132
- "extent": {
133
- "desc": "stations only: south,west,north,east bounding box"
134
- },
135
- "locationcategoryid": {
136
- "desc": "locations only: ST, CNTY, CITY, CLIM_REG, CNTRY ..."
137
- }
138
- },
139
- "defaults": {
140
- "offset": 1,
141
- "units": "standard"
142
- },
143
- "records": "results",
144
- "total": "metadata.resultset.count",
145
- "paging": {
146
- "type": "offset",
147
- "limit_param": "limit",
148
- "offset_param": "offset",
149
- "size": 1000
150
- },
151
- "max_rows": 200000,
152
- "missing": [
153
- ""
154
- ],
155
- "flatten": true
156
- },
157
- "cdo_stations": {
158
- "path": "/cdo-web/api/v2/stations",
159
- "method": "GET",
160
- "description": "Stations by dataset, location (FIPS) or extent (CDO v2, needs NOAA_API_KEY)",
161
- "params": {
162
- "datasetid": {
163
- "desc": "GHCND, GSOM, GSOY, NORMAL_DLY, NORMAL_MLY ..."
164
- },
165
- "locationid": {
166
- "desc": "FIPS:36 (state), FIPS:36061 (county), CITY:US360019 ..."
167
- },
168
- "stationid": {
169
- "desc": "GHCND:USW00094728"
170
- },
171
- "datatypeid": {
172
- "desc": "TMAX, PRCP ..."
173
- },
174
- "startdate": {
175
- "desc": "YYYY-MM-DD"
176
- },
177
- "enddate": {
178
- "desc": "YYYY-MM-DD"
179
- },
180
- "sortfield": {
181
- "desc": "id, name, mindate, maxdate, datacoverage"
182
- },
183
- "sortorder": {
184
- "desc": "asc or desc"
185
- },
186
- "extent": {
187
- "desc": "stations only: south,west,north,east bounding box"
188
- },
189
- "locationcategoryid": {
190
- "desc": "locations only: ST, CNTY, CITY, CLIM_REG, CNTRY ..."
191
- }
192
- },
193
- "defaults": {
194
- "offset": 1
195
- },
196
- "records": "results",
197
- "total": "metadata.resultset.count",
198
- "paging": {
199
- "type": "offset",
200
- "limit_param": "limit",
201
- "offset_param": "offset",
202
- "size": 1000
203
- },
204
- "max_rows": 20000,
205
- "missing": [
206
- ""
207
- ],
208
- "flatten": true
209
- },
210
- "cdo_locations": {
211
- "path": "/cdo-web/api/v2/locations",
212
- "method": "GET",
213
- "description": "Location ids (states FIPS:nn, counties, cities, climate regions) (CDO v2, needs NOAA_API_KEY)",
214
- "params": {
215
- "datasetid": {
216
- "desc": "GHCND, GSOM, GSOY, NORMAL_DLY, NORMAL_MLY ..."
217
- },
218
- "locationid": {
219
- "desc": "FIPS:36 (state), FIPS:36061 (county), CITY:US360019 ..."
220
- },
221
- "stationid": {
222
- "desc": "GHCND:USW00094728"
223
- },
224
- "datatypeid": {
225
- "desc": "TMAX, PRCP ..."
226
- },
227
- "startdate": {
228
- "desc": "YYYY-MM-DD"
229
- },
230
- "enddate": {
231
- "desc": "YYYY-MM-DD"
232
- },
233
- "sortfield": {
234
- "desc": "id, name, mindate, maxdate, datacoverage"
235
- },
236
- "sortorder": {
237
- "desc": "asc or desc"
238
- },
239
- "extent": {
240
- "desc": "stations only: south,west,north,east bounding box"
241
- },
242
- "locationcategoryid": {
243
- "desc": "locations only: ST, CNTY, CITY, CLIM_REG, CNTRY ..."
244
- }
245
- },
246
- "defaults": {
247
- "offset": 1
248
- },
249
- "records": "results",
250
- "total": "metadata.resultset.count",
251
- "paging": {
252
- "type": "offset",
253
- "limit_param": "limit",
254
- "offset_param": "offset",
255
- "size": 1000
256
- },
257
- "max_rows": 50000,
258
- "missing": [
259
- ""
260
- ],
261
- "flatten": true
262
- },
263
- "cdo_datasets": {
264
- "path": "/cdo-web/api/v2/datasets",
265
- "method": "GET",
266
- "description": "Dataset list with date coverage (CDO v2, needs NOAA_API_KEY)",
267
- "params": {
268
- "datasetid": {
269
- "desc": "GHCND, GSOM, GSOY, NORMAL_DLY, NORMAL_MLY ..."
270
- },
271
- "locationid": {
272
- "desc": "FIPS:36 (state), FIPS:36061 (county), CITY:US360019 ..."
273
- },
274
- "stationid": {
275
- "desc": "GHCND:USW00094728"
276
- },
277
- "datatypeid": {
278
- "desc": "TMAX, PRCP ..."
279
- },
280
- "startdate": {
281
- "desc": "YYYY-MM-DD"
282
- },
283
- "enddate": {
284
- "desc": "YYYY-MM-DD"
285
- },
286
- "sortfield": {
287
- "desc": "id, name, mindate, maxdate, datacoverage"
288
- },
289
- "sortorder": {
290
- "desc": "asc or desc"
291
- },
292
- "extent": {
293
- "desc": "stations only: south,west,north,east bounding box"
294
- },
295
- "locationcategoryid": {
296
- "desc": "locations only: ST, CNTY, CITY, CLIM_REG, CNTRY ..."
297
- }
298
- },
299
- "defaults": {
300
- "offset": 1
301
- },
302
- "records": "results",
303
- "total": "metadata.resultset.count",
304
- "paging": {
305
- "type": "offset",
306
- "limit_param": "limit",
307
- "offset_param": "offset",
308
- "size": 1000
309
- },
310
- "max_rows": 1000,
311
- "missing": [
312
- ""
313
- ],
314
- "flatten": true
315
- },
316
- "cdo_datatypes": {
317
- "path": "/cdo-web/api/v2/datatypes",
318
- "method": "GET",
319
- "description": "Data types available for a dataset, station or location (CDO v2, needs NOAA_API_KEY)",
320
- "params": {
321
- "datasetid": {
322
- "desc": "GHCND, GSOM, GSOY, NORMAL_DLY, NORMAL_MLY ..."
323
- },
324
- "locationid": {
325
- "desc": "FIPS:36 (state), FIPS:36061 (county), CITY:US360019 ..."
326
- },
327
- "stationid": {
328
- "desc": "GHCND:USW00094728"
329
- },
330
- "datatypeid": {
331
- "desc": "TMAX, PRCP ..."
332
- },
333
- "startdate": {
334
- "desc": "YYYY-MM-DD"
335
- },
336
- "enddate": {
337
- "desc": "YYYY-MM-DD"
338
- },
339
- "sortfield": {
340
- "desc": "id, name, mindate, maxdate, datacoverage"
341
- },
342
- "sortorder": {
343
- "desc": "asc or desc"
344
- },
345
- "extent": {
346
- "desc": "stations only: south,west,north,east bounding box"
347
- },
348
- "locationcategoryid": {
349
- "desc": "locations only: ST, CNTY, CITY, CLIM_REG, CNTRY ..."
350
- }
351
- },
352
- "defaults": {
353
- "offset": 1
354
- },
355
- "records": "results",
356
- "total": "metadata.resultset.count",
357
- "paging": {
358
- "type": "offset",
359
- "limit_param": "limit",
360
- "offset_param": "offset",
361
- "size": 1000
362
- },
363
- "max_rows": 5000,
364
- "missing": [
365
- ""
366
- ],
367
- "flatten": true
368
- }
369
- },
370
- "catalog": {
371
- "daily": {
372
- "id": "daily-summaries",
373
- "name": "GHCN-Daily (CDO GHCND)",
374
- "description": "daily max/min temperature, precipitation, snowfall, snow depth, wind by station",
375
- "endpoint": "data"
376
- },
377
- "monthly": {
378
- "id": "global-summary-of-the-month",
379
- "name": "Global Summary of the Month (CDO GSOM)",
380
- "description": "monthly mean/max/min temperature, total precipitation and snow, degree days",
381
- "endpoint": "data"
382
- },
383
- "annual": {
384
- "id": "global-summary-of-the-year",
385
- "name": "Global Summary of the Year (CDO GSOY)",
386
- "description": "annual temperature and precipitation summaries",
387
- "endpoint": "data"
388
- },
389
- "normals_monthly": {
390
- "id": "normals-monthly-1991-2020",
391
- "name": "U.S. Climate Normals 1991-2020, monthly",
392
- "description": "30-year monthly normals (MLY-TAVG-NORMAL, MLY-PRCP-NORMAL ...)",
393
- "endpoint": "data"
394
- },
395
- "normals_daily": {
396
- "id": "normals-daily-1991-2020",
397
- "name": "U.S. Climate Normals 1991-2020, daily",
398
- "description": "30-year daily normals (DLY-TMAX-NORMAL ...)",
399
- "endpoint": "data"
400
- },
401
- "normals_annual": {
402
- "id": "normals-annualseasonal-1991-2020",
403
- "name": "U.S. Climate Normals 1991-2020, annual/seasonal",
404
- "description": "annual and seasonal normals (ANN-TAVG-NORMAL ...)",
405
- "endpoint": "data"
406
- },
407
- "hourly": {
408
- "id": "global-hourly",
409
- "name": "Global Hourly (ISD)",
410
- "description": "hourly surface observations (large; short periods only)",
411
- "endpoint": "data"
412
- },
413
- "GHCND": {
414
- "id": "daily-summaries",
415
- "name": "GHCND (CDO name)",
416
- "description": "same as daily-summaries",
417
- "endpoint": "data"
418
- },
419
- "GSOM": {
420
- "id": "global-summary-of-the-month",
421
- "name": "GSOM (CDO name)",
422
- "description": "same as global-summary-of-the-month",
423
- "endpoint": "data"
424
- },
425
- "GSOY": {
426
- "id": "global-summary-of-the-year",
427
- "name": "GSOY (CDO name)",
428
- "description": "same as global-summary-of-the-year",
429
- "endpoint": "data"
430
- }
431
- }
1
+ {
2
+ "base_url": "https://www.ncei.noaa.gov",
3
+ "endpoints": {
4
+ "data": {
5
+ "path": "/access/services/data/v1",
6
+ "method": "GET",
7
+ "description": "Keyless NCEI Access Data Service: station observations (one row per station and date, one column per data type).",
8
+ "params": {
9
+ "dataset": {
10
+ "required": true,
11
+ "catalog": true,
12
+ "desc": "catalog alias (daily, monthly, annual, normals_monthly ...) or ADS dataset id (daily-summaries)"
13
+ },
14
+ "stations": {
15
+ "desc": "station id(s), comma-separated, e.g. USW00094728 (a GHCND: prefix is removed)",
16
+ "required": true
17
+ },
18
+ "startDate": {
19
+ "required": true,
20
+ "desc": "YYYY-MM-DD (also for monthly and annual datasets: ADS refuses YYYY-MM; the pack pads YYYY-MM to the 1st and YYYY to Jan 1)"
21
+ },
22
+ "endDate": {
23
+ "required": true,
24
+ "desc": "YYYY-MM-DD (the pack pads YYYY-MM to the month's last day and YYYY to Dec 31)"
25
+ },
26
+ "dataTypes": {
27
+ "desc": "comma-separated, case-sensitive: TMAX,TMIN,TAVG,PRCP,SNOW,SNWD,AWND ... (a misspelled type is silently absent)"
28
+ },
29
+ "units": {
30
+ "desc": "standard (F, inches; default here) or metric (C, mm); never omitted: without units GHCN-Daily values come in tenths",
31
+ "enum": [
32
+ "standard",
33
+ "metric"
34
+ ]
35
+ },
36
+ "includeAttributes": {
37
+ "desc": "true adds <TYPE>_ATTRIBUTES flag columns"
38
+ },
39
+ "includeStationName": {
40
+ "desc": "true adds NAME"
41
+ },
42
+ "includeStationLocation": {
43
+ "desc": "1 adds LATITUDE, LONGITUDE, ELEVATION"
44
+ }
45
+ },
46
+ "defaults": {
47
+ "format": "json",
48
+ "units": "standard"
49
+ },
50
+ "records": "",
51
+ "paging": {
52
+ "type": "none"
53
+ },
54
+ "max_rows": 500000,
55
+ "missing": [
56
+ ""
57
+ ],
58
+ "flatten": true
59
+ },
60
+ "station_search": {
61
+ "path": "/access/services/search/v1/data",
62
+ "method": "GET",
63
+ "description": "Keyless NCEI search: stations with data for a dataset in a bounding box and period (one row per station).",
64
+ "params": {
65
+ "dataset": {
66
+ "required": true,
67
+ "catalog": true,
68
+ "desc": "alias or ADS dataset id"
69
+ },
70
+ "bbox": {
71
+ "desc": "north,west,south,east"
72
+ },
73
+ "startDate": {
74
+ "desc": "YYYY-MM-DDT00:00:00"
75
+ },
76
+ "endDate": {
77
+ "desc": "YYYY-MM-DDT23:59:59"
78
+ },
79
+ "dataTypes": {
80
+ "desc": "comma-separated data types the station must have"
81
+ },
82
+ "stations": {
83
+ "desc": "station id(s), comma-separated, e.g. USW00094728: that station's period and data types (the free-text search was removed: `text` answers HTTP 400 \"Invalid search options\", verified 2026-10)"
84
+ }
85
+ },
86
+ "records": "results",
87
+ "total": "count",
88
+ "paging": {
89
+ "type": "offset",
90
+ "limit_param": "limit",
91
+ "offset_param": "offset",
92
+ "size": 100
93
+ },
94
+ "max_rows": 5000,
95
+ "missing": [
96
+ ""
97
+ ],
98
+ "flatten": true
99
+ },
100
+ "cdo_data": {
101
+ "path": "/cdo-web/api/v2/data",
102
+ "method": "GET",
103
+ "description": "Observations in long form (one row per station, date, data type) (CDO v2, needs NOAA_API_KEY)",
104
+ "params": {
105
+ "datasetid": {
106
+ "desc": "GHCND, GSOM, GSOY, NORMAL_DLY, NORMAL_MLY ...",
107
+ "required": true
108
+ },
109
+ "locationid": {
110
+ "desc": "FIPS:36 (state), FIPS:36061 (county), CITY:US360019 ..."
111
+ },
112
+ "stationid": {
113
+ "desc": "GHCND:USW00094728"
114
+ },
115
+ "datatypeid": {
116
+ "desc": "TMAX, PRCP ..."
117
+ },
118
+ "startdate": {
119
+ "desc": "YYYY-MM-DD",
120
+ "required": true
121
+ },
122
+ "enddate": {
123
+ "desc": "YYYY-MM-DD",
124
+ "required": true
125
+ },
126
+ "sortfield": {
127
+ "desc": "id, name, mindate, maxdate, datacoverage"
128
+ },
129
+ "sortorder": {
130
+ "desc": "asc or desc"
131
+ },
132
+ "extent": {
133
+ "desc": "stations only: south,west,north,east bounding box"
134
+ },
135
+ "locationcategoryid": {
136
+ "desc": "locations only: ST, CNTY, CITY, CLIM_REG, CNTRY ..."
137
+ }
138
+ },
139
+ "defaults": {
140
+ "offset": 1,
141
+ "units": "standard"
142
+ },
143
+ "records": "results",
144
+ "total": "metadata.resultset.count",
145
+ "paging": {
146
+ "type": "offset",
147
+ "limit_param": "limit",
148
+ "offset_param": "offset",
149
+ "size": 1000
150
+ },
151
+ "max_rows": 200000,
152
+ "missing": [
153
+ ""
154
+ ],
155
+ "flatten": true
156
+ },
157
+ "cdo_stations": {
158
+ "path": "/cdo-web/api/v2/stations",
159
+ "method": "GET",
160
+ "description": "Stations by dataset, location (FIPS) or extent (CDO v2, needs NOAA_API_KEY)",
161
+ "params": {
162
+ "datasetid": {
163
+ "desc": "GHCND, GSOM, GSOY, NORMAL_DLY, NORMAL_MLY ..."
164
+ },
165
+ "locationid": {
166
+ "desc": "FIPS:36 (state), FIPS:36061 (county), CITY:US360019 ..."
167
+ },
168
+ "stationid": {
169
+ "desc": "GHCND:USW00094728"
170
+ },
171
+ "datatypeid": {
172
+ "desc": "TMAX, PRCP ..."
173
+ },
174
+ "startdate": {
175
+ "desc": "YYYY-MM-DD"
176
+ },
177
+ "enddate": {
178
+ "desc": "YYYY-MM-DD"
179
+ },
180
+ "sortfield": {
181
+ "desc": "id, name, mindate, maxdate, datacoverage"
182
+ },
183
+ "sortorder": {
184
+ "desc": "asc or desc"
185
+ },
186
+ "extent": {
187
+ "desc": "stations only: south,west,north,east bounding box"
188
+ },
189
+ "locationcategoryid": {
190
+ "desc": "locations only: ST, CNTY, CITY, CLIM_REG, CNTRY ..."
191
+ }
192
+ },
193
+ "defaults": {
194
+ "offset": 1
195
+ },
196
+ "records": "results",
197
+ "total": "metadata.resultset.count",
198
+ "paging": {
199
+ "type": "offset",
200
+ "limit_param": "limit",
201
+ "offset_param": "offset",
202
+ "size": 1000
203
+ },
204
+ "max_rows": 20000,
205
+ "missing": [
206
+ ""
207
+ ],
208
+ "flatten": true
209
+ },
210
+ "cdo_locations": {
211
+ "path": "/cdo-web/api/v2/locations",
212
+ "method": "GET",
213
+ "description": "Location ids (states FIPS:nn, counties, cities, climate regions) (CDO v2, needs NOAA_API_KEY)",
214
+ "params": {
215
+ "datasetid": {
216
+ "desc": "GHCND, GSOM, GSOY, NORMAL_DLY, NORMAL_MLY ..."
217
+ },
218
+ "locationid": {
219
+ "desc": "FIPS:36 (state), FIPS:36061 (county), CITY:US360019 ..."
220
+ },
221
+ "stationid": {
222
+ "desc": "GHCND:USW00094728"
223
+ },
224
+ "datatypeid": {
225
+ "desc": "TMAX, PRCP ..."
226
+ },
227
+ "startdate": {
228
+ "desc": "YYYY-MM-DD"
229
+ },
230
+ "enddate": {
231
+ "desc": "YYYY-MM-DD"
232
+ },
233
+ "sortfield": {
234
+ "desc": "id, name, mindate, maxdate, datacoverage"
235
+ },
236
+ "sortorder": {
237
+ "desc": "asc or desc"
238
+ },
239
+ "extent": {
240
+ "desc": "stations only: south,west,north,east bounding box"
241
+ },
242
+ "locationcategoryid": {
243
+ "desc": "locations only: ST, CNTY, CITY, CLIM_REG, CNTRY ..."
244
+ }
245
+ },
246
+ "defaults": {
247
+ "offset": 1
248
+ },
249
+ "records": "results",
250
+ "total": "metadata.resultset.count",
251
+ "paging": {
252
+ "type": "offset",
253
+ "limit_param": "limit",
254
+ "offset_param": "offset",
255
+ "size": 1000
256
+ },
257
+ "max_rows": 50000,
258
+ "missing": [
259
+ ""
260
+ ],
261
+ "flatten": true
262
+ },
263
+ "cdo_datasets": {
264
+ "path": "/cdo-web/api/v2/datasets",
265
+ "method": "GET",
266
+ "description": "Dataset list with date coverage (CDO v2, needs NOAA_API_KEY)",
267
+ "params": {
268
+ "datasetid": {
269
+ "desc": "GHCND, GSOM, GSOY, NORMAL_DLY, NORMAL_MLY ..."
270
+ },
271
+ "locationid": {
272
+ "desc": "FIPS:36 (state), FIPS:36061 (county), CITY:US360019 ..."
273
+ },
274
+ "stationid": {
275
+ "desc": "GHCND:USW00094728"
276
+ },
277
+ "datatypeid": {
278
+ "desc": "TMAX, PRCP ..."
279
+ },
280
+ "startdate": {
281
+ "desc": "YYYY-MM-DD"
282
+ },
283
+ "enddate": {
284
+ "desc": "YYYY-MM-DD"
285
+ },
286
+ "sortfield": {
287
+ "desc": "id, name, mindate, maxdate, datacoverage"
288
+ },
289
+ "sortorder": {
290
+ "desc": "asc or desc"
291
+ },
292
+ "extent": {
293
+ "desc": "stations only: south,west,north,east bounding box"
294
+ },
295
+ "locationcategoryid": {
296
+ "desc": "locations only: ST, CNTY, CITY, CLIM_REG, CNTRY ..."
297
+ }
298
+ },
299
+ "defaults": {
300
+ "offset": 1
301
+ },
302
+ "records": "results",
303
+ "total": "metadata.resultset.count",
304
+ "paging": {
305
+ "type": "offset",
306
+ "limit_param": "limit",
307
+ "offset_param": "offset",
308
+ "size": 1000
309
+ },
310
+ "max_rows": 1000,
311
+ "missing": [
312
+ ""
313
+ ],
314
+ "flatten": true
315
+ },
316
+ "cdo_datatypes": {
317
+ "path": "/cdo-web/api/v2/datatypes",
318
+ "method": "GET",
319
+ "description": "Data types available for a dataset, station or location (CDO v2, needs NOAA_API_KEY)",
320
+ "params": {
321
+ "datasetid": {
322
+ "desc": "GHCND, GSOM, GSOY, NORMAL_DLY, NORMAL_MLY ..."
323
+ },
324
+ "locationid": {
325
+ "desc": "FIPS:36 (state), FIPS:36061 (county), CITY:US360019 ..."
326
+ },
327
+ "stationid": {
328
+ "desc": "GHCND:USW00094728"
329
+ },
330
+ "datatypeid": {
331
+ "desc": "TMAX, PRCP ..."
332
+ },
333
+ "startdate": {
334
+ "desc": "YYYY-MM-DD"
335
+ },
336
+ "enddate": {
337
+ "desc": "YYYY-MM-DD"
338
+ },
339
+ "sortfield": {
340
+ "desc": "id, name, mindate, maxdate, datacoverage"
341
+ },
342
+ "sortorder": {
343
+ "desc": "asc or desc"
344
+ },
345
+ "extent": {
346
+ "desc": "stations only: south,west,north,east bounding box"
347
+ },
348
+ "locationcategoryid": {
349
+ "desc": "locations only: ST, CNTY, CITY, CLIM_REG, CNTRY ..."
350
+ }
351
+ },
352
+ "defaults": {
353
+ "offset": 1
354
+ },
355
+ "records": "results",
356
+ "total": "metadata.resultset.count",
357
+ "paging": {
358
+ "type": "offset",
359
+ "limit_param": "limit",
360
+ "offset_param": "offset",
361
+ "size": 1000
362
+ },
363
+ "max_rows": 5000,
364
+ "missing": [
365
+ ""
366
+ ],
367
+ "flatten": true
368
+ }
369
+ },
370
+ "catalog": {
371
+ "daily": {
372
+ "id": "daily-summaries",
373
+ "name": "GHCN-Daily (CDO GHCND)",
374
+ "description": "daily max/min temperature, precipitation, snowfall, snow depth, wind by station",
375
+ "endpoint": "data"
376
+ },
377
+ "monthly": {
378
+ "id": "global-summary-of-the-month",
379
+ "name": "Global Summary of the Month (CDO GSOM)",
380
+ "description": "monthly mean/max/min temperature, total precipitation and snow, degree days",
381
+ "endpoint": "data"
382
+ },
383
+ "annual": {
384
+ "id": "global-summary-of-the-year",
385
+ "name": "Global Summary of the Year (CDO GSOY)",
386
+ "description": "annual temperature and precipitation summaries",
387
+ "endpoint": "data"
388
+ },
389
+ "normals_monthly": {
390
+ "id": "normals-monthly-1991-2020",
391
+ "name": "U.S. Climate Normals 1991-2020, monthly",
392
+ "description": "30-year monthly normals (MLY-TAVG-NORMAL, MLY-PRCP-NORMAL ...)",
393
+ "endpoint": "data"
394
+ },
395
+ "normals_daily": {
396
+ "id": "normals-daily-1991-2020",
397
+ "name": "U.S. Climate Normals 1991-2020, daily",
398
+ "description": "30-year daily normals (DLY-TMAX-NORMAL ...)",
399
+ "endpoint": "data"
400
+ },
401
+ "normals_annual": {
402
+ "id": "normals-annualseasonal-1991-2020",
403
+ "name": "U.S. Climate Normals 1991-2020, annual/seasonal",
404
+ "description": "annual and seasonal normals (ANN-TAVG-NORMAL ...)",
405
+ "endpoint": "data"
406
+ },
407
+ "hourly": {
408
+ "id": "global-hourly",
409
+ "name": "Global Hourly (ISD)",
410
+ "description": "hourly surface observations (large; short periods only)",
411
+ "endpoint": "data"
412
+ },
413
+ "GHCND": {
414
+ "id": "daily-summaries",
415
+ "name": "GHCND (CDO name)",
416
+ "description": "same as daily-summaries",
417
+ "endpoint": "data"
418
+ },
419
+ "GSOM": {
420
+ "id": "global-summary-of-the-month",
421
+ "name": "GSOM (CDO name)",
422
+ "description": "same as global-summary-of-the-month",
423
+ "endpoint": "data"
424
+ },
425
+ "GSOY": {
426
+ "id": "global-summary-of-the-year",
427
+ "name": "GSOY (CDO name)",
428
+ "description": "same as global-summary-of-the-year",
429
+ "endpoint": "data"
430
+ }
431
+ }
432
432
  }