data-analyst-mcp 0.3.0 → 0.3.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (153) hide show
  1. package/README.md +262 -262
  2. package/dist/report/method_audit.js +7 -1
  3. package/dist/report/method_audit.js.map +1 -1
  4. package/dist/report/scan_secrets.d.ts +4 -1
  5. package/dist/report/scan_secrets.js +36 -5
  6. package/dist/report/scan_secrets.js.map +1 -1
  7. package/dist/server.d.ts +1 -1
  8. package/dist/server.js +3 -2
  9. package/dist/server.js.map +1 -1
  10. package/guide/WORKFLOW.md +134 -134
  11. package/guide/assets/disclaimer.txt +1 -1
  12. package/guide/assets/download_data.ps1 +162 -162
  13. package/guide/assets/report_template.html +597 -597
  14. package/guide/references/routing.md +171 -171
  15. package/guide/references/style_guide.md +398 -398
  16. package/package.json +56 -56
  17. package/packs/acf/endpoints.json +114 -114
  18. package/packs/acf/policy.json +104 -104
  19. package/packs/actuaries/endpoints.json +82 -82
  20. package/packs/actuaries/policy.json +109 -109
  21. package/packs/bea/assets/download_bea.ps1 +182 -182
  22. package/packs/bea/docs/bea_api.md +461 -461
  23. package/packs/bea/docs/datasets.md +157 -157
  24. package/packs/bea/docs/report_patterns.md +112 -112
  25. package/packs/bea/policy.json +170 -170
  26. package/packs/bea/source.md +152 -152
  27. package/packs/bls/assets/download_bls.ps1 +152 -152
  28. package/packs/bls/docs/analysis_patterns.md +108 -108
  29. package/packs/bls/docs/bls_api.md +73 -73
  30. package/packs/bls/docs/series_ids.md +149 -149
  31. package/packs/bls/policy.json +238 -238
  32. package/packs/bts/endpoints.json +346 -346
  33. package/packs/bts/policy.json +94 -94
  34. package/packs/cdc/endpoints.json +197 -197
  35. package/packs/cdc/policy.json +83 -83
  36. package/packs/census/endpoints.json +99 -99
  37. package/packs/cfpb/endpoints.json +326 -326
  38. package/packs/cfpb/policy.json +119 -119
  39. package/packs/clinical-trials/endpoints.json +166 -166
  40. package/packs/clinical-trials/policy.json +84 -84
  41. package/packs/cms/endpoints.json +69 -69
  42. package/packs/cms/policy.json +96 -96
  43. package/packs/college-scorecard/endpoints.json +252 -252
  44. package/packs/college-scorecard/policy.json +106 -106
  45. package/packs/congress/endpoints.json +1701 -1701
  46. package/packs/congress/policy.json +117 -117
  47. package/packs/dhs-ohss/endpoints.json +66 -66
  48. package/packs/dhs-ohss/policy.json +107 -107
  49. package/packs/doj-news/endpoints.json +59 -59
  50. package/packs/doj-news/policy.json +96 -96
  51. package/packs/dol/endpoints.json +817 -817
  52. package/packs/dol/policy.json +135 -135
  53. package/packs/eia/endpoints.json +717 -717
  54. package/packs/eia/policy.json +112 -112
  55. package/packs/epa/endpoints.json +291 -291
  56. package/packs/epa/policy.json +99 -99
  57. package/packs/epa-aqs/endpoints.json +173 -173
  58. package/packs/epa-aqs/policy.json +96 -96
  59. package/packs/fbi/endpoints.json +1841 -1841
  60. package/packs/fbi/policy.json +118 -118
  61. package/packs/fda/endpoints.json +237 -237
  62. package/packs/fda/policy.json +121 -121
  63. package/packs/fdic/endpoints.json +416 -416
  64. package/packs/fdic/policy.json +83 -83
  65. package/packs/fec/endpoints.json +707 -707
  66. package/packs/fec/policy.json +93 -93
  67. package/packs/fed-board/endpoints.json +89 -89
  68. package/packs/fed-board/policy.json +136 -136
  69. package/packs/federal-register/endpoints.json +143 -143
  70. package/packs/federal-register/policy.json +86 -86
  71. package/packs/fema/endpoints.json +645 -645
  72. package/packs/fema/policy.json +103 -103
  73. package/packs/fhfa/endpoints.json +105 -105
  74. package/packs/fhfa/policy.json +109 -109
  75. package/packs/fred/assets/download_fred.ps1 +122 -122
  76. package/packs/fred/docs/analysis_patterns.md +124 -124
  77. package/packs/fred/docs/fred_api.md +94 -94
  78. package/packs/fred/docs/series.md +188 -188
  79. package/packs/fred/policy.json +253 -253
  80. package/packs/fsa/endpoints.json +150 -150
  81. package/packs/fsa/policy.json +99 -99
  82. package/packs/govinfo/endpoints.json +519 -519
  83. package/packs/gsa-calc/endpoints.json +93 -93
  84. package/packs/gsa-calc/policy.json +97 -97
  85. package/packs/hud/endpoints.json +146 -146
  86. package/packs/hud/policy.json +84 -84
  87. package/packs/ipums/docs/report_patterns.md +117 -117
  88. package/packs/irs-soi/endpoints.json +114 -114
  89. package/packs/irs-soi/policy.json +107 -107
  90. package/packs/medicaid/endpoints.json +412 -412
  91. package/packs/medicaid/policy.json +108 -108
  92. package/packs/naep/endpoints.json +217 -217
  93. package/packs/naep/policy.json +100 -100
  94. package/packs/nhtsa/endpoints.json +132 -132
  95. package/packs/nhtsa/policy.json +93 -93
  96. package/packs/nih/endpoints.json +452 -452
  97. package/packs/nih/policy.json +86 -86
  98. package/packs/noaa/endpoints.json +431 -431
  99. package/packs/noaa/policy.json +95 -95
  100. package/packs/nrel/endpoints.json +327 -327
  101. package/packs/nrel/policy.json +96 -96
  102. package/packs/nws/endpoints.json +271 -271
  103. package/packs/nws/policy.json +82 -82
  104. package/packs/nyfed/endpoints.json +80 -80
  105. package/packs/nyfed/policy.json +92 -92
  106. package/packs/omb/endpoints.json +460 -460
  107. package/packs/omb/policy.json +106 -106
  108. package/packs/open-payments/endpoints.json +297 -297
  109. package/packs/open-payments/policy.json +101 -101
  110. package/packs/opm/assets/download_opm.ps1 +125 -125
  111. package/packs/opm/docs/fields.md +184 -184
  112. package/packs/opm/docs/opm_api.md +71 -71
  113. package/packs/opm/docs/report_patterns.md +83 -83
  114. package/packs/opm/lib/data_dictionary.csv +73 -73
  115. package/packs/pbgc/endpoints.json +483 -483
  116. package/packs/pbgc/policy.json +94 -94
  117. package/packs/philfed/endpoints.json +85 -85
  118. package/packs/philfed/policy.json +94 -94
  119. package/packs/regulations/endpoints.json +287 -287
  120. package/packs/regulations/policy.json +86 -86
  121. package/packs/sec/endpoints.json +236 -236
  122. package/packs/sec/policy.json +86 -86
  123. package/packs/senate-lobbying/endpoints.json +553 -553
  124. package/packs/senate-lobbying/policy.json +99 -99
  125. package/packs/snapqc/endpoints.json +1426 -1426
  126. package/packs/snapqc/policy.json +92 -92
  127. package/packs/treasury/catalog.json +2267 -2267
  128. package/packs/treasury/docs/api_guide.md +245 -245
  129. package/packs/treasury/docs/datasets.md +56 -56
  130. package/packs/treasury/docs/report_patterns.md +126 -126
  131. package/packs/treasury/policy.json +159 -159
  132. package/packs/treasury/source.md +170 -165
  133. package/packs/treasury-yields/endpoints.json +226 -226
  134. package/packs/treasury-yields/policy.json +86 -86
  135. package/packs/usaspending/endpoints.json +1315 -1315
  136. package/packs/usaspending/policy.json +109 -109
  137. package/packs/usda-fna/policy.json +133 -133
  138. package/packs/usda-fooddata/endpoints.json +180 -180
  139. package/packs/usda-fooddata/policy.json +94 -94
  140. package/packs/usda-nass/endpoints.json +323 -323
  141. package/packs/usda-nass/policy.json +95 -95
  142. package/packs/usda-outlook/endpoints.json +86 -86
  143. package/packs/usda-outlook/policy.json +109 -109
  144. package/packs/usgs/endpoints.json +313 -313
  145. package/packs/usgs/policy.json +95 -95
  146. package/packs/usitc/endpoints.json +74 -74
  147. package/packs/usitc/policy.json +111 -111
  148. package/packs/uspto/endpoints.json +141 -141
  149. package/packs/uspto/policy.json +95 -95
  150. package/packs/va/endpoints.json +414 -414
  151. package/packs/va/policy.json +101 -101
  152. package/packs/world-bank/endpoints.json +122 -122
  153. package/packs/world-bank/policy.json +101 -101
@@ -1,324 +1,324 @@
1
- {
2
- "base_url": "https://quickstats.nass.usda.gov",
3
- "endpoints": {
4
- "query": {
5
- "path": "/api/api_GET/",
6
- "method": "GET",
7
- "description": "Quick Stats records matching the filters (at most 50,000 per request): one row per published value with Value, CV (%), unit_desc, year, reference period and geography.",
8
- "params": {
9
- "source_desc": {
10
- "desc": "program: SURVEY or CENSUS (Census of Agriculture, every 5 years: 2017, 2022)"
11
- },
12
- "sector_desc": {
13
- "desc": "CROPS, ANIMALS & PRODUCTS, ECONOMICS, DEMOGRAPHICS, ENVIRONMENTAL"
14
- },
15
- "group_desc": {
16
- "desc": "e.g. FIELD CROPS, VEGETABLES, LIVESTOCK, DAIRY, POULTRY, FARMS & LAND & ASSETS, INCOME, PRICES PAID"
17
- },
18
- "commodity_desc": {
19
- "desc": "e.g. CORN, SOYBEANS, WHEAT, COTTON, CATTLE, HOGS, MILK, EGGS"
20
- },
21
- "class_desc": {
22
- "desc": "e.g. ALL CLASSES, WINTER, SPRING, DURUM (wheat)"
23
- },
24
- "prodn_practice_desc": {
25
- "desc": "e.g. ALL PRODUCTION PRACTICES, IRRIGATED"
26
- },
27
- "util_practice_desc": {
28
- "desc": "e.g. ALL UTILIZATION PRACTICES, GRAIN, SILAGE"
29
- },
30
- "statisticcat_desc": {
31
- "desc": "e.g. AREA PLANTED, AREA HARVESTED, PRODUCTION, YIELD, PRICE RECEIVED, INVENTORY, SALES"
32
- },
33
- "unit_desc": {
34
- "desc": "e.g. ACRES, BU, BU / ACRE, $ / BU, HEAD, $, LB"
35
- },
36
- "short_desc": {
37
- "desc": "the full data item, e.g. 'CORN, GRAIN - PRODUCTION, MEASURED IN BU' (most precise filter); or a catalog alias (corn_production, ...)",
38
- "catalog": true
39
- },
40
- "domain_desc": {
41
- "desc": "TOTAL (default breakdown) or a domain such as ORGANIC STATUS, AREA OPERATED"
42
- },
43
- "domaincat_desc": {
44
- "desc": "category within the domain"
45
- },
46
- "agg_level_desc": {
47
- "desc": "NATIONAL, STATE, COUNTY, AGRICULTURAL DISTRICT, REGION : MULTI-STATE, ZIP CODE, WATERSHED"
48
- },
49
- "state_alpha": {
50
- "desc": "two-letter state code (US for national rows)"
51
- },
52
- "state_name": {
53
- "desc": "upper-case state name, e.g. IOWA"
54
- },
55
- "state_fips_code": {
56
- "desc": "2-digit state FIPS"
57
- },
58
- "county_name": {
59
- "desc": "upper-case county name"
60
- },
61
- "county_code": {
62
- "desc": "3-digit county FIPS"
63
- },
64
- "year": {
65
- "desc": "year, e.g. 2024"
66
- },
67
- "year__GE": {
68
- "desc": "year >= value"
69
- },
70
- "year__LE": {
71
- "desc": "year <= value"
72
- },
73
- "freq_desc": {
74
- "desc": "ANNUAL, MONTHLY, WEEKLY, POINT IN TIME"
75
- },
76
- "reference_period_desc": {
77
- "desc": "YEAR, MARKETING YEAR, JAN ... DEC, WEEK #nn, FIRST OF MAR, ..."
78
- },
79
- "format": {
80
- "desc": "JSON (set by the pack)"
81
- }
82
- },
83
- "defaults": {
84
- "format": "JSON"
85
- },
86
- "records": "data",
87
- "paging": {
88
- "type": "none"
89
- },
90
- "max_rows": 50000,
91
- "missing": [
92
- ""
93
- ]
94
- },
95
- "count": {
96
- "path": "/api/get_counts/",
97
- "method": "GET",
98
- "description": "Number of records a query would return (check before a large query; over 50,000 is refused).",
99
- "params": {
100
- "source_desc": {
101
- "desc": "program: SURVEY or CENSUS (Census of Agriculture, every 5 years: 2017, 2022)"
102
- },
103
- "sector_desc": {
104
- "desc": "CROPS, ANIMALS & PRODUCTS, ECONOMICS, DEMOGRAPHICS, ENVIRONMENTAL"
105
- },
106
- "group_desc": {
107
- "desc": "e.g. FIELD CROPS, VEGETABLES, LIVESTOCK, DAIRY, POULTRY, FARMS & LAND & ASSETS, INCOME, PRICES PAID"
108
- },
109
- "commodity_desc": {
110
- "desc": "e.g. CORN, SOYBEANS, WHEAT, COTTON, CATTLE, HOGS, MILK, EGGS"
111
- },
112
- "class_desc": {
113
- "desc": "e.g. ALL CLASSES, WINTER, SPRING, DURUM (wheat)"
114
- },
115
- "prodn_practice_desc": {
116
- "desc": "e.g. ALL PRODUCTION PRACTICES, IRRIGATED"
117
- },
118
- "util_practice_desc": {
119
- "desc": "e.g. ALL UTILIZATION PRACTICES, GRAIN, SILAGE"
120
- },
121
- "statisticcat_desc": {
122
- "desc": "e.g. AREA PLANTED, AREA HARVESTED, PRODUCTION, YIELD, PRICE RECEIVED, INVENTORY, SALES"
123
- },
124
- "unit_desc": {
125
- "desc": "e.g. ACRES, BU, BU / ACRE, $ / BU, HEAD, $, LB"
126
- },
127
- "short_desc": {
128
- "desc": "the full data item, e.g. 'CORN, GRAIN - PRODUCTION, MEASURED IN BU' (most precise filter); or a catalog alias (corn_production, ...)",
129
- "catalog": true
130
- },
131
- "domain_desc": {
132
- "desc": "TOTAL (default breakdown) or a domain such as ORGANIC STATUS, AREA OPERATED"
133
- },
134
- "domaincat_desc": {
135
- "desc": "category within the domain"
136
- },
137
- "agg_level_desc": {
138
- "desc": "NATIONAL, STATE, COUNTY, AGRICULTURAL DISTRICT, REGION : MULTI-STATE, ZIP CODE, WATERSHED"
139
- },
140
- "state_alpha": {
141
- "desc": "two-letter state code (US for national rows)"
142
- },
143
- "state_name": {
144
- "desc": "upper-case state name, e.g. IOWA"
145
- },
146
- "state_fips_code": {
147
- "desc": "2-digit state FIPS"
148
- },
149
- "county_name": {
150
- "desc": "upper-case county name"
151
- },
152
- "county_code": {
153
- "desc": "3-digit county FIPS"
154
- },
155
- "year": {
156
- "desc": "year, e.g. 2024"
157
- },
158
- "year__GE": {
159
- "desc": "year >= value"
160
- },
161
- "year__LE": {
162
- "desc": "year <= value"
163
- },
164
- "freq_desc": {
165
- "desc": "ANNUAL, MONTHLY, WEEKLY, POINT IN TIME"
166
- },
167
- "reference_period_desc": {
168
- "desc": "YEAR, MARKETING YEAR, JAN ... DEC, WEEK #nn, FIRST OF MAR, ..."
169
- }
170
- },
171
- "records": "",
172
- "paging": {
173
- "type": "none"
174
- }
175
- },
176
- "param_values": {
177
- "path": "/api/get_param_values/",
178
- "method": "GET",
179
- "description": "Every value one parameter takes (optionally within other filters): one row per value.",
180
- "params": {
181
- "param": {
182
- "required": true,
183
- "desc": "parameter name, e.g. commodity_desc, statisticcat_desc, short_desc"
184
- },
185
- "source_desc": {
186
- "desc": "program: SURVEY or CENSUS (Census of Agriculture, every 5 years: 2017, 2022)"
187
- },
188
- "sector_desc": {
189
- "desc": "CROPS, ANIMALS & PRODUCTS, ECONOMICS, DEMOGRAPHICS, ENVIRONMENTAL"
190
- },
191
- "group_desc": {
192
- "desc": "e.g. FIELD CROPS, VEGETABLES, LIVESTOCK, DAIRY, POULTRY, FARMS & LAND & ASSETS, INCOME, PRICES PAID"
193
- },
194
- "commodity_desc": {
195
- "desc": "e.g. CORN, SOYBEANS, WHEAT, COTTON, CATTLE, HOGS, MILK, EGGS"
196
- },
197
- "class_desc": {
198
- "desc": "e.g. ALL CLASSES, WINTER, SPRING, DURUM (wheat)"
199
- },
200
- "prodn_practice_desc": {
201
- "desc": "e.g. ALL PRODUCTION PRACTICES, IRRIGATED"
202
- },
203
- "util_practice_desc": {
204
- "desc": "e.g. ALL UTILIZATION PRACTICES, GRAIN, SILAGE"
205
- },
206
- "statisticcat_desc": {
207
- "desc": "e.g. AREA PLANTED, AREA HARVESTED, PRODUCTION, YIELD, PRICE RECEIVED, INVENTORY, SALES"
208
- },
209
- "unit_desc": {
210
- "desc": "e.g. ACRES, BU, BU / ACRE, $ / BU, HEAD, $, LB"
211
- },
212
- "short_desc": {
213
- "desc": "the full data item, e.g. 'CORN, GRAIN - PRODUCTION, MEASURED IN BU' (most precise filter)"
214
- },
215
- "domain_desc": {
216
- "desc": "TOTAL (default breakdown) or a domain such as ORGANIC STATUS, AREA OPERATED"
217
- },
218
- "domaincat_desc": {
219
- "desc": "category within the domain"
220
- },
221
- "agg_level_desc": {
222
- "desc": "NATIONAL, STATE, COUNTY, AGRICULTURAL DISTRICT, REGION : MULTI-STATE, ZIP CODE, WATERSHED"
223
- },
224
- "state_alpha": {
225
- "desc": "two-letter state code (US for national rows)"
226
- },
227
- "state_name": {
228
- "desc": "upper-case state name, e.g. IOWA"
229
- },
230
- "state_fips_code": {
231
- "desc": "2-digit state FIPS"
232
- },
233
- "county_name": {
234
- "desc": "upper-case county name"
235
- },
236
- "county_code": {
237
- "desc": "3-digit county FIPS"
238
- },
239
- "year": {
240
- "desc": "year, e.g. 2024"
241
- },
242
- "year__GE": {
243
- "desc": "year >= value"
244
- },
245
- "year__LE": {
246
- "desc": "year <= value"
247
- },
248
- "freq_desc": {
249
- "desc": "ANNUAL, MONTHLY, WEEKLY, POINT IN TIME"
250
- },
251
- "reference_period_desc": {
252
- "desc": "YEAR, MARKETING YEAR, JAN ... DEC, WEEK #nn, FIRST OF MAR, ..."
253
- }
254
- },
255
- "records": "",
256
- "paging": {
257
- "type": "none"
258
- },
259
- "flatten": false
260
- }
261
- },
262
- "catalog": {
263
- "corn_production": {
264
- "id": "CORN, GRAIN - PRODUCTION, MEASURED IN BU",
265
- "name": "Corn for grain production (bushels)",
266
- "description": "short_desc; annual, national/state/county, SURVEY (name from NASS Quick Stats usage; not verified live: no key)",
267
- "endpoint": "query"
268
- },
269
- "corn_yield": {
270
- "id": "CORN, GRAIN - YIELD, MEASURED IN BU / ACRE",
271
- "name": "Corn for grain yield (bushels per acre)",
272
- "description": "short_desc (name from NASS Quick Stats usage; not verified live: no key)",
273
- "endpoint": "query"
274
- },
275
- "corn_planted": {
276
- "id": "CORN - ACRES PLANTED",
277
- "name": "Corn acres planted",
278
- "description": "short_desc (all utilizations) (name from NASS Quick Stats usage; not verified live: no key)",
279
- "endpoint": "query"
280
- },
281
- "corn_price": {
282
- "id": "CORN, GRAIN - PRICE RECEIVED, MEASURED IN $ / BU",
283
- "name": "Corn price received by farmers",
284
- "description": "short_desc; monthly and marketing-year (name from NASS Quick Stats usage; not verified live: no key)",
285
- "endpoint": "query"
286
- },
287
- "soybean_production": {
288
- "id": "SOYBEANS - PRODUCTION, MEASURED IN BU",
289
- "name": "Soybean production (bushels)",
290
- "description": "short_desc (name from NASS Quick Stats usage; not verified live: no key)",
291
- "endpoint": "query"
292
- },
293
- "soybean_yield": {
294
- "id": "SOYBEANS - YIELD, MEASURED IN BU / ACRE",
295
- "name": "Soybean yield",
296
- "description": "short_desc (name from NASS Quick Stats usage; not verified live: no key)",
297
- "endpoint": "query"
298
- },
299
- "wheat_production": {
300
- "id": "WHEAT - PRODUCTION, MEASURED IN BU",
301
- "name": "All wheat production (bushels)",
302
- "description": "short_desc (name from NASS Quick Stats usage; not verified live: no key)",
303
- "endpoint": "query"
304
- },
305
- "cattle_inventory": {
306
- "id": "CATTLE, INCL CALVES - INVENTORY",
307
- "name": "Cattle and calves inventory (head)",
308
- "description": "short_desc; January 1 and July 1 (name from NASS Quick Stats usage; not verified live: no key)",
309
- "endpoint": "query"
310
- },
311
- "hogs_inventory": {
312
- "id": "HOGS - INVENTORY",
313
- "name": "Hogs and pigs inventory (head)",
314
- "description": "short_desc; quarterly (name from NASS Quick Stats usage; not verified live: no key)",
315
- "endpoint": "query"
316
- },
317
- "milk_production": {
318
- "id": "MILK - PRODUCTION, MEASURED IN LB",
319
- "name": "Milk production (pounds)",
320
- "description": "short_desc; monthly and annual (name from NASS Quick Stats usage; not verified live: no key)",
321
- "endpoint": "query"
322
- }
323
- }
1
+ {
2
+ "base_url": "https://quickstats.nass.usda.gov",
3
+ "endpoints": {
4
+ "query": {
5
+ "path": "/api/api_GET/",
6
+ "method": "GET",
7
+ "description": "Quick Stats records matching the filters (at most 50,000 per request): one row per published value with Value, CV (%), unit_desc, year, reference period and geography.",
8
+ "params": {
9
+ "source_desc": {
10
+ "desc": "program: SURVEY or CENSUS (Census of Agriculture, every 5 years: 2017, 2022)"
11
+ },
12
+ "sector_desc": {
13
+ "desc": "CROPS, ANIMALS & PRODUCTS, ECONOMICS, DEMOGRAPHICS, ENVIRONMENTAL"
14
+ },
15
+ "group_desc": {
16
+ "desc": "e.g. FIELD CROPS, VEGETABLES, LIVESTOCK, DAIRY, POULTRY, FARMS & LAND & ASSETS, INCOME, PRICES PAID"
17
+ },
18
+ "commodity_desc": {
19
+ "desc": "e.g. CORN, SOYBEANS, WHEAT, COTTON, CATTLE, HOGS, MILK, EGGS"
20
+ },
21
+ "class_desc": {
22
+ "desc": "e.g. ALL CLASSES, WINTER, SPRING, DURUM (wheat)"
23
+ },
24
+ "prodn_practice_desc": {
25
+ "desc": "e.g. ALL PRODUCTION PRACTICES, IRRIGATED"
26
+ },
27
+ "util_practice_desc": {
28
+ "desc": "e.g. ALL UTILIZATION PRACTICES, GRAIN, SILAGE"
29
+ },
30
+ "statisticcat_desc": {
31
+ "desc": "e.g. AREA PLANTED, AREA HARVESTED, PRODUCTION, YIELD, PRICE RECEIVED, INVENTORY, SALES"
32
+ },
33
+ "unit_desc": {
34
+ "desc": "e.g. ACRES, BU, BU / ACRE, $ / BU, HEAD, $, LB"
35
+ },
36
+ "short_desc": {
37
+ "desc": "the full data item, e.g. 'CORN, GRAIN - PRODUCTION, MEASURED IN BU' (most precise filter); or a catalog alias (corn_production, ...)",
38
+ "catalog": true
39
+ },
40
+ "domain_desc": {
41
+ "desc": "TOTAL (default breakdown) or a domain such as ORGANIC STATUS, AREA OPERATED"
42
+ },
43
+ "domaincat_desc": {
44
+ "desc": "category within the domain"
45
+ },
46
+ "agg_level_desc": {
47
+ "desc": "NATIONAL, STATE, COUNTY, AGRICULTURAL DISTRICT, REGION : MULTI-STATE, ZIP CODE, WATERSHED"
48
+ },
49
+ "state_alpha": {
50
+ "desc": "two-letter state code (US for national rows)"
51
+ },
52
+ "state_name": {
53
+ "desc": "upper-case state name, e.g. IOWA"
54
+ },
55
+ "state_fips_code": {
56
+ "desc": "2-digit state FIPS"
57
+ },
58
+ "county_name": {
59
+ "desc": "upper-case county name"
60
+ },
61
+ "county_code": {
62
+ "desc": "3-digit county FIPS"
63
+ },
64
+ "year": {
65
+ "desc": "year, e.g. 2024"
66
+ },
67
+ "year__GE": {
68
+ "desc": "year >= value"
69
+ },
70
+ "year__LE": {
71
+ "desc": "year <= value"
72
+ },
73
+ "freq_desc": {
74
+ "desc": "ANNUAL, MONTHLY, WEEKLY, POINT IN TIME"
75
+ },
76
+ "reference_period_desc": {
77
+ "desc": "YEAR, MARKETING YEAR, JAN ... DEC, WEEK #nn, FIRST OF MAR, ..."
78
+ },
79
+ "format": {
80
+ "desc": "JSON (set by the pack)"
81
+ }
82
+ },
83
+ "defaults": {
84
+ "format": "JSON"
85
+ },
86
+ "records": "data",
87
+ "paging": {
88
+ "type": "none"
89
+ },
90
+ "max_rows": 50000,
91
+ "missing": [
92
+ ""
93
+ ]
94
+ },
95
+ "count": {
96
+ "path": "/api/get_counts/",
97
+ "method": "GET",
98
+ "description": "Number of records a query would return (check before a large query; over 50,000 is refused).",
99
+ "params": {
100
+ "source_desc": {
101
+ "desc": "program: SURVEY or CENSUS (Census of Agriculture, every 5 years: 2017, 2022)"
102
+ },
103
+ "sector_desc": {
104
+ "desc": "CROPS, ANIMALS & PRODUCTS, ECONOMICS, DEMOGRAPHICS, ENVIRONMENTAL"
105
+ },
106
+ "group_desc": {
107
+ "desc": "e.g. FIELD CROPS, VEGETABLES, LIVESTOCK, DAIRY, POULTRY, FARMS & LAND & ASSETS, INCOME, PRICES PAID"
108
+ },
109
+ "commodity_desc": {
110
+ "desc": "e.g. CORN, SOYBEANS, WHEAT, COTTON, CATTLE, HOGS, MILK, EGGS"
111
+ },
112
+ "class_desc": {
113
+ "desc": "e.g. ALL CLASSES, WINTER, SPRING, DURUM (wheat)"
114
+ },
115
+ "prodn_practice_desc": {
116
+ "desc": "e.g. ALL PRODUCTION PRACTICES, IRRIGATED"
117
+ },
118
+ "util_practice_desc": {
119
+ "desc": "e.g. ALL UTILIZATION PRACTICES, GRAIN, SILAGE"
120
+ },
121
+ "statisticcat_desc": {
122
+ "desc": "e.g. AREA PLANTED, AREA HARVESTED, PRODUCTION, YIELD, PRICE RECEIVED, INVENTORY, SALES"
123
+ },
124
+ "unit_desc": {
125
+ "desc": "e.g. ACRES, BU, BU / ACRE, $ / BU, HEAD, $, LB"
126
+ },
127
+ "short_desc": {
128
+ "desc": "the full data item, e.g. 'CORN, GRAIN - PRODUCTION, MEASURED IN BU' (most precise filter); or a catalog alias (corn_production, ...)",
129
+ "catalog": true
130
+ },
131
+ "domain_desc": {
132
+ "desc": "TOTAL (default breakdown) or a domain such as ORGANIC STATUS, AREA OPERATED"
133
+ },
134
+ "domaincat_desc": {
135
+ "desc": "category within the domain"
136
+ },
137
+ "agg_level_desc": {
138
+ "desc": "NATIONAL, STATE, COUNTY, AGRICULTURAL DISTRICT, REGION : MULTI-STATE, ZIP CODE, WATERSHED"
139
+ },
140
+ "state_alpha": {
141
+ "desc": "two-letter state code (US for national rows)"
142
+ },
143
+ "state_name": {
144
+ "desc": "upper-case state name, e.g. IOWA"
145
+ },
146
+ "state_fips_code": {
147
+ "desc": "2-digit state FIPS"
148
+ },
149
+ "county_name": {
150
+ "desc": "upper-case county name"
151
+ },
152
+ "county_code": {
153
+ "desc": "3-digit county FIPS"
154
+ },
155
+ "year": {
156
+ "desc": "year, e.g. 2024"
157
+ },
158
+ "year__GE": {
159
+ "desc": "year >= value"
160
+ },
161
+ "year__LE": {
162
+ "desc": "year <= value"
163
+ },
164
+ "freq_desc": {
165
+ "desc": "ANNUAL, MONTHLY, WEEKLY, POINT IN TIME"
166
+ },
167
+ "reference_period_desc": {
168
+ "desc": "YEAR, MARKETING YEAR, JAN ... DEC, WEEK #nn, FIRST OF MAR, ..."
169
+ }
170
+ },
171
+ "records": "",
172
+ "paging": {
173
+ "type": "none"
174
+ }
175
+ },
176
+ "param_values": {
177
+ "path": "/api/get_param_values/",
178
+ "method": "GET",
179
+ "description": "Every value one parameter takes (optionally within other filters): one row per value.",
180
+ "params": {
181
+ "param": {
182
+ "required": true,
183
+ "desc": "parameter name, e.g. commodity_desc, statisticcat_desc, short_desc"
184
+ },
185
+ "source_desc": {
186
+ "desc": "program: SURVEY or CENSUS (Census of Agriculture, every 5 years: 2017, 2022)"
187
+ },
188
+ "sector_desc": {
189
+ "desc": "CROPS, ANIMALS & PRODUCTS, ECONOMICS, DEMOGRAPHICS, ENVIRONMENTAL"
190
+ },
191
+ "group_desc": {
192
+ "desc": "e.g. FIELD CROPS, VEGETABLES, LIVESTOCK, DAIRY, POULTRY, FARMS & LAND & ASSETS, INCOME, PRICES PAID"
193
+ },
194
+ "commodity_desc": {
195
+ "desc": "e.g. CORN, SOYBEANS, WHEAT, COTTON, CATTLE, HOGS, MILK, EGGS"
196
+ },
197
+ "class_desc": {
198
+ "desc": "e.g. ALL CLASSES, WINTER, SPRING, DURUM (wheat)"
199
+ },
200
+ "prodn_practice_desc": {
201
+ "desc": "e.g. ALL PRODUCTION PRACTICES, IRRIGATED"
202
+ },
203
+ "util_practice_desc": {
204
+ "desc": "e.g. ALL UTILIZATION PRACTICES, GRAIN, SILAGE"
205
+ },
206
+ "statisticcat_desc": {
207
+ "desc": "e.g. AREA PLANTED, AREA HARVESTED, PRODUCTION, YIELD, PRICE RECEIVED, INVENTORY, SALES"
208
+ },
209
+ "unit_desc": {
210
+ "desc": "e.g. ACRES, BU, BU / ACRE, $ / BU, HEAD, $, LB"
211
+ },
212
+ "short_desc": {
213
+ "desc": "the full data item, e.g. 'CORN, GRAIN - PRODUCTION, MEASURED IN BU' (most precise filter)"
214
+ },
215
+ "domain_desc": {
216
+ "desc": "TOTAL (default breakdown) or a domain such as ORGANIC STATUS, AREA OPERATED"
217
+ },
218
+ "domaincat_desc": {
219
+ "desc": "category within the domain"
220
+ },
221
+ "agg_level_desc": {
222
+ "desc": "NATIONAL, STATE, COUNTY, AGRICULTURAL DISTRICT, REGION : MULTI-STATE, ZIP CODE, WATERSHED"
223
+ },
224
+ "state_alpha": {
225
+ "desc": "two-letter state code (US for national rows)"
226
+ },
227
+ "state_name": {
228
+ "desc": "upper-case state name, e.g. IOWA"
229
+ },
230
+ "state_fips_code": {
231
+ "desc": "2-digit state FIPS"
232
+ },
233
+ "county_name": {
234
+ "desc": "upper-case county name"
235
+ },
236
+ "county_code": {
237
+ "desc": "3-digit county FIPS"
238
+ },
239
+ "year": {
240
+ "desc": "year, e.g. 2024"
241
+ },
242
+ "year__GE": {
243
+ "desc": "year >= value"
244
+ },
245
+ "year__LE": {
246
+ "desc": "year <= value"
247
+ },
248
+ "freq_desc": {
249
+ "desc": "ANNUAL, MONTHLY, WEEKLY, POINT IN TIME"
250
+ },
251
+ "reference_period_desc": {
252
+ "desc": "YEAR, MARKETING YEAR, JAN ... DEC, WEEK #nn, FIRST OF MAR, ..."
253
+ }
254
+ },
255
+ "records": "",
256
+ "paging": {
257
+ "type": "none"
258
+ },
259
+ "flatten": false
260
+ }
261
+ },
262
+ "catalog": {
263
+ "corn_production": {
264
+ "id": "CORN, GRAIN - PRODUCTION, MEASURED IN BU",
265
+ "name": "Corn for grain production (bushels)",
266
+ "description": "short_desc; annual, national/state/county, SURVEY (name from NASS Quick Stats usage; not verified live: no key)",
267
+ "endpoint": "query"
268
+ },
269
+ "corn_yield": {
270
+ "id": "CORN, GRAIN - YIELD, MEASURED IN BU / ACRE",
271
+ "name": "Corn for grain yield (bushels per acre)",
272
+ "description": "short_desc (name from NASS Quick Stats usage; not verified live: no key)",
273
+ "endpoint": "query"
274
+ },
275
+ "corn_planted": {
276
+ "id": "CORN - ACRES PLANTED",
277
+ "name": "Corn acres planted",
278
+ "description": "short_desc (all utilizations) (name from NASS Quick Stats usage; not verified live: no key)",
279
+ "endpoint": "query"
280
+ },
281
+ "corn_price": {
282
+ "id": "CORN, GRAIN - PRICE RECEIVED, MEASURED IN $ / BU",
283
+ "name": "Corn price received by farmers",
284
+ "description": "short_desc; monthly and marketing-year (name from NASS Quick Stats usage; not verified live: no key)",
285
+ "endpoint": "query"
286
+ },
287
+ "soybean_production": {
288
+ "id": "SOYBEANS - PRODUCTION, MEASURED IN BU",
289
+ "name": "Soybean production (bushels)",
290
+ "description": "short_desc (name from NASS Quick Stats usage; not verified live: no key)",
291
+ "endpoint": "query"
292
+ },
293
+ "soybean_yield": {
294
+ "id": "SOYBEANS - YIELD, MEASURED IN BU / ACRE",
295
+ "name": "Soybean yield",
296
+ "description": "short_desc (name from NASS Quick Stats usage; not verified live: no key)",
297
+ "endpoint": "query"
298
+ },
299
+ "wheat_production": {
300
+ "id": "WHEAT - PRODUCTION, MEASURED IN BU",
301
+ "name": "All wheat production (bushels)",
302
+ "description": "short_desc (name from NASS Quick Stats usage; not verified live: no key)",
303
+ "endpoint": "query"
304
+ },
305
+ "cattle_inventory": {
306
+ "id": "CATTLE, INCL CALVES - INVENTORY",
307
+ "name": "Cattle and calves inventory (head)",
308
+ "description": "short_desc; January 1 and July 1 (name from NASS Quick Stats usage; not verified live: no key)",
309
+ "endpoint": "query"
310
+ },
311
+ "hogs_inventory": {
312
+ "id": "HOGS - INVENTORY",
313
+ "name": "Hogs and pigs inventory (head)",
314
+ "description": "short_desc; quarterly (name from NASS Quick Stats usage; not verified live: no key)",
315
+ "endpoint": "query"
316
+ },
317
+ "milk_production": {
318
+ "id": "MILK - PRODUCTION, MEASURED IN LB",
319
+ "name": "Milk production (pounds)",
320
+ "description": "short_desc; monthly and annual (name from NASS Quick Stats usage; not verified live: no key)",
321
+ "endpoint": "query"
322
+ }
323
+ }
324
324
  }