data-analyst-mcp 0.0.0-stage → 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.
- package/README.md +261 -2
- package/dist/adapters/_acf_tidy.d.ts +18 -0
- package/dist/adapters/_acf_tidy.js +432 -0
- package/dist/adapters/_acf_tidy.js.map +1 -0
- package/dist/adapters/_actuaries_read.d.ts +38 -0
- package/dist/adapters/_actuaries_read.js +728 -0
- package/dist/adapters/_actuaries_read.js.map +1 -0
- package/dist/adapters/_census_micro.d.ts +70 -0
- package/dist/adapters/_census_micro.js +622 -0
- package/dist/adapters/_census_micro.js.map +1 -0
- package/dist/adapters/_census_util.d.ts +40 -0
- package/dist/adapters/_census_util.js +275 -0
- package/dist/adapters/_census_util.js.map +1 -0
- package/dist/adapters/_dol_states.d.ts +6 -0
- package/dist/adapters/_dol_states.js +58 -0
- package/dist/adapters/_dol_states.js.map +1 -0
- package/dist/adapters/_govinfo_entities.d.ts +4 -0
- package/dist/adapters/_govinfo_entities.js +6 -0
- package/dist/adapters/_govinfo_entities.js.map +1 -0
- package/dist/adapters/_govinfo_json.d.ts +13 -0
- package/dist/adapters/_govinfo_json.js +107 -0
- package/dist/adapters/_govinfo_json.js.map +1 -0
- package/dist/adapters/_govinfo_py.d.ts +22 -0
- package/dist/adapters/_govinfo_py.js +272 -0
- package/dist/adapters/_govinfo_py.js.map +1 -0
- package/dist/adapters/_govinfo_xml.d.ts +22 -0
- package/dist/adapters/_govinfo_xml.js +233 -0
- package/dist/adapters/_govinfo_xml.js.map +1 -0
- package/dist/adapters/_hud_excel.d.ts +2 -0
- package/dist/adapters/_hud_excel.js +166 -0
- package/dist/adapters/_hud_excel.js.map +1 -0
- package/dist/adapters/_omb_grid.d.ts +17 -0
- package/dist/adapters/_omb_grid.js +132 -0
- package/dist/adapters/_omb_grid.js.map +1 -0
- package/dist/adapters/_omb_util.d.ts +40 -0
- package/dist/adapters/_omb_util.js +192 -0
- package/dist/adapters/_omb_util.js.map +1 -0
- package/dist/adapters/_usaspending_state.d.ts +6 -0
- package/dist/adapters/_usaspending_state.js +54 -0
- package/dist/adapters/_usaspending_state.js.map +1 -0
- package/dist/adapters/_usda-fna_book.d.ts +59 -0
- package/dist/adapters/_usda-fna_book.js +869 -0
- package/dist/adapters/_usda-fna_book.js.map +1 -0
- package/dist/adapters/_usda-fna_pdf.d.ts +20 -0
- package/dist/adapters/_usda-fna_pdf.js +361 -0
- package/dist/adapters/_usda-fna_pdf.js.map +1 -0
- package/dist/adapters/_usda-outlook_read.d.ts +70 -0
- package/dist/adapters/_usda-outlook_read.js +362 -0
- package/dist/adapters/_usda-outlook_read.js.map +1 -0
- package/dist/adapters/acf.d.ts +3 -0
- package/dist/adapters/acf.js +187 -0
- package/dist/adapters/acf.js.map +1 -0
- package/dist/adapters/actuaries.d.ts +3 -0
- package/dist/adapters/actuaries.js +293 -0
- package/dist/adapters/actuaries.js.map +1 -0
- package/dist/adapters/bts.d.ts +3 -0
- package/dist/adapters/bts.js +26 -0
- package/dist/adapters/bts.js.map +1 -0
- package/dist/adapters/census-geocoder.d.ts +10 -0
- package/dist/adapters/census-geocoder.js +47 -0
- package/dist/adapters/census-geocoder.js.map +1 -0
- package/dist/adapters/census.d.ts +17 -0
- package/dist/adapters/census.js +983 -0
- package/dist/adapters/census.js.map +1 -0
- package/dist/adapters/cfpb.d.ts +7 -0
- package/dist/adapters/cfpb.js +348 -0
- package/dist/adapters/cfpb.js.map +1 -0
- package/dist/adapters/clinical-trials.d.ts +3 -0
- package/dist/adapters/clinical-trials.js +135 -0
- package/dist/adapters/clinical-trials.js.map +1 -0
- package/dist/adapters/cms.d.ts +3 -0
- package/dist/adapters/cms.js +292 -0
- package/dist/adapters/cms.js.map +1 -0
- package/dist/adapters/college-scorecard.d.ts +3 -0
- package/dist/adapters/college-scorecard.js +122 -0
- package/dist/adapters/college-scorecard.js.map +1 -0
- package/dist/adapters/congress.d.ts +33 -0
- package/dist/adapters/congress.js +589 -0
- package/dist/adapters/congress.js.map +1 -0
- package/dist/adapters/dhs-ohss.d.ts +13 -0
- package/dist/adapters/dhs-ohss.js +598 -0
- package/dist/adapters/dhs-ohss.js.map +1 -0
- package/dist/adapters/doj-news.d.ts +7 -0
- package/dist/adapters/doj-news.js +286 -0
- package/dist/adapters/doj-news.js.map +1 -0
- package/dist/adapters/dol.d.ts +4 -0
- package/dist/adapters/dol.js +634 -0
- package/dist/adapters/dol.js.map +1 -0
- package/dist/adapters/eia.d.ts +15 -0
- package/dist/adapters/eia.js +456 -0
- package/dist/adapters/eia.js.map +1 -0
- package/dist/adapters/epa-aqs.d.ts +3 -0
- package/dist/adapters/epa-aqs.js +357 -0
- package/dist/adapters/epa-aqs.js.map +1 -0
- package/dist/adapters/epa.d.ts +3 -0
- package/dist/adapters/epa.js +298 -0
- package/dist/adapters/epa.js.map +1 -0
- package/dist/adapters/fbi.d.ts +3 -0
- package/dist/adapters/fbi.js +192 -0
- package/dist/adapters/fbi.js.map +1 -0
- package/dist/adapters/fda.d.ts +5 -0
- package/dist/adapters/fda.js +184 -0
- package/dist/adapters/fda.js.map +1 -0
- package/dist/adapters/fdic.d.ts +4 -0
- package/dist/adapters/fdic.js +95 -0
- package/dist/adapters/fdic.js.map +1 -0
- package/dist/adapters/fec.d.ts +3 -0
- package/dist/adapters/fec.js +142 -0
- package/dist/adapters/fec.js.map +1 -0
- package/dist/adapters/fed-board.d.ts +12 -0
- package/dist/adapters/fed-board.js +581 -0
- package/dist/adapters/fed-board.js.map +1 -0
- package/dist/adapters/federal-register.d.ts +11 -0
- package/dist/adapters/federal-register.js +43 -0
- package/dist/adapters/federal-register.js.map +1 -0
- package/dist/adapters/fhfa.d.ts +3 -0
- package/dist/adapters/fhfa.js +253 -0
- package/dist/adapters/fhfa.js.map +1 -0
- package/dist/adapters/fsa.d.ts +9 -0
- package/dist/adapters/fsa.js +335 -0
- package/dist/adapters/fsa.js.map +1 -0
- package/dist/adapters/govinfo.d.ts +30 -0
- package/dist/adapters/govinfo.js +636 -0
- package/dist/adapters/govinfo.js.map +1 -0
- package/dist/adapters/gsa-calc.d.ts +10 -0
- package/dist/adapters/gsa-calc.js +318 -0
- package/dist/adapters/gsa-calc.js.map +1 -0
- package/dist/adapters/hud.d.ts +3 -0
- package/dist/adapters/hud.js +200 -0
- package/dist/adapters/hud.js.map +1 -0
- package/dist/adapters/index.d.ts +3 -0
- package/dist/adapters/index.js +25 -0
- package/dist/adapters/index.js.map +1 -0
- package/dist/adapters/irs-soi.d.ts +6 -0
- package/dist/adapters/irs-soi.js +576 -0
- package/dist/adapters/irs-soi.js.map +1 -0
- package/dist/adapters/naep.d.ts +15 -0
- package/dist/adapters/naep.js +341 -0
- package/dist/adapters/naep.js.map +1 -0
- package/dist/adapters/nhtsa.d.ts +10 -0
- package/dist/adapters/nhtsa.js +239 -0
- package/dist/adapters/nhtsa.js.map +1 -0
- package/dist/adapters/nih.d.ts +5 -0
- package/dist/adapters/nih.js +196 -0
- package/dist/adapters/nih.js.map +1 -0
- package/dist/adapters/noaa.d.ts +3 -0
- package/dist/adapters/noaa.js +148 -0
- package/dist/adapters/noaa.js.map +1 -0
- package/dist/adapters/nrel.d.ts +3 -0
- package/dist/adapters/nrel.js +186 -0
- package/dist/adapters/nrel.js.map +1 -0
- package/dist/adapters/nws.d.ts +3 -0
- package/dist/adapters/nws.js +119 -0
- package/dist/adapters/nws.js.map +1 -0
- package/dist/adapters/omb.d.ts +15 -0
- package/dist/adapters/omb.js +517 -0
- package/dist/adapters/omb.js.map +1 -0
- package/dist/adapters/open-payments.d.ts +5 -0
- package/dist/adapters/open-payments.js +149 -0
- package/dist/adapters/open-payments.js.map +1 -0
- package/dist/adapters/pbgc.d.ts +13 -0
- package/dist/adapters/pbgc.js +283 -0
- package/dist/adapters/pbgc.js.map +1 -0
- package/dist/adapters/philfed.d.ts +12 -0
- package/dist/adapters/philfed.js +59 -0
- package/dist/adapters/philfed.js.map +1 -0
- package/dist/adapters/regulations.d.ts +6 -0
- package/dist/adapters/regulations.js +58 -0
- package/dist/adapters/regulations.js.map +1 -0
- package/dist/adapters/sec.d.ts +13 -0
- package/dist/adapters/sec.js +504 -0
- package/dist/adapters/sec.js.map +1 -0
- package/dist/adapters/senate-lobbying.d.ts +3 -0
- package/dist/adapters/senate-lobbying.js +181 -0
- package/dist/adapters/senate-lobbying.js.map +1 -0
- package/dist/adapters/snapqc.d.ts +32 -0
- package/dist/adapters/snapqc.js +701 -0
- package/dist/adapters/snapqc.js.map +1 -0
- package/dist/adapters/treasury-yields.d.ts +3 -0
- package/dist/adapters/treasury-yields.js +170 -0
- package/dist/adapters/treasury-yields.js.map +1 -0
- package/dist/adapters/usaspending.d.ts +3 -0
- package/dist/adapters/usaspending.js +340 -0
- package/dist/adapters/usaspending.js.map +1 -0
- package/dist/adapters/usda-fna.d.ts +7 -0
- package/dist/adapters/usda-fna.js +707 -0
- package/dist/adapters/usda-fna.js.map +1 -0
- package/dist/adapters/usda-fooddata.d.ts +3 -0
- package/dist/adapters/usda-fooddata.js +101 -0
- package/dist/adapters/usda-fooddata.js.map +1 -0
- package/dist/adapters/usda-nass.d.ts +3 -0
- package/dist/adapters/usda-nass.js +108 -0
- package/dist/adapters/usda-nass.js.map +1 -0
- package/dist/adapters/usda-outlook.d.ts +12 -0
- package/dist/adapters/usda-outlook.js +696 -0
- package/dist/adapters/usda-outlook.js.map +1 -0
- package/dist/adapters/usgs.d.ts +9 -0
- package/dist/adapters/usgs.js +265 -0
- package/dist/adapters/usgs.js.map +1 -0
- package/dist/adapters/usitc.d.ts +18 -0
- package/dist/adapters/usitc.js +170 -0
- package/dist/adapters/usitc.js.map +1 -0
- package/dist/adapters/uspto.d.ts +3 -0
- package/dist/adapters/uspto.js +47 -0
- package/dist/adapters/uspto.js.map +1 -0
- package/dist/adapters/world-bank.d.ts +3 -0
- package/dist/adapters/world-bank.js +163 -0
- package/dist/adapters/world-bank.js.map +1 -0
- package/dist/analysis/cite.d.ts +31 -0
- package/dist/analysis/cite.js +229 -0
- package/dist/analysis/cite.js.map +1 -0
- package/dist/analysis/combine.d.ts +27 -0
- package/dist/analysis/combine.js +198 -0
- package/dist/analysis/combine.js.map +1 -0
- package/dist/analysis/compute.d.ts +62 -0
- package/dist/analysis/compute.js +583 -0
- package/dist/analysis/compute.js.map +1 -0
- package/dist/analysis/expr.d.ts +69 -0
- package/dist/analysis/expr.js +780 -0
- package/dist/analysis/expr.js.map +1 -0
- package/dist/analysis/factfmt.d.ts +16 -0
- package/dist/analysis/factfmt.js +187 -0
- package/dist/analysis/factfmt.js.map +1 -0
- package/dist/analysis/facts.d.ts +63 -0
- package/dist/analysis/facts.js +355 -0
- package/dist/analysis/facts.js.map +1 -0
- package/dist/analysis/handoff.d.ts +58 -0
- package/dist/analysis/handoff.js +208 -0
- package/dist/analysis/handoff.js.map +1 -0
- package/dist/analysis/pyfmt.d.ts +16 -0
- package/dist/analysis/pyfmt.js +156 -0
- package/dist/analysis/pyfmt.js.map +1 -0
- package/dist/analysis/rerun.d.ts +13 -0
- package/dist/analysis/rerun.js +125 -0
- package/dist/analysis/rerun.js.map +1 -0
- package/dist/analysis/table.d.ts +18 -0
- package/dist/analysis/table.js +109 -0
- package/dist/analysis/table.js.map +1 -0
- package/dist/analysis/tools.d.ts +67 -0
- package/dist/analysis/tools.js +217 -0
- package/dist/analysis/tools.js.map +1 -0
- package/dist/analysis/write_table.d.ts +13 -0
- package/dist/analysis/write_table.js +59 -0
- package/dist/analysis/write_table.js.map +1 -0
- package/dist/bin/cli.d.ts +10 -0
- package/dist/bin/cli.js +177 -0
- package/dist/bin/cli.js.map +1 -0
- package/dist/core/cache.d.ts +14 -0
- package/dist/core/cache.js +90 -0
- package/dist/core/cache.js.map +1 -0
- package/dist/core/context.d.ts +12 -0
- package/dist/core/context.js +15 -0
- package/dist/core/context.js.map +1 -0
- package/dist/core/env.d.ts +14 -0
- package/dist/core/env.js +52 -0
- package/dist/core/env.js.map +1 -0
- package/dist/core/generic-rest.d.ts +61 -0
- package/dist/core/generic-rest.js +639 -0
- package/dist/core/generic-rest.js.map +1 -0
- package/dist/core/http.d.ts +120 -0
- package/dist/core/http.js +514 -0
- package/dist/core/http.js.map +1 -0
- package/dist/core/keys.d.ts +43 -0
- package/dist/core/keys.js +174 -0
- package/dist/core/keys.js.map +1 -0
- package/dist/core/manual.d.ts +41 -0
- package/dist/core/manual.js +218 -0
- package/dist/core/manual.js.map +1 -0
- package/dist/core/package.d.ts +58 -0
- package/dist/core/package.js +228 -0
- package/dist/core/package.js.map +1 -0
- package/dist/core/packs.d.ts +139 -0
- package/dist/core/packs.js +173 -0
- package/dist/core/packs.js.map +1 -0
- package/dist/core/policy.d.ts +69 -0
- package/dist/core/policy.js +189 -0
- package/dist/core/policy.js.map +1 -0
- package/dist/core/py.d.ts +40 -0
- package/dist/core/py.js +171 -0
- package/dist/core/py.js.map +1 -0
- package/dist/core/routing.d.ts +10 -0
- package/dist/core/routing.js +39 -0
- package/dist/core/routing.js.map +1 -0
- package/dist/core/tabular.d.ts +21 -0
- package/dist/core/tabular.js +229 -0
- package/dist/core/tabular.js.map +1 -0
- package/dist/deep/_bea_api.d.ts +102 -0
- package/dist/deep/_bea_api.js +457 -0
- package/dist/deep/_bea_api.js.map +1 -0
- package/dist/deep/_bea_fetch.d.ts +151 -0
- package/dist/deep/_bea_fetch.js +1274 -0
- package/dist/deep/_bea_fetch.js.map +1 -0
- package/dist/deep/_bea_util.d.ts +14 -0
- package/dist/deep/_bea_util.js +156 -0
- package/dist/deep/_bea_util.js.map +1 -0
- package/dist/deep/_bls_api.d.ts +84 -0
- package/dist/deep/_bls_api.js +231 -0
- package/dist/deep/_bls_api.js.map +1 -0
- package/dist/deep/_bls_ids.d.ts +43 -0
- package/dist/deep/_bls_ids.js +188 -0
- package/dist/deep/_bls_ids.js.map +1 -0
- package/dist/deep/_bls_lib.d.ts +61 -0
- package/dist/deep/_bls_lib.js +442 -0
- package/dist/deep/_bls_lib.js.map +1 -0
- package/dist/deep/_fred_api.d.ts +148 -0
- package/dist/deep/_fred_api.js +545 -0
- package/dist/deep/_fred_api.js.map +1 -0
- package/dist/deep/_fred_pack.d.ts +162 -0
- package/dist/deep/_fred_pack.js +1027 -0
- package/dist/deep/_fred_pack.js.map +1 -0
- package/dist/deep/_fred_py.d.ts +40 -0
- package/dist/deep/_fred_py.js +199 -0
- package/dist/deep/_fred_py.js.map +1 -0
- package/dist/deep/_ipums_bundle.d.ts +29 -0
- package/dist/deep/_ipums_bundle.js +194 -0
- package/dist/deep/_ipums_bundle.js.map +1 -0
- package/dist/deep/_ipums_ddi.d.ts +23 -0
- package/dist/deep/_ipums_ddi.js +162 -0
- package/dist/deep/_ipums_ddi.js.map +1 -0
- package/dist/deep/_opm_io.d.ts +26 -0
- package/dist/deep/_opm_io.js +383 -0
- package/dist/deep/_opm_io.js.map +1 -0
- package/dist/deep/_opm_parquet.d.ts +31 -0
- package/dist/deep/_opm_parquet.js +744 -0
- package/dist/deep/_opm_parquet.js.map +1 -0
- package/dist/deep/_opm_py.d.ts +6 -0
- package/dist/deep/_opm_py.js +74 -0
- package/dist/deep/_opm_py.js.map +1 -0
- package/dist/deep/_treasury_api.d.ts +48 -0
- package/dist/deep/_treasury_api.js +221 -0
- package/dist/deep/_treasury_api.js.map +1 -0
- package/dist/deep/_treasury_context.d.ts +34 -0
- package/dist/deep/_treasury_context.js +142 -0
- package/dist/deep/_treasury_context.js.map +1 -0
- package/dist/deep/_treasury_lib.d.ts +109 -0
- package/dist/deep/_treasury_lib.js +686 -0
- package/dist/deep/_treasury_lib.js.map +1 -0
- package/dist/deep/bea.d.ts +3 -0
- package/dist/deep/bea.js +248 -0
- package/dist/deep/bea.js.map +1 -0
- package/dist/deep/bls.d.ts +3 -0
- package/dist/deep/bls.js +220 -0
- package/dist/deep/bls.js.map +1 -0
- package/dist/deep/fred.d.ts +3 -0
- package/dist/deep/fred.js +325 -0
- package/dist/deep/fred.js.map +1 -0
- package/dist/deep/ipums.d.ts +59 -0
- package/dist/deep/ipums.js +744 -0
- package/dist/deep/ipums.js.map +1 -0
- package/dist/deep/opm.d.ts +56 -0
- package/dist/deep/opm.js +1033 -0
- package/dist/deep/opm.js.map +1 -0
- package/dist/deep/treasury.d.ts +3 -0
- package/dist/deep/treasury.js +218 -0
- package/dist/deep/treasury.js.map +1 -0
- package/dist/envelope.d.ts +47 -0
- package/dist/envelope.js +88 -0
- package/dist/envelope.js.map +1 -0
- package/dist/index.d.ts +277 -0
- package/dist/index.js +106 -0
- package/dist/index.js.map +1 -0
- package/dist/remote/app.d.ts +21 -0
- package/dist/remote/app.js +218 -0
- package/dist/remote/app.js.map +1 -0
- package/dist/remote/oauth.d.ts +14 -0
- package/dist/remote/oauth.js +90 -0
- package/dist/remote/oauth.js.map +1 -0
- package/dist/remote/pages.d.ts +8 -0
- package/dist/remote/pages.js +56 -0
- package/dist/remote/pages.js.map +1 -0
- package/dist/remote/sign.d.ts +4 -0
- package/dist/remote/sign.js +40 -0
- package/dist/remote/sign.js.map +1 -0
- package/dist/remote/store.d.ts +31 -0
- package/dist/remote/store.js +129 -0
- package/dist/remote/store.js.map +1 -0
- package/dist/report/audit_answer.d.ts +94 -0
- package/dist/report/audit_answer.js +1349 -0
- package/dist/report/audit_answer.js.map +1 -0
- package/dist/report/audit_report.d.ts +23 -0
- package/dist/report/audit_report.js +637 -0
- package/dist/report/audit_report.js.map +1 -0
- package/dist/report/build_report.d.ts +27 -0
- package/dist/report/build_report.js +1168 -0
- package/dist/report/build_report.js.map +1 -0
- package/dist/report/method_audit.d.ts +47 -0
- package/dist/report/method_audit.js +716 -0
- package/dist/report/method_audit.js.map +1 -0
- package/dist/report/policyset.d.ts +50 -0
- package/dist/report/policyset.js +421 -0
- package/dist/report/policyset.js.map +1 -0
- package/dist/report/py.d.ts +58 -0
- package/dist/report/py.js +311 -0
- package/dist/report/py.js.map +1 -0
- package/dist/report/scan_secrets.d.ts +24 -0
- package/dist/report/scan_secrets.js +265 -0
- package/dist/report/scan_secrets.js.map +1 -0
- package/dist/report/style_check.d.ts +29 -0
- package/dist/report/style_check.js +173 -0
- package/dist/report/style_check.js.map +1 -0
- package/dist/report/tools.d.ts +87 -0
- package/dist/report/tools.js +167 -0
- package/dist/report/tools.js.map +1 -0
- package/dist/server.d.ts +5 -0
- package/dist/server.js +247 -0
- package/dist/server.js.map +1 -0
- package/dist/session.d.ts +47 -0
- package/dist/session.js +107 -0
- package/dist/session.js.map +1 -0
- package/dist/toolkit.d.ts +21 -0
- package/dist/toolkit.js +2 -0
- package/dist/toolkit.js.map +1 -0
- package/dist/tools.d.ts +299 -0
- package/dist/tools.js +491 -0
- package/dist/tools.js.map +1 -0
- package/guide/WORKFLOW.md +134 -0
- package/guide/assets/disclaimer.txt +1 -0
- package/guide/assets/download_data.ps1 +162 -0
- package/guide/assets/download_data.sh +143 -0
- package/guide/assets/report_template.html +597 -0
- package/guide/references/report_patterns.md +199 -0
- package/guide/references/routing.md +171 -0
- package/guide/references/style_guide.md +398 -0
- package/package.json +54 -4
- package/packs/acf/endpoints.json +114 -0
- package/packs/acf/policy.json +104 -0
- package/packs/acf/source.md +138 -0
- package/packs/actuaries/endpoints.json +82 -0
- package/packs/actuaries/policy.json +109 -0
- package/packs/actuaries/source.md +137 -0
- package/packs/bea/assets/download_bea.ps1 +182 -0
- package/packs/bea/assets/download_bea.sh +144 -0
- package/packs/bea/docs/bea_api.md +461 -0
- package/packs/bea/docs/datasets.md +157 -0
- package/packs/bea/docs/report_patterns.md +112 -0
- package/packs/bea/policy.json +170 -0
- package/packs/bea/source.md +152 -0
- package/packs/bls/assets/download_bls.ps1 +152 -0
- package/packs/bls/assets/download_bls.sh +167 -0
- package/packs/bls/docs/analysis_patterns.md +108 -0
- package/packs/bls/docs/bls_api.md +73 -0
- package/packs/bls/docs/series_ids.md +149 -0
- package/packs/bls/policy.json +238 -0
- package/packs/bls/series_ids.json +1375 -0
- package/packs/bls/source.md +156 -0
- package/packs/bts/endpoints.json +347 -0
- package/packs/bts/policy.json +94 -0
- package/packs/bts/source.md +97 -0
- package/packs/cdc/endpoints.json +197 -0
- package/packs/cdc/policy.json +83 -0
- package/packs/cdc/source.md +74 -0
- package/packs/census/endpoints.json +99 -0
- package/packs/census/policy.json +238 -0
- package/packs/census/source.md +304 -0
- package/packs/census-geocoder/endpoints.json +70 -0
- package/packs/census-geocoder/policy.json +80 -0
- package/packs/census-geocoder/source.md +53 -0
- package/packs/cfpb/endpoints.json +327 -0
- package/packs/cfpb/policy.json +119 -0
- package/packs/cfpb/source.md +96 -0
- package/packs/clinical-trials/endpoints.json +167 -0
- package/packs/clinical-trials/policy.json +84 -0
- package/packs/clinical-trials/source.md +82 -0
- package/packs/cms/endpoints.json +69 -0
- package/packs/cms/policy.json +96 -0
- package/packs/cms/source.md +112 -0
- package/packs/college-scorecard/endpoints.json +253 -0
- package/packs/college-scorecard/policy.json +106 -0
- package/packs/college-scorecard/source.md +92 -0
- package/packs/congress/endpoints.json +1701 -0
- package/packs/congress/policy.json +117 -0
- package/packs/congress/source.md +190 -0
- package/packs/dhs-ohss/endpoints.json +66 -0
- package/packs/dhs-ohss/policy.json +107 -0
- package/packs/dhs-ohss/source.md +120 -0
- package/packs/doj-news/endpoints.json +59 -0
- package/packs/doj-news/policy.json +96 -0
- package/packs/doj-news/source.md +99 -0
- package/packs/dol/endpoints.json +818 -0
- package/packs/dol/policy.json +135 -0
- package/packs/dol/source.md +181 -0
- package/packs/eia/endpoints.json +718 -0
- package/packs/eia/policy.json +112 -0
- package/packs/eia/source.md +112 -0
- package/packs/epa/endpoints.json +292 -0
- package/packs/epa/policy.json +99 -0
- package/packs/epa/source.md +99 -0
- package/packs/epa-aqs/endpoints.json +174 -0
- package/packs/epa-aqs/policy.json +96 -0
- package/packs/epa-aqs/source.md +97 -0
- package/packs/fbi/endpoints.json +1842 -0
- package/packs/fbi/policy.json +118 -0
- package/packs/fbi/source.md +108 -0
- package/packs/fda/endpoints.json +238 -0
- package/packs/fda/policy.json +121 -0
- package/packs/fda/source.md +117 -0
- package/packs/fdic/endpoints.json +417 -0
- package/packs/fdic/policy.json +83 -0
- package/packs/fdic/source.md +92 -0
- package/packs/fec/endpoints.json +708 -0
- package/packs/fec/policy.json +93 -0
- package/packs/fec/source.md +90 -0
- package/packs/fed-board/endpoints.json +89 -0
- package/packs/fed-board/policy.json +136 -0
- package/packs/fed-board/source.md +118 -0
- package/packs/federal-register/endpoints.json +143 -0
- package/packs/federal-register/policy.json +86 -0
- package/packs/federal-register/source.md +98 -0
- package/packs/fema/endpoints.json +646 -0
- package/packs/fema/policy.json +103 -0
- package/packs/fema/source.md +103 -0
- package/packs/fhfa/endpoints.json +105 -0
- package/packs/fhfa/policy.json +109 -0
- package/packs/fhfa/source.md +108 -0
- package/packs/fred/assets/download_fred.ps1 +122 -0
- package/packs/fred/assets/download_fred.sh +123 -0
- package/packs/fred/docs/analysis_patterns.md +124 -0
- package/packs/fred/docs/fred_api.md +94 -0
- package/packs/fred/docs/series.md +188 -0
- package/packs/fred/policy.json +253 -0
- package/packs/fred/source.md +142 -0
- package/packs/fsa/endpoints.json +150 -0
- package/packs/fsa/policy.json +99 -0
- package/packs/fsa/source.md +102 -0
- package/packs/govinfo/endpoints.json +520 -0
- package/packs/govinfo/policy.json +116 -0
- package/packs/govinfo/source.md +241 -0
- package/packs/gsa-calc/endpoints.json +93 -0
- package/packs/gsa-calc/policy.json +97 -0
- package/packs/gsa-calc/source.md +108 -0
- package/packs/hud/endpoints.json +147 -0
- package/packs/hud/policy.json +84 -0
- package/packs/hud/source.md +97 -0
- package/packs/ipums/assets/download_ipums.ps1 +215 -0
- package/packs/ipums/assets/download_ipums.sh +192 -0
- package/packs/ipums/docs/ipums_api.md +67 -0
- package/packs/ipums/docs/report_patterns.md +117 -0
- package/packs/ipums/docs/variables.md +284 -0
- package/packs/ipums/lib/fetch_text.json +112 -0
- package/packs/ipums/policy.json +215 -0
- package/packs/ipums/source.md +169 -0
- package/packs/irs-soi/endpoints.json +114 -0
- package/packs/irs-soi/policy.json +107 -0
- package/packs/irs-soi/source.md +124 -0
- package/packs/medicaid/endpoints.json +412 -0
- package/packs/medicaid/policy.json +108 -0
- package/packs/medicaid/source.md +136 -0
- package/packs/naep/endpoints.json +217 -0
- package/packs/naep/policy.json +100 -0
- package/packs/naep/source.md +120 -0
- package/packs/nhtsa/endpoints.json +132 -0
- package/packs/nhtsa/policy.json +93 -0
- package/packs/nhtsa/source.md +109 -0
- package/packs/nih/endpoints.json +453 -0
- package/packs/nih/policy.json +86 -0
- package/packs/nih/source.md +108 -0
- package/packs/noaa/endpoints.json +432 -0
- package/packs/noaa/policy.json +95 -0
- package/packs/noaa/source.md +88 -0
- package/packs/nrel/endpoints.json +328 -0
- package/packs/nrel/policy.json +96 -0
- package/packs/nrel/source.md +91 -0
- package/packs/nws/endpoints.json +272 -0
- package/packs/nws/policy.json +82 -0
- package/packs/nws/source.md +81 -0
- package/packs/nyfed/endpoints.json +80 -0
- package/packs/nyfed/policy.json +92 -0
- package/packs/nyfed/source.md +89 -0
- package/packs/omb/endpoints.json +460 -0
- package/packs/omb/policy.json +106 -0
- package/packs/omb/source.md +130 -0
- package/packs/open-payments/endpoints.json +298 -0
- package/packs/open-payments/policy.json +101 -0
- package/packs/open-payments/source.md +99 -0
- package/packs/opm/assets/download_opm.ps1 +125 -0
- package/packs/opm/assets/download_opm.sh +85 -0
- package/packs/opm/docs/fields.md +184 -0
- package/packs/opm/docs/opm_api.md +71 -0
- package/packs/opm/docs/report_patterns.md +83 -0
- package/packs/opm/lib/data_dictionary.csv +73 -0
- package/packs/opm/policy.json +142 -0
- package/packs/opm/source.md +137 -0
- package/packs/pbgc/endpoints.json +483 -0
- package/packs/pbgc/policy.json +94 -0
- package/packs/pbgc/source.md +95 -0
- package/packs/philfed/endpoints.json +85 -0
- package/packs/philfed/policy.json +94 -0
- package/packs/philfed/source.md +125 -0
- package/packs/port.json +287 -0
- package/packs/regulations/endpoints.json +288 -0
- package/packs/regulations/policy.json +86 -0
- package/packs/regulations/source.md +84 -0
- package/packs/sec/endpoints.json +237 -0
- package/packs/sec/policy.json +86 -0
- package/packs/sec/source.md +101 -0
- package/packs/senate-lobbying/endpoints.json +554 -0
- package/packs/senate-lobbying/policy.json +99 -0
- package/packs/senate-lobbying/source.md +100 -0
- package/packs/snapqc/endpoints.json +1426 -0
- package/packs/snapqc/policy.json +92 -0
- package/packs/snapqc/source.md +96 -0
- package/packs/treasury/catalog.json +2267 -0
- package/packs/treasury/docs/api_guide.md +245 -0
- package/packs/treasury/docs/datasets.md +56 -0
- package/packs/treasury/docs/report_patterns.md +126 -0
- package/packs/treasury/policy.json +159 -0
- package/packs/treasury/source.md +170 -0
- package/packs/treasury-yields/endpoints.json +226 -0
- package/packs/treasury-yields/policy.json +86 -0
- package/packs/treasury-yields/source.md +80 -0
- package/packs/usaspending/endpoints.json +1316 -0
- package/packs/usaspending/policy.json +109 -0
- package/packs/usaspending/source.md +103 -0
- package/packs/usda-fna/endpoints.json +427 -0
- package/packs/usda-fna/policy.json +133 -0
- package/packs/usda-fna/source.md +217 -0
- package/packs/usda-fooddata/endpoints.json +181 -0
- package/packs/usda-fooddata/policy.json +94 -0
- package/packs/usda-fooddata/source.md +105 -0
- package/packs/usda-nass/endpoints.json +324 -0
- package/packs/usda-nass/policy.json +95 -0
- package/packs/usda-nass/source.md +85 -0
- package/packs/usda-outlook/endpoints.json +86 -0
- package/packs/usda-outlook/policy.json +109 -0
- package/packs/usda-outlook/source.md +144 -0
- package/packs/usgs/endpoints.json +313 -0
- package/packs/usgs/policy.json +95 -0
- package/packs/usgs/source.md +96 -0
- package/packs/usitc/endpoints.json +74 -0
- package/packs/usitc/policy.json +111 -0
- package/packs/usitc/source.md +90 -0
- package/packs/uspto/endpoints.json +141 -0
- package/packs/uspto/policy.json +95 -0
- package/packs/uspto/source.md +101 -0
- package/packs/va/endpoints.json +414 -0
- package/packs/va/policy.json +101 -0
- package/packs/va/source.md +129 -0
- package/packs/world-bank/endpoints.json +122 -0
- package/packs/world-bank/policy.json +101 -0
- package/packs/world-bank/source.md +93 -0
|
@@ -0,0 +1,105 @@
|
|
|
1
|
+
# USDA FoodData Central
|
|
2
|
+
Depth: standard. Key: optional (DATA_GOV_API_KEY; DEMO_KEY otherwise). Nutrient composition of foods:
|
|
3
|
+
Foundation Foods, SR Legacy, the Food and Nutrient Database for Dietary Studies (FNDDS, foods as eaten in
|
|
4
|
+
NHANES), and the Branded Foods database (label data of commercial products).
|
|
5
|
+
|
|
6
|
+
## When to use
|
|
7
|
+
- Calories, macronutrients, vitamins and minerals of a food or a list of foods; comparing products;
|
|
8
|
+
nutrient profiles of a food category; branded products of a brand owner.
|
|
9
|
+
- Not here: what people eat or how much (NHANES intake, not covered), food prices (not covered), food
|
|
10
|
+
recalls and safety (fda), crop and livestock statistics (usda-nass), school meals or SNAP (not covered).
|
|
11
|
+
|
|
12
|
+
## Endpoints and datasets
|
|
13
|
+
| Endpoint | Returns | Parameters |
|
|
14
|
+
|---|---|---|
|
|
15
|
+
| `search` | foods matching words or field queries (`foodCategory:"Cheese"`), with nutrients (200 a page) | `query` (required), `dataType`, `brandOwner`, `sortBy`, `sortOrder` |
|
|
16
|
+
| `food` | one food (all nutrients) | `fdcId`, `format` (full, abridged), `nutrients` |
|
|
17
|
+
| `foods` | up to 20 foods by id per request (the pack's limit; see traps) | `fdcIds` (list), `format` (default abridged), `nutrients` |
|
|
18
|
+
| `list` | every food of a data type, paged | `dataType`, `sortBy`, `sortOrder` |
|
|
19
|
+
|
|
20
|
+
`dataType` values (catalog aliases, found with a `request_schema` search): `Foundation`, `SR Legacy`, `Survey (FNDDS)`,
|
|
21
|
+
`Branded` (a list means any of them). `nutrients` takes nutrient NUMBERS (not ids): 208 energy kcal,
|
|
22
|
+
203 protein, 204 total fat, 205 carbohydrate, 269 total sugars, 291 fiber, 307 sodium, 301 calcium,
|
|
23
|
+
303 iron, 306 potassium, 601 cholesterol, 606 saturated fat, 605 trans fat, 401 vitamin C, 320 vitamin A
|
|
24
|
+
RAE, 328 vitamin D, 255 water (table in endpoints.json `nutrient_numbers`).
|
|
25
|
+
|
|
26
|
+
Request option `layout`: `"long"` (default) gives one row per food and nutrient with columns `fdcId`,
|
|
27
|
+
`description`, `dataType`, `brandOwner`, `foodCategory`, `servingSize`, `servingSizeUnit`,
|
|
28
|
+
`publishedDate`, `nutrient_number`, `nutrient_id`, `nutrient_name`, `unit`, `value`, `derivation`;
|
|
29
|
+
`"foods"` gives one row per food with `foodNutrients` as JSON text.
|
|
30
|
+
|
|
31
|
+
## Spec examples
|
|
32
|
+
```json
|
|
33
|
+
{"description": "Cheddar cheese (Foundation) nutrients",
|
|
34
|
+
"requests": [{"name": "cheddar_foundation", "endpoint": "search", "params": {"query": "cheddar", "dataType": ["Foundation"]}}]}
|
|
35
|
+
```
|
|
36
|
+
```json
|
|
37
|
+
{"description": "Energy, protein and fat of two cheeses",
|
|
38
|
+
"requests": [{"name": "two_cheeses", "endpoint": "foods", "params": {"fdcIds": [328637, 169901], "nutrients": "203,204,208"}}]}
|
|
39
|
+
```
|
|
40
|
+
```json
|
|
41
|
+
{"description": "Branded products in one food category (first 5,000; totalHits says how many), with nutrients",
|
|
42
|
+
"requests": [{"name": "cheese_category", "endpoint": "search", "max_rows": 5000,
|
|
43
|
+
"params": {"query": "foodCategory:\"Cheese\"", "dataType": ["Branded"]}}]}
|
|
44
|
+
```
|
|
45
|
+
```json
|
|
46
|
+
{"description": "Sodium in branded potato chips (first 1,000 products)",
|
|
47
|
+
"requests": [{"name": "chips_sodium", "endpoint": "search", "max_rows": 1000,
|
|
48
|
+
"params": {"query": "potato chips", "dataType": ["Branded"]}}]}
|
|
49
|
+
```
|
|
50
|
+
Search, then pick foods by `fdcId` and `dataType`; keep the id in the report so the numbers can be traced.
|
|
51
|
+
|
|
52
|
+
## Data format and traps
|
|
53
|
+
- Nutrient values are per 100 g of edible food (per 100 ml for beverages measured in ml), for every data type.
|
|
54
|
+
Branded foods convert the label to 100 g: a cheese with `servingSize` 28 g lists protein 21.4, which is
|
|
55
|
+
per 100 g, not per serving (checked). Per-serving amounts = value x servingSize / 100.
|
|
56
|
+
- Energy appears more than once: kcal (208) and kJ (268); newer Foundation foods carry only
|
|
57
|
+
957 "Energy (Atwater General Factors)" and 958 "(Atwater Specific Factors)" and no 208 (checked for raw
|
|
58
|
+
apples). Filter by `nutrient_number` and `unit`, never by name alone, and say which energy is used.
|
|
59
|
+
Branded beverages are per 100 ml (orange juice: 46 kcal, serving 240 ml).
|
|
60
|
+
- Unit spelling differs by endpoint: search and abridged records use "G", "MG", "UG", "KCAL"; full records
|
|
61
|
+
use "g", "mg", "kcal". Compare case-insensitively.
|
|
62
|
+
- Search matches words loosely and ranks by score: "cheddar cheese" returned 301 Foundation and SR
|
|
63
|
+
Legacy hits, including imitation cheese. Check `description` and `dataType`, or use `+word` and quoted
|
|
64
|
+
phrases (a quoted phrase must stand in that order in the description, so it can return very few rows;
|
|
65
|
+
check the count, and use a field query for a category). `totalHits` can be large for Branded (60,638 for "cheese").
|
|
66
|
+
- **Field queries** (Lucene style, verified 2026-10-28): `query` can name a field, `foodCategory:"Cheese"`
|
|
67
|
+
(Branded: 23,601 products), `ingredients:"annatto"`, `brandOwner:"..."`, `description:...`, and combine
|
|
68
|
+
them with `+` (must) and `-` (must not): `+foodCategory:"Cheese" +ingredients:"annatto"`. **For "products in
|
|
69
|
+
a category", filter on `foodCategory`, never a union of word searches** (word searches pull in other
|
|
70
|
+
products and miss products whose names lack the word). Quote a value of several words: unquoted, only the
|
|
71
|
+
first word is bound to the field (`foodCategory:Breakfast Cereals` searched "Cereals" everywhere, 12,661
|
|
72
|
+
hits). The quoted value matches those words in order within the category name, any case: "Breakfast
|
|
73
|
+
Cereals" also matches "Breakfast Cereals - Hot And Cold". A value that differs from FDC's spelling (an
|
|
74
|
+
extra space or other separator, a made-up name) returns 0 rows, another category, or the front server's
|
|
75
|
+
HTML 400 page: copy the name exactly. Category names: run a word search with `"layout": "foods"` and count
|
|
76
|
+
its `foodCategory` column (Branded names such as "Cheese", "Yogurt"; Foundation and SR Legacy use groups
|
|
77
|
+
such as "Dairy and Egg Products"); the complete Branded list is the `branded_food_category` column of the
|
|
78
|
+
Branded download (https://fdc.nal.usda.gov/download-datasets). Say which category names the answer used.
|
|
79
|
+
- The same food appears in several data types with different values (Foundation vs SR Legacy cheddar).
|
|
80
|
+
Do not mix data types in one comparison without saying so.
|
|
81
|
+
- A missing nutrient is not zero: Branded products only list label nutrients; SR Legacy and Foundation
|
|
82
|
+
analyze different sets. The long layout has no row for a nutrient that was not reported.
|
|
83
|
+
- `derivation` tells analytical vs calculated or imputed values (Foundation, SR Legacy).
|
|
84
|
+
- `publishedDate` (search) and `publicationDate` (food records) name the release of the record.
|
|
85
|
+
- Paging: `pageSize` at most 200 (HTTP 400 above it, verified).
|
|
86
|
+
- An HTML "400 Bad Request" page (from the front server) can answer a valid request that works moments
|
|
87
|
+
later; the API's own parameter errors are JSON or text. The pack retries the HTML page up to 3 times; if
|
|
88
|
+
it persists, run again later rather than rewriting a correct spec.
|
|
89
|
+
- `foods` ids: the API spec documents at most 20 `fdcIds`; live (2026-10-22) it returned up to 50 and
|
|
90
|
+
silently dropped the rest, with no error. The pack refuses more than 20 per request: split a longer
|
|
91
|
+
list into several requests. Ids that are not found are omitted too, so compare the row count with the
|
|
92
|
+
ids asked for.
|
|
93
|
+
|
|
94
|
+
## Access
|
|
95
|
+
Key optional: `DATA_GOV_API_KEY` (free api.data.gov key; sign up at https://fdc.nal.usda.gov/api-key-signup),
|
|
96
|
+
sent as `api_key`. FDC allows 1,000 requests an hour per key; exceeding it blocks the key for an hour
|
|
97
|
+
(FDC API guide). Without a key the pack uses `DEMO_KEY`, whose hourly and daily limits are much lower
|
|
98
|
+
(api.data.gov; enough for a few searches). `fetch` works either way. Manual route (`manual_bundle`): INSTRUCTIONS.md links
|
|
99
|
+
carry DEMO_KEY and open in a browser (save as the shown names, upload); whole data types (CSV or JSON)
|
|
100
|
+
are at https://fdc.nal.usda.gov/download-datasets.
|
|
101
|
+
|
|
102
|
+
## Citation and terms
|
|
103
|
+
"U.S. Department of Agriculture, Agricultural Research Service. FoodData Central: <description>.
|
|
104
|
+
fdc.nal.usda.gov, retrieved <date>." Public domain, CC0 1.0; USDA asks that FoodData Central be cited as
|
|
105
|
+
the source. Redistribution allowed.
|
|
@@ -0,0 +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
|
+
}
|
|
324
|
+
}
|
|
@@ -0,0 +1,95 @@
|
|
|
1
|
+
{
|
|
2
|
+
"id": "usda-nass",
|
|
3
|
+
"title": "USDA NASS Quick Stats",
|
|
4
|
+
"agency": "U.S. Department of Agriculture, National Agricultural Statistics Service",
|
|
5
|
+
"depth": "standard",
|
|
6
|
+
"domains": [
|
|
7
|
+
"agriculture",
|
|
8
|
+
"food"
|
|
9
|
+
],
|
|
10
|
+
"keywords": [
|
|
11
|
+
"agriculture",
|
|
12
|
+
"crop",
|
|
13
|
+
"crops",
|
|
14
|
+
"corn",
|
|
15
|
+
"soybeans",
|
|
16
|
+
"wheat",
|
|
17
|
+
"cotton",
|
|
18
|
+
"yield",
|
|
19
|
+
"acres planted",
|
|
20
|
+
"harvested",
|
|
21
|
+
"crop production",
|
|
22
|
+
"livestock",
|
|
23
|
+
"cattle",
|
|
24
|
+
"hogs",
|
|
25
|
+
"milk",
|
|
26
|
+
"eggs",
|
|
27
|
+
"price received",
|
|
28
|
+
"farm",
|
|
29
|
+
"farms",
|
|
30
|
+
"census of agriculture",
|
|
31
|
+
"nass",
|
|
32
|
+
"quick stats",
|
|
33
|
+
"county crop"
|
|
34
|
+
],
|
|
35
|
+
"questions": [
|
|
36
|
+
"corn production by state in 2024",
|
|
37
|
+
"soybean yield trend in Iowa",
|
|
38
|
+
"cattle inventory over time",
|
|
39
|
+
"prices received by farmers for wheat",
|
|
40
|
+
"number of farms by county from the Census of Agriculture"
|
|
41
|
+
],
|
|
42
|
+
"homepage": "https://quickstats.nass.usda.gov/",
|
|
43
|
+
"terms_url": "https://quickstats.nass.usda.gov/api",
|
|
44
|
+
"auth": {
|
|
45
|
+
"env": "USDA_NASS_API_KEY",
|
|
46
|
+
"required": "required",
|
|
47
|
+
"placement": "query",
|
|
48
|
+
"param": "key",
|
|
49
|
+
"home": "usda-nass",
|
|
50
|
+
"signup_url": "https://quickstats.nass.usda.gov/api",
|
|
51
|
+
"echoes_key": false,
|
|
52
|
+
"key_only": []
|
|
53
|
+
},
|
|
54
|
+
"limits": {
|
|
55
|
+
"rps": 1,
|
|
56
|
+
"burst": 3,
|
|
57
|
+
"max_rows": 50000
|
|
58
|
+
},
|
|
59
|
+
"routes": {
|
|
60
|
+
"api": {
|
|
61
|
+
"base": "https://quickstats.nass.usda.gov",
|
|
62
|
+
"probe": "https://quickstats.nass.usda.gov/api/get_counts/?commodity_desc=CORN&year__GE=2012&state_alpha=VA",
|
|
63
|
+
"hosts": [
|
|
64
|
+
"quickstats.nass.usda.gov"
|
|
65
|
+
]
|
|
66
|
+
},
|
|
67
|
+
"manual": {
|
|
68
|
+
"how": "Build the same query on https://quickstats.nass.usda.gov/ (no key needed: pick Program, Sector, Group, Commodity, Category, Data Item, Geographic Level, State and Year, then Get Data > Spreadsheet) and upload the CSV; or, with a key, run the download script in the bundle."
|
|
69
|
+
}
|
|
70
|
+
},
|
|
71
|
+
"cache": {
|
|
72
|
+
"mode": "run_only",
|
|
73
|
+
"ttl_hours": null,
|
|
74
|
+
"why": "Estimates are revised with each report (annual summaries revise earlier forecasts); queries are small."
|
|
75
|
+
},
|
|
76
|
+
"redistribution": {
|
|
77
|
+
"mode": "allowed",
|
|
78
|
+
"why": "NASS statistics are U.S. government works in the public domain (17 U.S.C. 105); the Quick Stats API terms govern access and rate of use, not reuse of the data."
|
|
79
|
+
},
|
|
80
|
+
"notices": [
|
|
81
|
+
"This product uses the NASS API but is not endorsed or certified by NASS."
|
|
82
|
+
],
|
|
83
|
+
"retention": null,
|
|
84
|
+
"citation": "USDA National Agricultural Statistics Service, Quick Stats ({dataset}), quickstats.nass.usda.gov, retrieved {retrieved_long}.",
|
|
85
|
+
"audit_hooks": [],
|
|
86
|
+
"clarify": [
|
|
87
|
+
"Survey estimates (annual and monthly) or the Census of Agriculture (every five years, county detail)? They differ and must not be mixed in one series.",
|
|
88
|
+
"Marketing-year or calendar-year values? Prices received are published monthly and as marketing-year averages."
|
|
89
|
+
],
|
|
90
|
+
"formats": [
|
|
91
|
+
"json",
|
|
92
|
+
"csv",
|
|
93
|
+
"xml"
|
|
94
|
+
]
|
|
95
|
+
}
|
|
@@ -0,0 +1,85 @@
|
|
|
1
|
+
# USDA NASS Quick Stats
|
|
2
|
+
Depth: standard. Key: required (USDA_NASS_API_KEY). Every published NASS estimate: crop acreage,
|
|
3
|
+
yield, production and stocks; livestock inventories and production; prices received; farm economics;
|
|
4
|
+
and the Census of Agriculture (every five years, to the county), national to county level.
|
|
5
|
+
|
|
6
|
+
## When to use
|
|
7
|
+
- Crop production, area planted and harvested, yield by state or county and year; livestock and
|
|
8
|
+
poultry inventories; milk and egg production; prices received by farmers; Census of Agriculture
|
|
9
|
+
counts (farms, land in farms, sales, operator demographics) by county.
|
|
10
|
+
- Not here: food prices paid by consumers (bls CPI); farm income and balance sheet forecasts (USDA ERS,
|
|
11
|
+
not covered); crop insurance (not covered); agricultural trade (census trade); food safety
|
|
12
|
+
recalls (fda).
|
|
13
|
+
|
|
14
|
+
## Endpoints and datasets
|
|
15
|
+
| Endpoint | Returns (one row per) | Parameters |
|
|
16
|
+
|---|---|---|
|
|
17
|
+
| `query` | published value (at most 50,000 a request) | any Quick Stats column as a filter, plus operators |
|
|
18
|
+
| `count` | the number of rows a query would return | same filters |
|
|
19
|
+
| `param_values` | value a parameter takes | `param` (e.g. commodity_desc, short_desc) plus filters |
|
|
20
|
+
Filters (the "What, Where, When" columns): `source_desc` (SURVEY, CENSUS), `sector_desc`,
|
|
21
|
+
`group_desc`, `commodity_desc`, `class_desc`, `statisticcat_desc`, `unit_desc`, `short_desc` (the
|
|
22
|
+
full data item, most precise), `domain_desc` (TOTAL for no breakdown), `agg_level_desc` (NATIONAL,
|
|
23
|
+
STATE, COUNTY, ...), `state_alpha`, `state_name`, `county_name`, `county_code`, `year`, `freq_desc`,
|
|
24
|
+
`reference_period_desc`. Operators go on the parameter name: `year__GE=2012` (>=), `year__LE` (<=),
|
|
25
|
+
`__LT` (<), `__GT` (>), `__LIKE`, `__NOT_LIKE`, `__NE` (not equal) (API page, quickstats.nass.usda.gov/api).
|
|
26
|
+
Catalog aliases for `short_desc` (a `request_schema` search finds more): corn_production, corn_yield, corn_planted,
|
|
27
|
+
corn_price, soybean_production, soybean_yield, wheat_production, cattle_inventory, hogs_inventory,
|
|
28
|
+
milk_production (names from Quick Stats usage, NOT verified live: no key; check with `param_values`).
|
|
29
|
+
|
|
30
|
+
## Spec examples
|
|
31
|
+
```json
|
|
32
|
+
{"description": "Corn in Virginia since 2012 (the documented example), and how many rows it has",
|
|
33
|
+
"requests": [{"name": "corn_va", "endpoint": "query",
|
|
34
|
+
"params": {"commodity_desc": "CORN", "year__GE": 2012, "state_alpha": "VA"}},
|
|
35
|
+
{"name": "corn_va_count", "endpoint": "count",
|
|
36
|
+
"params": {"commodity_desc": "CORN", "year__GE": 2012, "state_alpha": "VA"}}]}
|
|
37
|
+
```
|
|
38
|
+
```json
|
|
39
|
+
{"description": "Corn for grain production by state, 2024 (survey)",
|
|
40
|
+
"requests": [{"name": "corn_states_2024", "endpoint": "query",
|
|
41
|
+
"params": {"short_desc": "corn_production", "source_desc": "SURVEY", "agg_level_desc": "STATE",
|
|
42
|
+
"year": 2024, "reference_period_desc": "YEAR"}}]}
|
|
43
|
+
```
|
|
44
|
+
```json
|
|
45
|
+
{"description": "Every sector name",
|
|
46
|
+
"requests": [{"name": "sectors", "endpoint": "param_values", "params": {"param": "sector_desc"}}]}
|
|
47
|
+
```
|
|
48
|
+
|
|
49
|
+
## Data format and traps
|
|
50
|
+
- `Value` is text as published: "510,000" with commas, or a code. The pack adds `value_num`
|
|
51
|
+
(no commas; empty for codes) and `value_flag`. Codes (NASS): (D) withheld to avoid disclosing
|
|
52
|
+
individual operations, (Z) less than half the rounding unit, (NA) not available, (X) not applicable,
|
|
53
|
+
(S) insufficient reports, (H)/(L) coefficient of variation above 99.95% / below 0.05%. Never read a
|
|
54
|
+
code as zero (the code list is from NASS publications, not the API page). `CV (%)` is documented
|
|
55
|
+
for the 2012 Census of Agriculture only; it gets `cv_num` / `cv_flag`.
|
|
56
|
+
- A broad filter mixes many data items: commodity_desc CORN alone returns acres, production, yield,
|
|
57
|
+
stocks, prices, grain and silage, and SURVEY plus CENSUS rows. Filter on `short_desc` (or
|
|
58
|
+
statisticcat_desc + unit_desc + util_practice_desc) and `domain_desc: TOTAL`, and check
|
|
59
|
+
`count` first; more than 50,000 rows is refused ("exceeds limit = 50000").
|
|
60
|
+
- SURVEY and CENSUS values for the same item differ (methods, coverage, timing): never splice them.
|
|
61
|
+
- Several values per year: `reference_period_desc` (YEAR, MARKETING YEAR, a month, a week,
|
|
62
|
+
"FIRST OF JAN") and `freq_desc` separate them. Forecasts (e.g. "YEAR - AUG FORECAST") are revised
|
|
63
|
+
until the annual summary; use the final YEAR row for history.
|
|
64
|
+
- Values are upper case ("CORN", "IOWA"); the pack upper-cases filter values. State totals do not always
|
|
65
|
+
add to the national value (suppression, "OTHER STATES" rows); county rows may be withheld (D).
|
|
66
|
+
- Units are in `unit_desc` (BU, ACRES, BU / ACRE, $ / BU, HEAD, LB, $); production is in units, not
|
|
67
|
+
thousands. Census of Agriculture years: 2002, 2007, 2012, 2017, 2022.
|
|
68
|
+
- Verification status: built from the Quick Stats API documentation (tests use doc_* fixtures from its
|
|
69
|
+
examples); not checked against a live key.
|
|
70
|
+
|
|
71
|
+
## Access
|
|
72
|
+
Key required: free, by email, at https://quickstats.nass.usda.gov/api (accept the terms, enter an
|
|
73
|
+
email; the key arrives by mail). Store it as `USDA_NASS_API_KEY` with the setup script; it goes in the
|
|
74
|
+
`key` query parameter. Rate limits are not published (NASS may block heavy use); the pack sends at
|
|
75
|
+
most one request a second. Manual route without a key: build the query at
|
|
76
|
+
https://quickstats.nass.usda.gov/ (Program, Sector, Group, Commodity, Category, Data Item, Geographic
|
|
77
|
+
Level, State, Year), choose Get Data, then the Spreadsheet link (CSV), and upload it; ingest reads the
|
|
78
|
+
CSV (same columns as the API). With a key, the bundle's script downloads `format=CSV` links.
|
|
79
|
+
Very large extracts: the bulk files at https://www.nass.usda.gov/datasets/ (tab-delimited, gzip).
|
|
80
|
+
|
|
81
|
+
## Citation and terms
|
|
82
|
+
"USDA National Agricultural Statistics Service, Quick Stats, <data item>, quickstats.nass.usda.gov,
|
|
83
|
+
retrieved <date>." Public domain U.S. government data; redistribution allowed. Name the program
|
|
84
|
+
(Survey or Census) and reference period with every number. Required notice (API terms, "Attribution"):
|
|
85
|
+
"This product uses the NASS API but is not endorsed or certified by NASS." The report carries it (policy.json `notices`).
|