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,112 @@
|
|
|
1
|
+
{
|
|
2
|
+
"id": "eia",
|
|
3
|
+
"title": "EIA Open Data API v2 (U.S. Energy Information Administration)",
|
|
4
|
+
"agency": "U.S. Energy Information Administration",
|
|
5
|
+
"depth": "standard",
|
|
6
|
+
"domains": [
|
|
7
|
+
"energy",
|
|
8
|
+
"prices",
|
|
9
|
+
"environment"
|
|
10
|
+
],
|
|
11
|
+
"keywords": [
|
|
12
|
+
"eia",
|
|
13
|
+
"energy",
|
|
14
|
+
"electricity",
|
|
15
|
+
"electricity prices",
|
|
16
|
+
"power",
|
|
17
|
+
"retail sales",
|
|
18
|
+
"natural gas",
|
|
19
|
+
"gas prices",
|
|
20
|
+
"gasoline",
|
|
21
|
+
"diesel",
|
|
22
|
+
"crude oil",
|
|
23
|
+
"oil prices",
|
|
24
|
+
"wti",
|
|
25
|
+
"brent",
|
|
26
|
+
"petroleum",
|
|
27
|
+
"coal",
|
|
28
|
+
"nuclear",
|
|
29
|
+
"renewables",
|
|
30
|
+
"solar",
|
|
31
|
+
"wind",
|
|
32
|
+
"generation",
|
|
33
|
+
"energy consumption",
|
|
34
|
+
"energy production",
|
|
35
|
+
"seds",
|
|
36
|
+
"state energy",
|
|
37
|
+
"co2 emissions",
|
|
38
|
+
"energy expenditures",
|
|
39
|
+
"monthly energy review",
|
|
40
|
+
"steo",
|
|
41
|
+
"annual energy outlook",
|
|
42
|
+
"aeo",
|
|
43
|
+
"kilowatt-hour",
|
|
44
|
+
"btu"
|
|
45
|
+
],
|
|
46
|
+
"questions": [
|
|
47
|
+
"average retail electricity price by state",
|
|
48
|
+
"weekly gasoline prices",
|
|
49
|
+
"WTI crude oil price trend",
|
|
50
|
+
"energy consumption per capita by state",
|
|
51
|
+
"natural gas price for residential customers",
|
|
52
|
+
"electricity generation by fuel type",
|
|
53
|
+
"CO2 emissions from power plants by state"
|
|
54
|
+
],
|
|
55
|
+
"homepage": "https://www.eia.gov/opendata/",
|
|
56
|
+
"terms_url": "https://www.eia.gov/about/copyrights_reuse.php",
|
|
57
|
+
"auth": {
|
|
58
|
+
"env": "EIA_API_KEY",
|
|
59
|
+
"required": "optional",
|
|
60
|
+
"placement": "query",
|
|
61
|
+
"param": "api_key",
|
|
62
|
+
"prefix": "",
|
|
63
|
+
"home": "eia",
|
|
64
|
+
"signup_url": "https://www.eia.gov/opendata/register.php",
|
|
65
|
+
"echoes_key": false,
|
|
66
|
+
"demo_key": "DEMO_KEY",
|
|
67
|
+
"key_only": [
|
|
68
|
+
"more than a handful of requests an hour (without a key the pack uses api.data.gov's DEMO_KEY, which allowed 10 requests an hour from one address when checked)"
|
|
69
|
+
]
|
|
70
|
+
},
|
|
71
|
+
"limits": {
|
|
72
|
+
"rps": 2,
|
|
73
|
+
"burst": 4,
|
|
74
|
+
"max_rows": 100000
|
|
75
|
+
},
|
|
76
|
+
"routes": {
|
|
77
|
+
"api": {
|
|
78
|
+
"base": "https://api.eia.gov/v2",
|
|
79
|
+
"probe": "https://api.eia.gov/v2/",
|
|
80
|
+
"hosts": [
|
|
81
|
+
"api.eia.gov"
|
|
82
|
+
]
|
|
83
|
+
},
|
|
84
|
+
"manual": {
|
|
85
|
+
"keyless_citation": "U.S. Energy Information Administration, {dataset}, Petroleum & Other Liquids data series history (www.eia.gov/dnav/pet), retrieved {retrieved_long}.",
|
|
86
|
+
"keyless_file": "Petroleum series without a key (when DEMO_KEY is rate-limited): EIA's history file https://www.eia.gov/dnav/pet/hist_xls/<series><d|w|m|a>.xls (d daily, w weekly, m monthly, a annual; one series per file, 30-500 KB), e.g. EMM_EPMR_PTE_NUS_DPGm.xls (U.S. regular gasoline, monthly), EMD_EPD2D_PTE_NUS_DPGw.xls (diesel, weekly), RWTCd.xls (WTI, daily), MGFUPUS2m.xls (finished motor gasoline product supplied, monthly). Covers a data request of any petroleum/* route that gives facets {\"series\": [one id]}, no other facet, and the value column; fetch's key error lists the exact files in keyless_files. Pass the .xls as downloaded to ingest with the same spec, which keeps the request's dates. Not for electricity, natural gas, SEDS or other routes, or several series in one request.",
|
|
87
|
+
"how": "Open each link in manual_download/INSTRUCTIONS.md in a browser (each returns JSON with up to 5,000 rows; the links carry DEMO_KEY: replace it with your own free key from https://www.eia.gov/opendata/register.php if the hourly limit is hit), save each under the name shown, upload them, then call ingest. Without the bundle: the API browser https://www.eia.gov/opendata/browser/ builds the same query (route, frequency, facets, dates) and downloads CSV or Excel; or the data pages on eia.gov (e.g. Electric Power Monthly, State Energy Data System) have spreadsheets. Upload the file and say which it is."
|
|
88
|
+
}
|
|
89
|
+
},
|
|
90
|
+
"cache": {
|
|
91
|
+
"mode": "run_only",
|
|
92
|
+
"ttl_hours": null,
|
|
93
|
+
"why": "Series are updated weekly to annually and revised; data/ is reused only within a run."
|
|
94
|
+
},
|
|
95
|
+
"redistribution": {
|
|
96
|
+
"mode": "allowed",
|
|
97
|
+
"why": "EIA data are U.S. government works in the public domain (17 U.S.C. 105); EIA's copyright and reuse page asks that EIA be cited as the source."
|
|
98
|
+
},
|
|
99
|
+
"notices": [],
|
|
100
|
+
"retention": null,
|
|
101
|
+
"citation": "U.S. Energy Information Administration, {dataset}, EIA Open Data API v2 (api.eia.gov), retrieved {retrieved_long}.",
|
|
102
|
+
"audit_hooks": [],
|
|
103
|
+
"clarify": [
|
|
104
|
+
"Nominal or real (inflation-adjusted) prices? EIA prices are nominal unless the series says otherwise.",
|
|
105
|
+
"Which frequency and sector (residential, commercial, industrial, all sectors)? Averages across sectors mix very different prices."
|
|
106
|
+
],
|
|
107
|
+
"formats": [
|
|
108
|
+
"json",
|
|
109
|
+
"csv (API browser)",
|
|
110
|
+
"xlsx (data pages)"
|
|
111
|
+
]
|
|
112
|
+
}
|
|
@@ -0,0 +1,112 @@
|
|
|
1
|
+
# EIA Open Data API v2 (U.S. Energy Information Administration)
|
|
2
|
+
Depth: standard. Key: optional (EIA_API_KEY; without it api.data.gov's DEMO_KEY, a few requests an
|
|
3
|
+
hour). Electricity, petroleum, natural gas, coal, nuclear, state energy (SEDS), Monthly Energy Review,
|
|
4
|
+
Short-Term and Annual Energy Outlooks, international energy, by period, state, sector and fuel.
|
|
5
|
+
|
|
6
|
+
## When to use
|
|
7
|
+
- Electricity prices, sales, revenue and customers by state and sector; generation and fuel use by
|
|
8
|
+
state and fuel; power-plant emissions; generator capacity.
|
|
9
|
+
- Crude oil (WTI, Brent) and product spot prices; weekly retail gasoline and diesel prices; crude
|
|
10
|
+
production, stocks, imports; natural gas prices, production, consumption; coal production.
|
|
11
|
+
- State energy consumption, production, prices and expenditures per capita or in total (SEDS); U.S.
|
|
12
|
+
totals (Monthly Energy Review, total-energy); projections (STEO, AEO).
|
|
13
|
+
- Not here: the energy component of the CPI (bls), energy industry jobs (bls), energy-related federal
|
|
14
|
+
spending (usaspending), greenhouse-gas inventories beyond energy CO2 (epa), international peers'
|
|
15
|
+
energy use per capita when the World Bank series suffices (world-bank).
|
|
16
|
+
|
|
17
|
+
## Endpoints and datasets
|
|
18
|
+
| Endpoint | Returns | Key parameters |
|
|
19
|
+
|---|---|---|
|
|
20
|
+
| `data` | rows of a leaf route: period, facet columns, data columns, units | `route`, `data`, `facets`, `state`, `msn`, `frequency`, `start`, `end`, `sort` |
|
|
21
|
+
| `routes` | child routes (browse the tree; route "" = top) | `route` |
|
|
22
|
+
| `facets` | facets a route offers | `route` |
|
|
23
|
+
| `facet_values` | values of one facet | `route`, `facet` |
|
|
24
|
+
| `metadata` | one row: frequencies, facets, data columns with units, start/end | `route` |
|
|
25
|
+
|
|
26
|
+
Route aliases (`request_schema` with `search: "words"` finds them): `retail_sales` electricity/retail-sales (price,
|
|
27
|
+
sales, revenue, customers; facets stateid, sectorid RES COM IND TRA OTH ALL), `power_operations`
|
|
28
|
+
(generation by location, sectorid, fueltypeid), `power_emissions_by_state`, `generator_capacity`,
|
|
29
|
+
`seds` (seriesId = MSN code, stateId), `total_energy` (msn), `steo`, `aeo_2026`, `spot_prices`
|
|
30
|
+
petroleum/pri/spt (series RWTC = WTI Cushing, RBRTE = Brent), `gasoline_diesel_retail`
|
|
31
|
+
petroleum/pri/gnd (EMM_EPMR_PTE_NUS_DPG U.S. regular gasoline, EMD_EPD2D_PTE_NUS_DPG U.S. diesel),
|
|
32
|
+
`crude_production`, `petroleum_supply`, `petroleum_stocks_weekly`, `petroleum_imports`,
|
|
33
|
+
`crude_imports_by_origin`, `natural_gas_prices`, `natural_gas_supply`, `natural_gas_production`,
|
|
34
|
+
`natural_gas_consumption`, `coal_production`, `coal_consumption_quality`, `nuclear_outages`,
|
|
35
|
+
`international`, `co2_emissions_aggregates` (deprecated by EIA: use SEDS).
|
|
36
|
+
SEDS codes (catalog): TETCB total consumption, TETPB consumption per capita, TEPRB primary production,
|
|
37
|
+
TETCD average price, TETXB end-use consumption, TPOPP population, ESTCB electricity, CLTCB coal, NNTCB
|
|
38
|
+
natural gas, PATCB petroleum, RETCB renewables, NUETB nuclear, ELISB net interstate electricity flow.
|
|
39
|
+
|
|
40
|
+
## Spec examples
|
|
41
|
+
```json
|
|
42
|
+
{"description": "Residential electricity price, Maryland and U.S., annual 2020-2024",
|
|
43
|
+
"requests": [{"name": "md_res_price", "endpoint": "data",
|
|
44
|
+
"params": {"route": "retail_sales", "state": ["MD", "US"], "facets": {"sectorid": ["RES"]},
|
|
45
|
+
"frequency": "annual", "start": "2020", "end": "2024"}}]}
|
|
46
|
+
```
|
|
47
|
+
```json
|
|
48
|
+
{"description": "Energy consumption per capita by state, 2023 (SEDS)",
|
|
49
|
+
"requests": [{"name": "per_capita_2023", "endpoint": "data",
|
|
50
|
+
"params": {"route": "seds", "msn": "TETPB", "start": "2023", "end": "2023"}, "max_rows": 100}]}
|
|
51
|
+
```
|
|
52
|
+
```json
|
|
53
|
+
{"description": "WTI monthly spot price and weekly U.S. regular gasoline since 2024",
|
|
54
|
+
"requests": [{"name": "wti", "endpoint": "data",
|
|
55
|
+
"params": {"route": "spot_prices", "facets": {"series": ["RWTC"]}, "frequency": "monthly", "start": "2024-01"}},
|
|
56
|
+
{"name": "gasoline", "endpoint": "data",
|
|
57
|
+
"params": {"route": "gasoline_diesel_retail", "facets": {"series": ["EMM_EPMR_PTE_NUS_DPG"]},
|
|
58
|
+
"frequency": "weekly", "start": "2024-01-01"}}]}
|
|
59
|
+
```
|
|
60
|
+
Unknown facet values: `{"name": "f", "endpoint": "facet_values", "params": {"route": "seds", "facet": "seriesId"}}`.
|
|
61
|
+
|
|
62
|
+
## Data format and traps
|
|
63
|
+
- Every row carries its units: `price-units` ("cents per kilowatt-hour"), `units` ("$/BBL", "$/GAL"),
|
|
64
|
+
`unit` ("Million Btu"). Read them; never assume. Prices are nominal dollars.
|
|
65
|
+
- Columns differ by route: retail-sales has `price`, `sales`, `revenue`, `customers` (ask for them in
|
|
66
|
+
`data`); most petroleum and gas routes have `value` with `series`, `duoarea`, `product`, `process`
|
|
67
|
+
descriptions. Values are numbers or numeric text; markers such as "W" (withheld), "NA" or "--"
|
|
68
|
+
become empty cells with a `<column>_flag` column.
|
|
69
|
+
- `period` format follows the frequency: YYYY, YYYY-MM, YYYY-Q1, YYYY-MM-DD (weekly rows are dated by
|
|
70
|
+
the week's day, e.g. Mondays for retail gasoline). `start`/`end` must use the same format;
|
|
71
|
+
the API reads a bare year on a monthly series as January only, so the pack widens `start: 2023` /
|
|
72
|
+
`end: 2023` to the whole year for monthly, quarterly, weekly, daily and hourly data (verified 2026-10).
|
|
73
|
+
- Facet ids are case-sensitive and differ by route: `stateid` (retail-sales, emissions), `stateId`
|
|
74
|
+
(SEDS), `location` (power operations, coal). The pack's `state` fills the right one from the catalog;
|
|
75
|
+
region codes (US, NEW, MAT, PACC ...) are values too. An unknown facet is an HTTP 400 with the valid
|
|
76
|
+
list ("Invalid facet 'x' provided. The only valid facets are ...").
|
|
77
|
+
- Sector "ALL" and region totals ("US") are rows next to the parts: filter before summing.
|
|
78
|
+
- SEDS is annual with a lag (2024 the latest year in October 2026) and is revised each release; per
|
|
79
|
+
capita uses SEDS's own population (TPOPP). Monthly series are revised; the latest months are
|
|
80
|
+
preliminary. The total-energy metadata lists an end period far ahead (2121-12): always set `end`.
|
|
81
|
+
- Paging: `offset`/`length`, at most 5,000 rows per call; `response.total` is the full count. Default
|
|
82
|
+
sort is period descending (newest first); give `"sort": "period:asc"` for oldest first.
|
|
83
|
+
- Routes that do not exist: coal/production (use coal/aggregate-production) and
|
|
84
|
+
nuclear/status-operable-units (use nuclear-outages/us-nuclear-outages). SEDS codes TETCD and TETXB
|
|
85
|
+
are average price and end-use consumption, not per-capita consumption and expenditures.
|
|
86
|
+
|
|
87
|
+
## Access
|
|
88
|
+
Key optional: free at https://www.eia.gov/opendata/register.php (the API runs on api.data.gov, so any
|
|
89
|
+
api.data.gov key works as EIA_API_KEY). Without a key the pack sends DEMO_KEY, which allowed 10
|
|
90
|
+
requests an hour from one address when checked (HTTP 429 beyond); for real work the user stores a key with
|
|
91
|
+
`npx -y data-analyst-mcp setup eia` in their own terminal. `fetch` downloads when api.eia.gov answers (responses
|
|
92
|
+
can take 10-30 seconds).
|
|
93
|
+
Keyless file (when a fetch stops at HTTP 429 on DEMO_KEY, the error carries `keyless_file` and `keyless_files`):
|
|
94
|
+
every petroleum series is also a keyless Excel file,
|
|
95
|
+
`https://www.eia.gov/dnav/pet/hist_xls/<series><d|w|m|a>.xls` (daily, weekly, monthly, annual; e.g.
|
|
96
|
+
`EMM_EPMR_PTE_NUS_DPGm.xls`, `MGFUPUS2m.xls`, `RWTCd.xls`; 30-500 KB; checked 2026-10-30). It covers a
|
|
97
|
+
request of a `petroleum/*` route with `facets: {"series": [one id]}` and no other facet (a series lacks a file
|
|
98
|
+
at a frequency EIA does not publish for it: `MGFUPUS2w.xls` is HTTP 404). Download each `keyless_files` url
|
|
99
|
+
under its filename and call `ingest` with the same spec and those files: it keeps the request's dates and
|
|
100
|
+
records the route as `keyless_file`. Ingested rows have `period`, `series`, `series-description`, `value`, `units`
|
|
101
|
+
only: `units` is the file's wording ("Dollars per Gallon" where the API says "$/GAL"), and the duoarea,
|
|
102
|
+
product and process columns are absent. Periods follow the API's formats (the file dates monthly rows the
|
|
103
|
+
15th and annual rows July 1; the pack keeps YYYY-MM and YYYY). Manual route (`manual_bundle`):
|
|
104
|
+
`manual_download/INSTRUCTIONS.md` has one JSON link per 5,000 rows carrying DEMO_KEY (replace it with
|
|
105
|
+
your key if the hourly limit is hit); upload, then `ingest`. Alternatives: the API browser
|
|
106
|
+
https://www.eia.gov/opendata/browser/ (CSV/Excel download) or the data pages on eia.gov.
|
|
107
|
+
|
|
108
|
+
## Citation and terms
|
|
109
|
+
"U.S. Energy Information Administration, <series or route description>, EIA Open Data API v2,
|
|
110
|
+
retrieved <date>." Data from a keyless file cite "Petroleum & Other Liquids data series history
|
|
111
|
+
(www.eia.gov/dnav/pet)" instead of the API: data/eia/README.md and the report's citation do so when
|
|
112
|
+
request.json's route is `keyless_file`. Public domain; EIA asks to be cited as the source. Redistribution allowed.
|
|
@@ -0,0 +1,292 @@
|
|
|
1
|
+
{
|
|
2
|
+
"base_url": "https://data.epa.gov/dmapservice",
|
|
3
|
+
"endpoints": {
|
|
4
|
+
"envirofacts": {
|
|
5
|
+
"path": "/{table}",
|
|
6
|
+
"kind": "dmap",
|
|
7
|
+
"description": "Any Envirofacts table (DMAP): TRI, GHGRP, SDWIS, SEMS/Superfund, RCRAInfo, FRS ... filtered by column values.",
|
|
8
|
+
"params": {
|
|
9
|
+
"table": {
|
|
10
|
+
"in": "path",
|
|
11
|
+
"required": true,
|
|
12
|
+
"catalog": true,
|
|
13
|
+
"desc": "catalog alias (tri_facility, ghg_emitters, sdwis_systems ...) or schema.table"
|
|
14
|
+
},
|
|
15
|
+
"filters": {
|
|
16
|
+
"desc": "{\"column\": \"value\"} for equals, or [[column, operator, value], ...]; operators: equals, notEquals, lessThan, greaterThan, greaterThanEqual, beginsWith, endsWith, contains"
|
|
17
|
+
}
|
|
18
|
+
},
|
|
19
|
+
"records": "",
|
|
20
|
+
"paging": {
|
|
21
|
+
"type": "none",
|
|
22
|
+
"size": 5000
|
|
23
|
+
},
|
|
24
|
+
"max_rows": 200000,
|
|
25
|
+
"method": "GET",
|
|
26
|
+
"missing": [
|
|
27
|
+
""
|
|
28
|
+
],
|
|
29
|
+
"flatten": true
|
|
30
|
+
},
|
|
31
|
+
"uv_daily": {
|
|
32
|
+
"path": "/getEnvirofactsUVDAILY/ZIP/{zip}/JSON",
|
|
33
|
+
"description": "Today's UV index forecast for a ZIP code (forecast, not history).",
|
|
34
|
+
"params": {
|
|
35
|
+
"zip": {
|
|
36
|
+
"in": "path",
|
|
37
|
+
"required": true,
|
|
38
|
+
"desc": "5-digit ZIP"
|
|
39
|
+
}
|
|
40
|
+
},
|
|
41
|
+
"records": "",
|
|
42
|
+
"paging": {
|
|
43
|
+
"type": "none"
|
|
44
|
+
},
|
|
45
|
+
"method": "GET",
|
|
46
|
+
"missing": [
|
|
47
|
+
""
|
|
48
|
+
],
|
|
49
|
+
"flatten": true
|
|
50
|
+
},
|
|
51
|
+
"uv_daily_city": {
|
|
52
|
+
"path": "/getEnvirofactsUVDAILY/CITY/{city}/STATE/{state}/JSON",
|
|
53
|
+
"description": "Today's UV index forecast for a city.",
|
|
54
|
+
"params": {
|
|
55
|
+
"city": {
|
|
56
|
+
"in": "path",
|
|
57
|
+
"required": true,
|
|
58
|
+
"desc": "city name"
|
|
59
|
+
},
|
|
60
|
+
"state": {
|
|
61
|
+
"in": "path",
|
|
62
|
+
"required": true,
|
|
63
|
+
"desc": "two-letter state code"
|
|
64
|
+
}
|
|
65
|
+
},
|
|
66
|
+
"records": "",
|
|
67
|
+
"paging": {
|
|
68
|
+
"type": "none"
|
|
69
|
+
},
|
|
70
|
+
"method": "GET",
|
|
71
|
+
"missing": [
|
|
72
|
+
""
|
|
73
|
+
],
|
|
74
|
+
"flatten": true
|
|
75
|
+
},
|
|
76
|
+
"uv_hourly": {
|
|
77
|
+
"path": "/getEnvirofactsUVHOURLY/ZIP/{zip}/JSON",
|
|
78
|
+
"description": "Today's hourly UV index forecast for a ZIP code.",
|
|
79
|
+
"params": {
|
|
80
|
+
"zip": {
|
|
81
|
+
"in": "path",
|
|
82
|
+
"required": true,
|
|
83
|
+
"desc": "5-digit ZIP"
|
|
84
|
+
}
|
|
85
|
+
},
|
|
86
|
+
"records": "",
|
|
87
|
+
"paging": {
|
|
88
|
+
"type": "none"
|
|
89
|
+
},
|
|
90
|
+
"method": "GET",
|
|
91
|
+
"missing": [
|
|
92
|
+
""
|
|
93
|
+
],
|
|
94
|
+
"flatten": true
|
|
95
|
+
},
|
|
96
|
+
"echo_facilities": {
|
|
97
|
+
"path": "https://echodata.epa.gov/echo/{program}_rest_services.get_facilities",
|
|
98
|
+
"kind": "echo",
|
|
99
|
+
"description": "ECHO facility compliance search (two steps: query, then pages of rows): air (CAA), cwa (CWA/NPDES), rcra (hazardous waste), sdw (drinking water systems), echo (all programs).",
|
|
100
|
+
"params": {
|
|
101
|
+
"program": {
|
|
102
|
+
"in": "path",
|
|
103
|
+
"required": true,
|
|
104
|
+
"enum": [
|
|
105
|
+
"air",
|
|
106
|
+
"cwa",
|
|
107
|
+
"rcra",
|
|
108
|
+
"sdw",
|
|
109
|
+
"echo"
|
|
110
|
+
],
|
|
111
|
+
"desc": "air, cwa, rcra, sdw or echo"
|
|
112
|
+
},
|
|
113
|
+
"p_st": {
|
|
114
|
+
"desc": "state code, e.g. TX"
|
|
115
|
+
},
|
|
116
|
+
"p_co": {
|
|
117
|
+
"desc": "county name, with p_st (returns 0 rows for program air, verified 2026-10: use p_fips there)"
|
|
118
|
+
},
|
|
119
|
+
"p_fips": {
|
|
120
|
+
"desc": "5-digit state+county FIPS, e.g. 35015 (air, cwa, rcra, echo)"
|
|
121
|
+
},
|
|
122
|
+
"p_ct": {
|
|
123
|
+
"desc": "city"
|
|
124
|
+
},
|
|
125
|
+
"p_zip": {
|
|
126
|
+
"desc": "5-digit ZIP"
|
|
127
|
+
},
|
|
128
|
+
"p_fn": {
|
|
129
|
+
"desc": "facility name (contains)"
|
|
130
|
+
},
|
|
131
|
+
"p_act": {
|
|
132
|
+
"desc": "Y: active facilities only"
|
|
133
|
+
},
|
|
134
|
+
"p_maj": {
|
|
135
|
+
"desc": "Y: major facilities only (air, cwa)"
|
|
136
|
+
},
|
|
137
|
+
"p_ncs": {
|
|
138
|
+
"desc": "NAICS code, 2 to 6 digits (shorter matches every code it begins; p_naics is ignored by ECHO)"
|
|
139
|
+
},
|
|
140
|
+
"p_sic": {
|
|
141
|
+
"desc": "SIC code"
|
|
142
|
+
},
|
|
143
|
+
"p_qiv": {
|
|
144
|
+
"desc": "quarters in violation, e.g. GT4"
|
|
145
|
+
},
|
|
146
|
+
"p_impw": {
|
|
147
|
+
"desc": "cwa: Y impaired waters"
|
|
148
|
+
},
|
|
149
|
+
"p_pen": {
|
|
150
|
+
"desc": "penalty range"
|
|
151
|
+
},
|
|
152
|
+
"qcolumns": {
|
|
153
|
+
"desc": "comma-separated column ids to return (ids: <program>_rest_services.metadata?output=JSON, ResultColumns); sent to the search and to every get_qid page"
|
|
154
|
+
}
|
|
155
|
+
},
|
|
156
|
+
"records": "Facilities",
|
|
157
|
+
"paging": {
|
|
158
|
+
"type": "none",
|
|
159
|
+
"size": 1000
|
|
160
|
+
},
|
|
161
|
+
"max_rows": 100000,
|
|
162
|
+
"method": "GET",
|
|
163
|
+
"missing": [
|
|
164
|
+
""
|
|
165
|
+
],
|
|
166
|
+
"flatten": true
|
|
167
|
+
},
|
|
168
|
+
"echo_cases": {
|
|
169
|
+
"path": "https://echodata.epa.gov/echo/case_rest_services.get_case_info",
|
|
170
|
+
"kind": "echo",
|
|
171
|
+
"description": "EPA civil and criminal enforcement cases (ICIS): penalties, settlements, outcomes (two steps like echo_facilities).",
|
|
172
|
+
"params": {
|
|
173
|
+
"p_state": {
|
|
174
|
+
"desc": "state code (note: p_state here, p_st is ignored)"
|
|
175
|
+
},
|
|
176
|
+
"p_law": {
|
|
177
|
+
"desc": "CAA, CWA, RCRA, SDWA, CERCLA, EPCRA, TSCA, FIFRA"
|
|
178
|
+
},
|
|
179
|
+
"p_case_category": {
|
|
180
|
+
"desc": "JDC judicial, AFR administrative formal ..."
|
|
181
|
+
},
|
|
182
|
+
"p_case_status": {
|
|
183
|
+
"desc": "case status code(s), comma-separated: CLS closed, CNC concluded, FOI final order issued, CFL complaint filed ... (codes, not words: Closed matches nothing)"
|
|
184
|
+
},
|
|
185
|
+
"p_milestone_fy": {
|
|
186
|
+
"desc": "one fiscal year: cases with an administrative or judicial milestone in that FY (p_fy is ignored by ECHO)"
|
|
187
|
+
},
|
|
188
|
+
"p_milestone": {
|
|
189
|
+
"desc": "milestone code(s) to go with p_milestone_fy (codes are not listed in ECHO's service description; unverified)"
|
|
190
|
+
},
|
|
191
|
+
"p_civil_criminal_indicator": {
|
|
192
|
+
"desc": "CI civil, CR criminal, ALL both (p_crim is ignored by ECHO)",
|
|
193
|
+
"enum": [
|
|
194
|
+
"CI",
|
|
195
|
+
"CR",
|
|
196
|
+
"ALL"
|
|
197
|
+
]
|
|
198
|
+
},
|
|
199
|
+
"p_fed_penalty": {
|
|
200
|
+
"desc": "federal penalty assessed: ANY, LE5000, GT5000, GT50000, GT100000, GT500000, GT1000000, GT2500000",
|
|
201
|
+
"enum": [
|
|
202
|
+
"ANY",
|
|
203
|
+
"LE5000",
|
|
204
|
+
"GT5000",
|
|
205
|
+
"GT50000",
|
|
206
|
+
"GT100000",
|
|
207
|
+
"GT500000",
|
|
208
|
+
"GT1000000",
|
|
209
|
+
"GT2500000"
|
|
210
|
+
]
|
|
211
|
+
}
|
|
212
|
+
},
|
|
213
|
+
"records": "Cases",
|
|
214
|
+
"paging": {
|
|
215
|
+
"type": "none",
|
|
216
|
+
"size": 1000
|
|
217
|
+
},
|
|
218
|
+
"max_rows": 100000,
|
|
219
|
+
"method": "GET",
|
|
220
|
+
"missing": [
|
|
221
|
+
""
|
|
222
|
+
],
|
|
223
|
+
"flatten": true
|
|
224
|
+
},
|
|
225
|
+
"echo_facility_detail": {
|
|
226
|
+
"path": "https://echodata.epa.gov/echo/dfr_rest_services.get_dfr",
|
|
227
|
+
"description": "Detailed Facility Report for one FRS registry id: permits, inspections, violations, enforcement (one row; sections as JSON text).",
|
|
228
|
+
"params": {
|
|
229
|
+
"p_id": {
|
|
230
|
+
"required": true,
|
|
231
|
+
"desc": "FRS RegistryID, e.g. 110008205307"
|
|
232
|
+
}
|
|
233
|
+
},
|
|
234
|
+
"defaults": {
|
|
235
|
+
"output": "JSON"
|
|
236
|
+
},
|
|
237
|
+
"records": "Results",
|
|
238
|
+
"paging": {
|
|
239
|
+
"type": "none"
|
|
240
|
+
},
|
|
241
|
+
"method": "GET",
|
|
242
|
+
"missing": [
|
|
243
|
+
""
|
|
244
|
+
],
|
|
245
|
+
"flatten": true
|
|
246
|
+
}
|
|
247
|
+
},
|
|
248
|
+
"catalog": {
|
|
249
|
+
"tri_facility": {
|
|
250
|
+
"id": "tri.tri_facility",
|
|
251
|
+
"name": "tri.tri_facility",
|
|
252
|
+
"description": "TRI reporting facilities: name, address, county, parent company, FRS id (useful filter columns: state_abbr, county_name)",
|
|
253
|
+
"endpoint": "envirofacts"
|
|
254
|
+
},
|
|
255
|
+
"tri_reporting_form": {
|
|
256
|
+
"id": "tri.tri_reporting_form",
|
|
257
|
+
"name": "tri.tri_reporting_form",
|
|
258
|
+
"description": "TRI Form R/A submissions: chemical, reporting year, facility (doc_ctrl_num links releases) (useful filter columns: reporting_year, tri_facility_id, cas_chem_name)",
|
|
259
|
+
"endpoint": "envirofacts"
|
|
260
|
+
},
|
|
261
|
+
"tri_release_qty": {
|
|
262
|
+
"id": "tri.tri_release_qty",
|
|
263
|
+
"name": "tri.tri_release_qty",
|
|
264
|
+
"description": "TRI release quantities by environmental medium per form (doc_ctrl_num) (useful filter columns: doc_ctrl_num, environmental_medium)",
|
|
265
|
+
"endpoint": "envirofacts"
|
|
266
|
+
},
|
|
267
|
+
"ghg_emitters": {
|
|
268
|
+
"id": "ghg.ghg_emitter_sector",
|
|
269
|
+
"name": "ghg.ghg_emitter_sector",
|
|
270
|
+
"description": "GHGRP large emitters: facility, sector, gas, CO2e emissions (metric tons) by year (useful filter columns: state, year, sector_name, gas_code)",
|
|
271
|
+
"endpoint": "envirofacts"
|
|
272
|
+
},
|
|
273
|
+
"sdwis_systems": {
|
|
274
|
+
"id": "sdwis.water_system",
|
|
275
|
+
"name": "sdwis.water_system",
|
|
276
|
+
"description": "SDWIS public water systems: type (CWS, NTNCWS, TNCWS), population served, source, activity (useful filter columns: state_code, primacy_agency_code, pws_type_code)",
|
|
277
|
+
"endpoint": "envirofacts"
|
|
278
|
+
},
|
|
279
|
+
"sdwis_violations": {
|
|
280
|
+
"id": "sdwis.violation",
|
|
281
|
+
"name": "sdwis.violation",
|
|
282
|
+
"description": "SDWIS drinking water violations: rule, contaminant, health-based flag, compliance period (useful filter columns: primacy_agency_code, pwsid, is_health_based_ind)",
|
|
283
|
+
"endpoint": "envirofacts"
|
|
284
|
+
},
|
|
285
|
+
"superfund_sites": {
|
|
286
|
+
"id": "sems.envirofacts_site",
|
|
287
|
+
"name": "sems.envirofacts_site",
|
|
288
|
+
"description": "SEMS Superfund (CERCLA) sites: NPL status, location, federal facility flag (useful filter columns: fk_ref_state_code, npl_status_code)",
|
|
289
|
+
"endpoint": "envirofacts"
|
|
290
|
+
}
|
|
291
|
+
}
|
|
292
|
+
}
|
|
@@ -0,0 +1,99 @@
|
|
|
1
|
+
{
|
|
2
|
+
"id": "epa",
|
|
3
|
+
"title": "EPA Envirofacts and ECHO (TRI, GHGRP, SDWIS, Superfund, compliance and enforcement)",
|
|
4
|
+
"agency": "U.S. Environmental Protection Agency",
|
|
5
|
+
"depth": "standard",
|
|
6
|
+
"domains": [
|
|
7
|
+
"environment",
|
|
8
|
+
"pollution",
|
|
9
|
+
"regulation",
|
|
10
|
+
"enforcement"
|
|
11
|
+
],
|
|
12
|
+
"keywords": [
|
|
13
|
+
"epa",
|
|
14
|
+
"toxics release inventory",
|
|
15
|
+
"tri",
|
|
16
|
+
"toxic release",
|
|
17
|
+
"chemical release",
|
|
18
|
+
"greenhouse gas",
|
|
19
|
+
"ghgrp",
|
|
20
|
+
"emissions",
|
|
21
|
+
"co2e",
|
|
22
|
+
"large emitters",
|
|
23
|
+
"drinking water",
|
|
24
|
+
"water system",
|
|
25
|
+
"sdwis",
|
|
26
|
+
"drinking water violation",
|
|
27
|
+
"superfund",
|
|
28
|
+
"cercla",
|
|
29
|
+
"npl",
|
|
30
|
+
"hazardous waste",
|
|
31
|
+
"rcra",
|
|
32
|
+
"echo",
|
|
33
|
+
"compliance",
|
|
34
|
+
"violation",
|
|
35
|
+
"enforcement case",
|
|
36
|
+
"penalty",
|
|
37
|
+
"clean air act",
|
|
38
|
+
"clean water act",
|
|
39
|
+
"npdes",
|
|
40
|
+
"uv index",
|
|
41
|
+
"envirofacts"
|
|
42
|
+
],
|
|
43
|
+
"questions": [
|
|
44
|
+
"largest greenhouse gas emitters in a state",
|
|
45
|
+
"TRI facilities in a county",
|
|
46
|
+
"Superfund sites on the National Priorities List in a state",
|
|
47
|
+
"drinking water violations in a state",
|
|
48
|
+
"EPA enforcement cases and penalties under the Clean Air Act in a state",
|
|
49
|
+
"major air facilities with violations"
|
|
50
|
+
],
|
|
51
|
+
"homepage": "https://www.epa.gov/enviro",
|
|
52
|
+
"terms_url": "https://www.epa.gov/web-policies-and-procedures/epa-disclaimers",
|
|
53
|
+
"auth": {
|
|
54
|
+
"env": null,
|
|
55
|
+
"required": "none",
|
|
56
|
+
"placement": "none",
|
|
57
|
+
"signup_url": null,
|
|
58
|
+
"echoes_key": false
|
|
59
|
+
},
|
|
60
|
+
"limits": {
|
|
61
|
+
"rps": 2,
|
|
62
|
+
"burst": 4,
|
|
63
|
+
"max_rows": 200000
|
|
64
|
+
},
|
|
65
|
+
"routes": {
|
|
66
|
+
"api": {
|
|
67
|
+
"base": "https://data.epa.gov/dmapservice",
|
|
68
|
+
"probe": "https://data.epa.gov/dmapservice/sems.envirofacts_site/fk_ref_state_code/equals/VT/1:1/JSON",
|
|
69
|
+
"hosts": [
|
|
70
|
+
"data.epa.gov",
|
|
71
|
+
"echodata.epa.gov"
|
|
72
|
+
]
|
|
73
|
+
},
|
|
74
|
+
"manual": {
|
|
75
|
+
"how": "Open each link in manual_download/INSTRUCTIONS.md in a browser: Envirofacts links return CSV pages of 5,000 rows; ECHO links take two steps (the first returns a QueryID, then open the get_qid link with it). Save each file under the name shown and upload. Without the links: Envirofacts at https://enviro.epa.gov (search, then download CSV); ECHO at https://echo.epa.gov/facilities/facility-search and https://echo.epa.gov/facilities/enforcement-case-search (Download Data); TRI and GHGRP full-year files at https://www.epa.gov/toxics-release-inventory-tri-program/tri-basic-data-files-calendar-years-1987-present and https://www.epa.gov/ghgreporting/data-sets."
|
|
76
|
+
}
|
|
77
|
+
},
|
|
78
|
+
"cache": {
|
|
79
|
+
"mode": "run_only",
|
|
80
|
+
"ttl_hours": null,
|
|
81
|
+
"why": "ECHO refreshes weekly and SDWIS quarterly; data/ is reused only within a run."
|
|
82
|
+
},
|
|
83
|
+
"redistribution": {
|
|
84
|
+
"mode": "allowed",
|
|
85
|
+
"why": "EPA data are U.S. government works in the public domain (17 U.S.C. 105; https://www.epa.gov/web-policies-and-procedures/epa-disclaimers); cite EPA and do not imply endorsement."
|
|
86
|
+
},
|
|
87
|
+
"notices": [],
|
|
88
|
+
"retention": null,
|
|
89
|
+
"citation": "U.S. Environmental Protection Agency, {dataset}, Envirofacts (data.epa.gov) / ECHO (echo.epa.gov), retrieved {retrieved_long}.",
|
|
90
|
+
"audit_hooks": [],
|
|
91
|
+
"clarify": [
|
|
92
|
+
"Which reporting year? TRI and GHGRP publish one year at a time with a lag of about 10 months; say the year used.",
|
|
93
|
+
"Facilities or emissions? GHGRP rows are facility x gas x year; sum CO2e over gases for facility totals."
|
|
94
|
+
],
|
|
95
|
+
"formats": [
|
|
96
|
+
"json",
|
|
97
|
+
"csv"
|
|
98
|
+
]
|
|
99
|
+
}
|