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,136 @@
|
|
|
1
|
+
# Medicaid and CHIP open data (data.medicaid.gov)
|
|
2
|
+
Depth: standard. Key: none. CMS's Medicaid and CHIP datasets: monthly enrollment by state, expansion (new adult
|
|
3
|
+
group) enrollment, renewals, managed care, CMS-64 expenditure extracts, State Drug Utilization Data and NADAC drug
|
|
4
|
+
prices.
|
|
5
|
+
|
|
6
|
+
## When to use
|
|
7
|
+
- National or state Medicaid and CHIP enrollment (the monthly enrollment report numbers), ACA expansion adults,
|
|
8
|
+
unwinding-era renewals and disenrollments, managed care penetration, the federal share of expansion and
|
|
9
|
+
FFCRA/CAA 2023 increased-FMAP spending by quarter, Medicaid outpatient drug spending by drug and state, and
|
|
10
|
+
pharmacy acquisition costs (NADAC).
|
|
11
|
+
- Not here: Medicare, hospitals and nursing homes (cms); national health expenditure accounts and Medicaid
|
|
12
|
+
outlays in the federal budget (treasury, usaspending); Medicaid coverage rates from surveys (census ACS/CPS).
|
|
13
|
+
Current CMS-64 expenditure reports (fiscal years after 2016) are not in this API: see Access.
|
|
14
|
+
|
|
15
|
+
## Endpoints and datasets
|
|
16
|
+
Base `https://data.medicaid.gov`, DKAN, keyless, JSON (verified live 2026-10-30). One CSV per request.
|
|
17
|
+
|
|
18
|
+
| Endpoint | Returns | Key parameters |
|
|
19
|
+
|---|---|---|
|
|
20
|
+
| `query` | rows of one dataset (`/api/1/datastore/query/{dataset}/0`), 5,000 per page, all pages | `dataset` (alias or id), `conditions[i][property]`, `conditions[i][value]`, `conditions[i][operator]` (i = 0-3), `conditions[0][value][0..9]` (a list for `in`), `sorts[i][property]` and `sorts[i][order]` (i = 0-1), `properties[0..11]` (columns to return) |
|
|
21
|
+
| `datasets` | the whole catalog, one row per dataset (about 560): `identifier`, `title`, `modified`, `theme`, `distribution` | none |
|
|
22
|
+
| `dataset_info` | one dataset's metadata: `modified`, `description`, download URL, data dictionary link | `dataset` |
|
|
23
|
+
|
|
24
|
+
Catalog aliases (`request_schema` with `search: "<words>"` lists them with descriptions; `datasets` lists every id):
|
|
25
|
+
|
|
26
|
+
| Alias | Dataset | Grain, coverage |
|
|
27
|
+
|---|---|---|
|
|
28
|
+
| `enrollment` | Applications, Eligibility Determinations, and Enrollment (Performance Indicator) | state x month, 2013-09 to latest (202607 on 2026-10-30) |
|
|
29
|
+
| `eligibility_processing`, `renewal_outcomes_updated` | renewals, ex parte, procedural disenrollment | state x month, 2023-03 on |
|
|
30
|
+
| `chip_enrollment`, `chip_enrollment_historic` | separate CHIP enrollment (T-MSIS) | state x coverage month, 2023-04 on; lags (latest 202603, T-MSIS data through 202606, on 2026-10-30) |
|
|
31
|
+
| `new_adult` | Medicaid and expansion (VIII group) enrollees | state x month |
|
|
32
|
+
| `eligibility_group_monthly`, `managed_care_monthly` | T-MSIS (TAF) enrollees by eligibility group or managed care type, with a data-quality flag `dunusable` | state x month, 2016 on |
|
|
33
|
+
| `managed_care_summary`, `managed_care_share`, `managed_care_plans`, `managed_care_population`, `mltss` | managed care enrollment (as of July 1) | state (or plan) x year, 2016 on |
|
|
34
|
+
| `cms64_new_adult`, `cms64_ffcra`, `cms64_caa2023` | quarterly CMS-64 expenditures, total computable and federal share | state x quarter (`quarter_end_date`) |
|
|
35
|
+
| `cms64_fmr`, `cms64_fmr_national` | CMS-64 Financial Management Report by service category | fiscal year 2016 ONLY |
|
|
36
|
+
| `sdud_2020` ... `sdud_2026` | State Drug Utilization Data | state x NDC x quarter x utilization type; 1.3 million rows a year |
|
|
37
|
+
| `nadac_2024`, `nadac_2025`, `nadac_2026`, `nadac_comparison`, `nadac_first_time` | NADAC per unit, weekly | NDC x effective date; 1.3 million rows a year |
|
|
38
|
+
| `eligibility_levels` | income limits as % of poverty | state; 2018, not updated |
|
|
39
|
+
|
|
40
|
+
Columns of `enrollment` (snake_case, as in the rows): `state_abbreviation`, `state_name`, `reporting_period`
|
|
41
|
+
(YYYYMM, int), `state_expanded_medicaid` (Y/N), `preliminary_or_updated` (P/U), `final_report` (Y/N),
|
|
42
|
+
`total_medicaid_and_chip_enrollment`, `total_medicaid_enrollment`, `total_chip_enrollment`,
|
|
43
|
+
`medicaid_and_chip_child_enrollment`, `total_adult_medicaid_enrollment`, `new_applications_submitted_to_medicaid_and_chip_agencies`,
|
|
44
|
+
`total_medicaid_and_chip_determinations`, call-center columns, each with a `..__footnotes` text column. To see any
|
|
45
|
+
dataset's columns and types, fetch one row with `"max_rows": 1`, or open `https://data.medicaid.gov/api/1/datastore/query/<id>/0?limit=1&schema=true`.
|
|
46
|
+
|
|
47
|
+
## Spec examples
|
|
48
|
+
```json
|
|
49
|
+
{"description": "Medicaid and CHIP enrollment by state, July 2026 (latest, preliminary)",
|
|
50
|
+
"requests": [{"name": "enroll_202607", "endpoint": "query",
|
|
51
|
+
"params": {"dataset": "enrollment", "conditions[0][property]": "reporting_period", "conditions[0][value]": "202607",
|
|
52
|
+
"properties[0]": "state_abbreviation", "properties[1]": "reporting_period", "properties[2]": "preliminary_or_updated",
|
|
53
|
+
"properties[3]": "total_medicaid_and_chip_enrollment", "properties[4]": "total_medicaid_enrollment",
|
|
54
|
+
"properties[5]": "total_chip_enrollment", "properties[6]": "total_medicaid_and_chip_enrollment__footnotes"}}]}
|
|
55
|
+
```
|
|
56
|
+
```json
|
|
57
|
+
{"description": "Vermont and New Hampshire, updated reports since January 2026, newest first",
|
|
58
|
+
"requests": [{"name": "vt_nh", "endpoint": "query",
|
|
59
|
+
"params": {"dataset": "enrollment",
|
|
60
|
+
"conditions[0][property]": "state_abbreviation", "conditions[0][operator]": "in",
|
|
61
|
+
"conditions[0][value][0]": "VT", "conditions[0][value][1]": "NH",
|
|
62
|
+
"conditions[1][property]": "reporting_period", "conditions[1][operator]": ">=", "conditions[1][value]": "202601",
|
|
63
|
+
"conditions[2][property]": "preliminary_or_updated", "conditions[2][value]": "U",
|
|
64
|
+
"sorts[0][property]": "reporting_period", "sorts[0][order]": "desc"}}]}
|
|
65
|
+
```
|
|
66
|
+
```json
|
|
67
|
+
{"description": "Trulicity, national totals (state XX), 2025 Q4; Vermont expansion spending by quarter",
|
|
68
|
+
"requests": [
|
|
69
|
+
{"name": "trulicity", "endpoint": "query",
|
|
70
|
+
"params": {"dataset": "sdud_2025", "conditions[0][property]": "state", "conditions[0][value]": "XX",
|
|
71
|
+
"conditions[1][property]": "product_name", "conditions[1][operator]": "like", "conditions[1][value]": "TRULICITY%",
|
|
72
|
+
"conditions[2][property]": "quarter", "conditions[2][value]": "4"}},
|
|
73
|
+
{"name": "vt_expansion", "endpoint": "query",
|
|
74
|
+
"params": {"dataset": "cms64_new_adult", "conditions[0][property]": "state", "conditions[0][value]": "Vermont"}}]}
|
|
75
|
+
```
|
|
76
|
+
The bracketed names are plain query keys, sent as written (URL-encoded). Number the conditions from 0 with no gap.
|
|
77
|
+
|
|
78
|
+
## Data format and traps
|
|
79
|
+
- Enrollment is a point-in-time monthly count, not people ever enrolled in the month or year. Footnote columns
|
|
80
|
+
say when a state reports differently, e.g. "Includes Individuals Enrolled At Any Time in Month (Not a
|
|
81
|
+
Point-in-Time Count)" (MT, OH, WV in 2026-07) or "Includes Retroactive Enrollments" (HI, NH). Carry footnotes
|
|
82
|
+
into the answer when a state is singled out.
|
|
83
|
+
- Every state-month has TWO rows, preliminary (`P`, `final_report` N) and updated (`U`, `final_report` Y), except
|
|
84
|
+
the latest month, which has only P. Summing a month without filtering on `preliminary_or_updated` doubles it.
|
|
85
|
+
The monthly enrollment report's national total is the sum of the 51 rows (50 states and DC; no national row) of
|
|
86
|
+
one month and one type: 2026-07 P = 72,946,510 total, 65,742,057 Medicaid, 7,204,453 CHIP (matches the
|
|
87
|
+
Medicaid.gov report highlights, verified 2026-10-30). Updated counts run higher than preliminary (2025-06:
|
|
88
|
+
78,223,314 U vs 77,776,382 P). For a time series use U rows and add the latest P month, labeled preliminary.
|
|
89
|
+
- `total_medicaid_and_chip_enrollment` includes CHIP: Medicaid only is `total_medicaid_enrollment`. CHIP in
|
|
90
|
+
`enrollment` is all CHIP; `chip_enrollment` is separate CHIP only, from T-MSIS, so it is much smaller (Alabama
|
|
91
|
+
2023-04: 205,859 in `enrollment` vs 70,995 separate CHIP): never mix the two. Adult and child columns are blank
|
|
92
|
+
for some states and months; do not sum them to a national total without checking for blanks.
|
|
93
|
+
- Columns are typed per dataset: `reporting_period`, enrollment counts and SDUD numbers are int/numeric, so
|
|
94
|
+
`<`, `>=`, `between` and sorts are numeric there. Many other datasets store numbers as text (CMS-64,
|
|
95
|
+
managed care, `new_adult`, NADAC comparison): `<`/`>` and sorts on them compare characters ('91' > '100'),
|
|
96
|
+
and values carry thousands separators ("374,032,607", sometimes with a trailing space), `N/A`, `n/a` or `--`
|
|
97
|
+
(not applicable or not reported). Fetch with equality filters and convert in analysis; never compare such
|
|
98
|
+
columns in a condition.
|
|
99
|
+
- Filters match without case ("vermont" finds Vermont). `in` needs `conditions[0][value][0]`, `[1]`, ...: one
|
|
100
|
+
value "VT,NH" matches nothing and comes back as no rows. A column that does not exist answers HTTP 400
|
|
101
|
+
"Column not found." without naming it: check spelling against one fetched row.
|
|
102
|
+
- Managed care tables use state names with footnote digits glued on ("Arkansas6") and a `TOTALS` row; filter with
|
|
103
|
+
`like` ("Arkansas%") or clean names in analysis. Their counts are as of July 1 of `year`, and some states report
|
|
104
|
+
other dates (see `notes`).
|
|
105
|
+
- CMS-64: `cms64_fmr` and `cms64_fmr_national` hold fiscal year 2016 only (every row's `year` is 2016, verified
|
|
106
|
+
2026-10-30); never present them as current. Federal fiscal years run October-September; the quarterly datasets
|
|
107
|
+
give `quarter_end_date` (2014-03-31 is FY2014 Q2). Total computable = federal share + state share; the federal
|
|
108
|
+
share depends on the FMAP, the 90% expansion match (`newly_eligible`) and temporary increases (FFCRA 6.2 points
|
|
109
|
+
from January 2020, phased down by CAA 2023 through December 2023). CMS-64 amounts are dates of payment, net of adjustments for
|
|
110
|
+
prior periods, so a quarter can be negative or lumpy.
|
|
111
|
+
- SDUD: state `XX` is the national total; `utilization_type` FFSU (fee-for-service) and MCOU (managed care) are
|
|
112
|
+
separate rows (add them for a state total). Cells with fewer than 11 prescriptions are suppressed:
|
|
113
|
+
`suppression_used` true and empty counts and dollars, so sums are lower bounds. `product_name` is cut to 10
|
|
114
|
+
characters and padded with spaces ("TRULICITY "): filter with `like` and %. `units_reimbursed` is in the drug's
|
|
115
|
+
own units (tablets, mL, each), not prescriptions. `total_amount_reimbursed` is before manufacturer rebates
|
|
116
|
+
(Medicaid's net cost is lower; rebates are confidential). The latest quarters are revised for months.
|
|
117
|
+
- NADAC: dollars per `pricing_unit` (EA, ML, GM), one row per NDC per weekly `as_of_date`; the value applies from
|
|
118
|
+
`effective_date`. The yearly datasets are 1.3 million rows: always filter by `ndc` or `ndc_description` (`like`).
|
|
119
|
+
- Paging: 5,000 rows a page, offset paging until `count`; the API refuses a page over 8,000. A whole SDUD or NADAC
|
|
120
|
+
year is over a million rows: filter, or the fetch stops at `max_rows` (and says so).
|
|
121
|
+
|
|
122
|
+
## Access
|
|
123
|
+
No key; data.medicaid.gov answers scripts (verified 2026-10-30). Limit used: two requests per second. `fetch`
|
|
124
|
+
downloads directly. Manual (`manual_bundle`): the links in `manual_download/INSTRUCTIONS.md` are the same queries
|
|
125
|
+
as JSON pages of up to 8,000 rows (save each, upload, then `ingest`); or the dataset page
|
|
126
|
+
`https://data.medicaid.gov/dataset/<id>` (Download = full CSV with display-style column names; upload it as CSV), or `https://data.medicaid.gov/api/1/datastore/query/<id>/0/download?format=csv`
|
|
127
|
+
(full CSV; takes the same `conditions[...]` filters).
|
|
128
|
+
Current CMS-64 Financial Management Reports (FY 1997-2024, zip files of Excel workbooks) are only on
|
|
129
|
+
https://www.medicaid.gov/medicaid/financial-management/state-expenditure-reporting-for-medicaid-chip/expenditure-reports-mbescbes,
|
|
130
|
+
which answers HTTP 403 to scripts: the user downloads them in a browser and the assistant reads the uploaded
|
|
131
|
+
workbook. The monthly enrollment report PDFs and highlights are on www.medicaid.gov too (browser only).
|
|
132
|
+
|
|
133
|
+
## Citation and terms
|
|
134
|
+
Centers for Medicare & Medicaid Services, <dataset name>, data.medicaid.gov, retrieved <date>. Public domain
|
|
135
|
+
(U.S. Public Domain label on every dataset; 17 U.S.C. 105): redistribution allowed. Name the dataset and say
|
|
136
|
+
whether enrollment counts are preliminary or updated.
|
|
@@ -0,0 +1,217 @@
|
|
|
1
|
+
{
|
|
2
|
+
"base_url": "https://www.nationsreportcard.gov",
|
|
3
|
+
"endpoints": {
|
|
4
|
+
"scores": {
|
|
5
|
+
"path": "/Dataservice/GetAdhocData.aspx",
|
|
6
|
+
"description": "NAEP estimates (type=data): average scale scores, achievement-level or row percents, percentiles, with standard errors (QCData=true), by subject, grade, jurisdiction(s), year(s) and student group.",
|
|
7
|
+
"params": {
|
|
8
|
+
"subject": {"required": true, "catalog": true, "desc": "reading, math (mathematics), science, writing, civics, history, geography, economics, tel, music"},
|
|
9
|
+
"grade": {"required": true, "enum": [4, 8, 12], "desc": "4, 8 or 12"},
|
|
10
|
+
"subscale": {"desc": "scale code; default is the subject's composite (math grade 12: MWPCM). a request_schema search \"sub:\" lists them"},
|
|
11
|
+
"variable": {"desc": "student group: TOTAL, SDRACE, GENDER, ECONDIS (SLUNCH3 before 2024), PARED, SCHTYPE, UTOL4, IEP, LEP; crosstab A+B (SDRACE+GENDER)"},
|
|
12
|
+
"jurisdiction": {"desc": "NP (national public), NT (national), state codes (CA), districts (XN = New York City); comma-separated for several"},
|
|
13
|
+
"stattype": {"desc": "MN:MN mean (default); ALC:AB / ALC:AP / ALC:AD at or above Basic/Proficient/Advanced; RP:RP row percent; PC:P1/P2/P5/P7/P9 = 10th/25th/50th/75th/90th percentile (no other PC codes); comma-separated for several"},
|
|
14
|
+
"Year": {"desc": "2024, comma list 2024,2022,2019, or Current / Prior / Base; R2 suffix = non-accommodated sample (e.g. 1998R2)"},
|
|
15
|
+
"categoryindex": {"desc": "restrict a variable to some categories, e.g. 1,2"},
|
|
16
|
+
"StackType": {"enum": ["ColThenRow", "RowThenCol"], "desc": "row order for crosstabs"}
|
|
17
|
+
},
|
|
18
|
+
"defaults": {"type": "data", "variable": "TOTAL", "jurisdiction": "NP", "stattype": "MN:MN", "Year": "Current", "QCData": "true"},
|
|
19
|
+
"records": "result", "paging": {"type": "none"}, "max_rows": 50000
|
|
20
|
+
},
|
|
21
|
+
"achievement_levels": {
|
|
22
|
+
"path": "/Dataservice/GetAdhocData.aspx",
|
|
23
|
+
"description": "Cumulative achievement-level percents: below Basic, at or above Basic, at or above Proficient, at Advanced (one row per stattype), with standard errors.",
|
|
24
|
+
"params": {
|
|
25
|
+
"subject": {"required": true, "catalog": true, "desc": "subject"},
|
|
26
|
+
"grade": {"required": true, "enum": [4, 8, 12], "desc": "4, 8 or 12"},
|
|
27
|
+
"subscale": {"desc": "default composite"},
|
|
28
|
+
"variable": {"desc": "student group (default TOTAL)"},
|
|
29
|
+
"jurisdiction": {"desc": "jurisdiction code(s)"},
|
|
30
|
+
"Year": {"desc": "year(s)"}
|
|
31
|
+
},
|
|
32
|
+
"defaults": {"type": "data", "variable": "TOTAL", "jurisdiction": "NP", "stattype": "ALC:BB,ALC:AB,ALC:AP,ALC:AD", "Year": "Current", "QCData": "true"},
|
|
33
|
+
"records": "result", "paging": {"type": "none"}, "max_rows": 50000
|
|
34
|
+
},
|
|
35
|
+
"compare_years": {
|
|
36
|
+
"path": "/Dataservice/GetAdhocData.aspx",
|
|
37
|
+
"description": "Significance test between years (type=sigacrossyear): focal and target values, gap, sig (HIGHER / LOWER / EQUAL), pValue, seDiff. Needs 2+ years.",
|
|
38
|
+
"params": {
|
|
39
|
+
"subject": {"required": true, "catalog": true, "desc": "subject"},
|
|
40
|
+
"grade": {"required": true, "enum": [4, 8, 12], "desc": "grade"},
|
|
41
|
+
"Year": {"required": true, "desc": "two or more years: 2024,2019"},
|
|
42
|
+
"subscale": {"desc": "default composite"}, "variable": {"desc": "default TOTAL"},
|
|
43
|
+
"jurisdiction": {"desc": "default NP"}, "stattype": {"desc": "default MN:MN"}
|
|
44
|
+
},
|
|
45
|
+
"defaults": {"type": "sigacrossyear", "variable": "TOTAL", "jurisdiction": "NP", "stattype": "MN:MN", "QCData": "true"},
|
|
46
|
+
"records": "result", "paging": {"type": "none"}, "max_rows": 50000
|
|
47
|
+
},
|
|
48
|
+
"compare_jurisdictions": {
|
|
49
|
+
"path": "/Dataservice/GetAdhocData.aspx",
|
|
50
|
+
"description": "Significance test between jurisdictions (type=sigacrossjuris), every ordered pair. Needs 2+ jurisdictions.",
|
|
51
|
+
"params": {
|
|
52
|
+
"subject": {"required": true, "catalog": true, "desc": "subject"},
|
|
53
|
+
"grade": {"required": true, "enum": [4, 8, 12], "desc": "grade"},
|
|
54
|
+
"jurisdiction": {"required": true, "desc": "two or more codes: NP,MA,MS"},
|
|
55
|
+
"subscale": {"desc": "default composite"}, "variable": {"desc": "default TOTAL"},
|
|
56
|
+
"Year": {"desc": "default Current"}, "stattype": {"desc": "default MN:MN"}
|
|
57
|
+
},
|
|
58
|
+
"defaults": {"type": "sigacrossjuris", "variable": "TOTAL", "stattype": "MN:MN", "Year": "Current", "QCData": "true"},
|
|
59
|
+
"records": "result", "paging": {"type": "none"}, "max_rows": 50000
|
|
60
|
+
},
|
|
61
|
+
"compare_groups": {
|
|
62
|
+
"path": "/Dataservice/GetAdhocData.aspx",
|
|
63
|
+
"description": "Significance test between categories of one student-group variable (type=sigacrossvalue), e.g. male vs female. variable must not be TOTAL.",
|
|
64
|
+
"params": {
|
|
65
|
+
"subject": {"required": true, "catalog": true, "desc": "subject"},
|
|
66
|
+
"grade": {"required": true, "enum": [4, 8, 12], "desc": "grade"},
|
|
67
|
+
"variable": {"required": true, "desc": "SDRACE, GENDER, ECONDIS, ... (not TOTAL)"},
|
|
68
|
+
"subscale": {"desc": "default composite"}, "jurisdiction": {"desc": "default NP"},
|
|
69
|
+
"Year": {"desc": "default Current"}, "categoryindex": {"desc": "restrict categories"}, "stattype": {"desc": "default MN:MN"}
|
|
70
|
+
},
|
|
71
|
+
"defaults": {"type": "sigacrossvalue", "jurisdiction": "NP", "stattype": "MN:MN", "Year": "Current", "QCData": "true"},
|
|
72
|
+
"records": "result", "paging": {"type": "none"}, "max_rows": 50000
|
|
73
|
+
},
|
|
74
|
+
"gap_years_across_jurisdictions": {
|
|
75
|
+
"path": "/Dataservice/GetAdhocData.aspx",
|
|
76
|
+
"description": "Is one jurisdiction's change between two years different from another's? (type=gaponyearacrossjuris). Exactly 2 years, 2+ jurisdictions.",
|
|
77
|
+
"params": {
|
|
78
|
+
"subject": {"required": true, "catalog": true, "desc": "subject"},
|
|
79
|
+
"grade": {"required": true, "enum": [4, 8, 12], "desc": "grade"},
|
|
80
|
+
"Year": {"required": true, "desc": "exactly two years: 2024,2019"},
|
|
81
|
+
"jurisdiction": {"required": true, "desc": "two or more codes"},
|
|
82
|
+
"subscale": {"desc": "default composite"}, "variable": {"desc": "default TOTAL"}, "stattype": {"desc": "default MN:MN"}
|
|
83
|
+
},
|
|
84
|
+
"defaults": {"type": "gaponyearacrossjuris", "variable": "TOTAL", "stattype": "MN:MN", "QCData": "true"},
|
|
85
|
+
"records": "result", "paging": {"type": "none"}, "max_rows": 50000
|
|
86
|
+
},
|
|
87
|
+
"gap_groups_across_years": {
|
|
88
|
+
"path": "/Dataservice/GetAdhocData.aspx",
|
|
89
|
+
"description": "Did a group gap (e.g. female minus male) change between years? (type=gaponvaracrossyear). 2+ years, variable not TOTAL.",
|
|
90
|
+
"params": {
|
|
91
|
+
"subject": {"required": true, "catalog": true, "desc": "subject"},
|
|
92
|
+
"grade": {"required": true, "enum": [4, 8, 12], "desc": "grade"},
|
|
93
|
+
"variable": {"required": true, "desc": "group variable (not TOTAL)"},
|
|
94
|
+
"Year": {"required": true, "desc": "two or more years"},
|
|
95
|
+
"subscale": {"desc": "default composite"}, "jurisdiction": {"desc": "default NP"}, "stattype": {"desc": "default MN:MN"}
|
|
96
|
+
},
|
|
97
|
+
"defaults": {"type": "gaponvaracrossyear", "jurisdiction": "NP", "stattype": "MN:MN", "QCData": "true"},
|
|
98
|
+
"records": "result", "paging": {"type": "none"}, "max_rows": 50000
|
|
99
|
+
},
|
|
100
|
+
"gap_groups_across_jurisdictions": {
|
|
101
|
+
"path": "/Dataservice/GetAdhocData.aspx",
|
|
102
|
+
"description": "Is a group gap larger in one jurisdiction than another? (type=gaponvaracrossjuris). 2+ jurisdictions, variable not TOTAL.",
|
|
103
|
+
"params": {
|
|
104
|
+
"subject": {"required": true, "catalog": true, "desc": "subject"},
|
|
105
|
+
"grade": {"required": true, "enum": [4, 8, 12], "desc": "grade"},
|
|
106
|
+
"variable": {"required": true, "desc": "group variable (not TOTAL)"},
|
|
107
|
+
"jurisdiction": {"required": true, "desc": "two or more codes"},
|
|
108
|
+
"subscale": {"desc": "default composite"}, "Year": {"desc": "default Current"}, "stattype": {"desc": "default MN:MN"}
|
|
109
|
+
},
|
|
110
|
+
"defaults": {"type": "gaponvaracrossjuris", "stattype": "MN:MN", "Year": "Current", "QCData": "true"},
|
|
111
|
+
"records": "result", "paging": {"type": "none"}, "max_rows": 50000
|
|
112
|
+
},
|
|
113
|
+
"variables": {
|
|
114
|
+
"path": "/Dataservice/GetAdhocData.aspx",
|
|
115
|
+
"description": "Independent (student-group and questionnaire) variables available for a subject, cohort (1 = grade 4, 2 = grade 8, 3 = grade 12) and year.",
|
|
116
|
+
"params": {
|
|
117
|
+
"subject": {"required": true, "catalog": true, "desc": "subject"},
|
|
118
|
+
"cohort": {"required": true, "enum": [1, 2, 3], "desc": "1 = grade 4, 2 = grade 8, 3 = grade 12"},
|
|
119
|
+
"Year": {"required": true, "desc": "one year, e.g. 2024"}
|
|
120
|
+
},
|
|
121
|
+
"defaults": {"type": "independentvariables"},
|
|
122
|
+
"records": "result.0.variables", "paging": {"type": "none"}, "max_rows": 50000
|
|
123
|
+
}
|
|
124
|
+
},
|
|
125
|
+
"catalog": {
|
|
126
|
+
"reading": {"id": "reading", "kind": "subject", "subscale": "RRPCM", "name": "Reading (composite scale 0-500)", "description": "grades 4, 8, 12; latest 2024 (all three grades). Aliases: ela, english", "grades": [4, 8, 12]},
|
|
127
|
+
"ela": {"id": "reading", "kind": "subject alias", "subscale": "RRPCM", "name": "Reading", "description": "alias of reading"},
|
|
128
|
+
"math": {"id": "mathematics", "kind": "subject", "subscale": "MRPCM", "subscale_grade12": "MWPCM", "name": "Mathematics (composite)", "description": "grades 4 and 8 on MRPCM (0-500), latest 2024; grade 12 on MWPCM (0-300, 2005 framework), latest 2024", "grades": [4, 8, 12]},
|
|
129
|
+
"mathematics": {"id": "mathematics", "kind": "subject", "subscale": "MRPCM", "subscale_grade12": "MWPCM", "name": "Mathematics", "description": "same as math"},
|
|
130
|
+
"science": {"id": "science", "kind": "subject", "subscale": "SRPUV", "name": "Science (2009 framework, 0-300)", "description": "grades 4, 8, 12; latest grade 8 2024; grades 4 and 12 2019 (not assessed in 2024)", "grades": [4, 8, 12]},
|
|
131
|
+
"writing": {"id": "writing", "kind": "subject", "subscale": "WRIRP", "name": "Writing", "description": "grade 4 2002; grades 8 and 12 2011 (computer-based, not comparable with earlier)", "grades": [4, 8, 12]},
|
|
132
|
+
"civics": {"id": "civics", "kind": "subject", "subscale": "CIVRP", "name": "Civics", "description": "grade 8 latest 2022; grades 4 and 12 2010. Alias: social studies", "grades": [4, 8, 12]},
|
|
133
|
+
"history": {"id": "history", "kind": "subject", "subscale": "HRPCM", "name": "U.S. History (composite)", "description": "grade 8 latest 2022; grades 4 and 12 2010. Alias: us history", "grades": [4, 8, 12]},
|
|
134
|
+
"us history": {"id": "history", "kind": "subject alias", "subscale": "HRPCM", "name": "U.S. History", "description": "alias of history"},
|
|
135
|
+
"geography": {"id": "geography", "kind": "subject", "subscale": "GRPCM", "name": "Geography (composite)", "description": "grade 8 latest 2018; grades 4 and 12 2010", "grades": [4, 8, 12]},
|
|
136
|
+
"economics": {"id": "economics", "kind": "subject", "subscale": "ERPCM", "name": "Economics", "description": "grade 12 only, 2006 and 2012", "grades": [12]},
|
|
137
|
+
"tel": {"id": "tel", "kind": "subject", "subscale": "TRPUN", "name": "Technology and Engineering Literacy", "description": "grade 8 only, 2014 and 2018", "grades": [8]},
|
|
138
|
+
"music": {"id": "music", "kind": "subject", "subscale": "MUSRP", "name": "Music", "description": "grade 8 only (arts assessment, 2008 and 2016)", "grades": [8]},
|
|
139
|
+
"sub:RRPS1": {"id": "RRPS1", "kind": "subscale", "name": "Reading: literary experience"},
|
|
140
|
+
"sub:RRPS2": {"id": "RRPS2", "kind": "subscale", "name": "Reading: gain information"},
|
|
141
|
+
"sub:RRPS3": {"id": "RRPS3", "kind": "subscale", "name": "Reading: perform a task (grades 8, 12)"},
|
|
142
|
+
"sub:MRPS1": {"id": "MRPS1", "kind": "subscale", "name": "Mathematics: number properties and operations"},
|
|
143
|
+
"sub:MRPS2": {"id": "MRPS2", "kind": "subscale", "name": "Mathematics: measurement"},
|
|
144
|
+
"sub:MRPS3": {"id": "MRPS3", "kind": "subscale", "name": "Mathematics: geometry"},
|
|
145
|
+
"sub:MRPS4": {"id": "MRPS4", "kind": "subscale", "name": "Mathematics: data analysis, statistics, and probability"},
|
|
146
|
+
"sub:MRPS5": {"id": "MRPS5", "kind": "subscale", "name": "Mathematics: algebra"},
|
|
147
|
+
"sub:MWPCM": {"id": "MWPCM", "kind": "subscale", "name": "Mathematics grade 12 composite (2005 framework, 0-300)"},
|
|
148
|
+
"sub:SRPCM": {"id": "SRPCM", "kind": "subscale", "name": "Science composite, 1996-2005 framework (not comparable with SRPUV)"},
|
|
149
|
+
"sub:SRPS1": {"id": "SRPS1", "kind": "subscale", "name": "Science: physical science"},
|
|
150
|
+
"sub:SRPS2": {"id": "SRPS2", "kind": "subscale", "name": "Science: earth science"},
|
|
151
|
+
"sub:SRPS3": {"id": "SRPS3", "kind": "subscale", "name": "Science: life science"},
|
|
152
|
+
"sub:GRPS1": {"id": "GRPS1", "kind": "subscale", "name": "Geography: space and place"},
|
|
153
|
+
"sub:HRPS1": {"id": "HRPS1", "kind": "subscale", "name": "U.S. history: democracy"},
|
|
154
|
+
"sub:ERPS1": {"id": "ERPS1", "kind": "subscale", "name": "Economics: market"},
|
|
155
|
+
"sub:TRPP1": {"id": "TRPP1", "kind": "subscale", "name": "TEL: communicating and collaborating"},
|
|
156
|
+
"var:TOTAL": {"id": "TOTAL", "kind": "variable", "name": "All students"},
|
|
157
|
+
"var:SDRACE": {"id": "SDRACE", "kind": "variable", "name": "Race/ethnicity used to report trends (school-reported)"},
|
|
158
|
+
"var:SRACE10": {"id": "SRACE10", "kind": "variable", "name": "Race/ethnicity, 2011 guidelines"},
|
|
159
|
+
"var:GENDER": {"id": "GENDER", "kind": "variable", "name": "Sex"},
|
|
160
|
+
"var:SLUNCH3": {"id": "SLUNCH3", "kind": "variable", "name": "National School Lunch Program eligibility (poverty proxy), to 2022", "successor": "ECONDIS"},
|
|
161
|
+
"var:ECONDIS": {"id": "ECONDIS", "kind": "variable", "name": "Economically disadvantaged status (poverty proxy; 2024 on, same values as SLUNCH3 in earlier years)"},
|
|
162
|
+
"var:PARED": {"id": "PARED", "kind": "variable", "name": "Parental education (grades 8, 12, student-reported)"},
|
|
163
|
+
"var:SCHTYPE": {"id": "SCHTYPE", "kind": "variable", "name": "School type: public / private"},
|
|
164
|
+
"var:CHRTRPT": {"id": "CHRTRPT", "kind": "variable", "name": "Charter school"},
|
|
165
|
+
"var:UTOL4": {"id": "UTOL4", "kind": "variable", "name": "School location: city, suburb, town, rural"},
|
|
166
|
+
"var:CENSREG": {"id": "CENSREG", "kind": "variable", "name": "Census region"},
|
|
167
|
+
"var:IEP": {"id": "IEP", "kind": "variable", "name": "Students with disabilities (IEP)"},
|
|
168
|
+
"var:LEP": {"id": "LEP", "kind": "variable", "name": "English learners"},
|
|
169
|
+
"stat:MN:MN": {"id": "MN:MN", "kind": "stattype", "name": "Average scale score (mean)"},
|
|
170
|
+
"stat:RP:RP": {"id": "RP:RP", "kind": "stattype", "name": "Row percent (share of students in each category)"},
|
|
171
|
+
"stat:ALC:BB": {"id": "ALC:BB", "kind": "stattype", "name": "% below Basic"},
|
|
172
|
+
"stat:ALC:AB": {"id": "ALC:AB", "kind": "stattype", "name": "% at or above Basic"},
|
|
173
|
+
"stat:ALC:AP": {"id": "ALC:AP", "kind": "stattype", "name": "% at or above Proficient"},
|
|
174
|
+
"stat:ALC:AD": {"id": "ALC:AD", "kind": "stattype", "name": "% at Advanced"},
|
|
175
|
+
"stat:ALD:BA": {"id": "ALD:BA", "kind": "stattype", "name": "% at Basic (discrete)"},
|
|
176
|
+
"stat:ALD:PR": {"id": "ALD:PR", "kind": "stattype", "name": "% at Proficient (discrete)"},
|
|
177
|
+
"stat:SD:SD": {"id": "SD:SD", "kind": "stattype", "name": "Standard deviation of scores"},
|
|
178
|
+
"stat:PC:P1": {"id": "PC:P1", "kind": "stattype", "name": "10th percentile score"},
|
|
179
|
+
"stat:PC:P2": {"id": "PC:P2", "kind": "stattype", "name": "25th percentile score"},
|
|
180
|
+
"stat:PC:P5": {"id": "PC:P5", "kind": "stattype", "name": "50th percentile (median) score"},
|
|
181
|
+
"stat:PC:P7": {"id": "PC:P7", "kind": "stattype", "name": "75th percentile score"},
|
|
182
|
+
"stat:PC:P9": {"id": "PC:P9", "kind": "stattype", "name": "90th percentile score"},
|
|
183
|
+
"jur:NP": {"id": "NP", "kind": "jurisdiction", "name": "National public schools (use to compare with states)"},
|
|
184
|
+
"jur:NT": {"id": "NT", "kind": "jurisdiction", "name": "National, public and private (grade 12, long-run national)"},
|
|
185
|
+
"jur:NR": {"id": "NR", "kind": "jurisdiction", "name": "National private schools", "description": "rows only through 2013; later years: NT with variable=SCHTYPE (Catholic, Other private)"},
|
|
186
|
+
"jur:NL": {"id": "NL", "kind": "jurisdiction", "name": "Large city (public schools in cities over 250,000)"},
|
|
187
|
+
"jur:DS": {"id": "DS", "kind": "jurisdiction", "name": "DoDEA schools"},
|
|
188
|
+
"jur:XA": {"id": "XA", "kind": "jurisdiction", "name": "Atlanta (TUDA district)"},
|
|
189
|
+
"jur:XU": {"id": "XU", "kind": "jurisdiction", "name": "Austin (TUDA district)"},
|
|
190
|
+
"jur:XM": {"id": "XM", "kind": "jurisdiction", "name": "Baltimore City (TUDA district)"},
|
|
191
|
+
"jur:XB": {"id": "XB", "kind": "jurisdiction", "name": "Boston (TUDA district)"},
|
|
192
|
+
"jur:XT": {"id": "XT", "kind": "jurisdiction", "name": "Charlotte-Mecklenburg (TUDA district)"},
|
|
193
|
+
"jur:XC": {"id": "XC", "kind": "jurisdiction", "name": "Chicago (TUDA district)"},
|
|
194
|
+
"jur:XX": {"id": "XX", "kind": "jurisdiction", "name": "Clark County NV (TUDA district)"},
|
|
195
|
+
"jur:XV": {"id": "XV", "kind": "jurisdiction", "name": "Cleveland (TUDA district)"},
|
|
196
|
+
"jur:XS": {"id": "XS", "kind": "jurisdiction", "name": "Dallas (TUDA district)"},
|
|
197
|
+
"jur:XY": {"id": "XY", "kind": "jurisdiction", "name": "Denver (TUDA district)"},
|
|
198
|
+
"jur:XR": {"id": "XR", "kind": "jurisdiction", "name": "Detroit (TUDA district)"},
|
|
199
|
+
"jur:XW": {"id": "XW", "kind": "jurisdiction", "name": "District of Columbia Public Schools (TUDA district)"},
|
|
200
|
+
"jur:XE": {"id": "XE", "kind": "jurisdiction", "name": "Duval County FL (TUDA district)"},
|
|
201
|
+
"jur:XZ": {"id": "XZ", "kind": "jurisdiction", "name": "Fort Worth (TUDA district)"},
|
|
202
|
+
"jur:XF": {"id": "XF", "kind": "jurisdiction", "name": "Fresno (TUDA district)"},
|
|
203
|
+
"jur:XG": {"id": "XG", "kind": "jurisdiction", "name": "Guilford County NC (TUDA district)"},
|
|
204
|
+
"jur:XO": {"id": "XO", "kind": "jurisdiction", "name": "Hillsborough County FL (TUDA district)"},
|
|
205
|
+
"jur:XH": {"id": "XH", "kind": "jurisdiction", "name": "Houston (TUDA district)"},
|
|
206
|
+
"jur:XJ": {"id": "XJ", "kind": "jurisdiction", "name": "Jefferson County KY (TUDA district)"},
|
|
207
|
+
"jur:XL": {"id": "XL", "kind": "jurisdiction", "name": "Los Angeles (TUDA district)"},
|
|
208
|
+
"jur:XI": {"id": "XI", "kind": "jurisdiction", "name": "Miami-Dade (TUDA district)"},
|
|
209
|
+
"jur:XK": {"id": "XK", "kind": "jurisdiction", "name": "Milwaukee (TUDA district)"},
|
|
210
|
+
"jur:XN": {"id": "XN", "kind": "jurisdiction", "name": "New York City (TUDA district)"},
|
|
211
|
+
"jur:XP": {"id": "XP", "kind": "jurisdiction", "name": "Philadelphia (TUDA district)"},
|
|
212
|
+
"jur:XD": {"id": "XD", "kind": "jurisdiction", "name": "San Diego (TUDA district)"},
|
|
213
|
+
"jur:YA": {"id": "YA", "kind": "jurisdiction", "name": "Shelby County TN (TUDA district)"},
|
|
214
|
+
"jur:XQ": {"id": "XQ", "kind": "jurisdiction", "name": "Albuquerque (TUDA district)"},
|
|
215
|
+
"jur:PR": {"id": "PR", "kind": "jurisdiction", "name": "Puerto Rico (mathematics only, own scale)"}
|
|
216
|
+
}
|
|
217
|
+
}
|
|
@@ -0,0 +1,100 @@
|
|
|
1
|
+
{
|
|
2
|
+
"id": "naep",
|
|
3
|
+
"title": "NAEP, The Nation's Report Card (NAEP Data Service)",
|
|
4
|
+
"agency": "National Center for Education Statistics (U.S. Department of Education), for the National Assessment Governing Board",
|
|
5
|
+
"depth": "standard",
|
|
6
|
+
"domains": [
|
|
7
|
+
"education",
|
|
8
|
+
"k-12",
|
|
9
|
+
"student achievement"
|
|
10
|
+
],
|
|
11
|
+
"keywords": [
|
|
12
|
+
"naep",
|
|
13
|
+
"nation's report card",
|
|
14
|
+
"test scores",
|
|
15
|
+
"reading scores",
|
|
16
|
+
"math scores",
|
|
17
|
+
"achievement",
|
|
18
|
+
"proficient",
|
|
19
|
+
"proficiency",
|
|
20
|
+
"achievement gap",
|
|
21
|
+
"4th grade",
|
|
22
|
+
"8th grade",
|
|
23
|
+
"12th grade",
|
|
24
|
+
"grade 4",
|
|
25
|
+
"grade 8",
|
|
26
|
+
"student performance",
|
|
27
|
+
"school",
|
|
28
|
+
"learning loss",
|
|
29
|
+
"science scores",
|
|
30
|
+
"civics",
|
|
31
|
+
"us history",
|
|
32
|
+
"tuda",
|
|
33
|
+
"urban district"
|
|
34
|
+
],
|
|
35
|
+
"questions": [
|
|
36
|
+
"4th grade reading scores by state",
|
|
37
|
+
"did math scores fall since 2019",
|
|
38
|
+
"percent of 8th graders proficient in math",
|
|
39
|
+
"achievement gap by race or school lunch eligibility",
|
|
40
|
+
"how a state compares with the national average",
|
|
41
|
+
"NAEP results for a large city district"
|
|
42
|
+
],
|
|
43
|
+
"homepage": "https://www.nationsreportcard.gov/",
|
|
44
|
+
"terms_url": "https://nces.ed.gov/help/copyright.asp",
|
|
45
|
+
"auth": {
|
|
46
|
+
"env": null,
|
|
47
|
+
"required": "none",
|
|
48
|
+
"placement": "none",
|
|
49
|
+
"signup_url": null,
|
|
50
|
+
"echoes_key": false
|
|
51
|
+
},
|
|
52
|
+
"limits": {
|
|
53
|
+
"rps": 2,
|
|
54
|
+
"burst": 4,
|
|
55
|
+
"max_rows": 50000
|
|
56
|
+
},
|
|
57
|
+
"routes": {
|
|
58
|
+
"api": {
|
|
59
|
+
"base": "https://www.nationsreportcard.gov",
|
|
60
|
+
"probe": "https://www.nationsreportcard.gov/Dataservice/GetAdhocData.aspx?type=data&subject=reading&grade=4&subscale=RRPCM&variable=TOTAL&jurisdiction=NP&stattype=MN:MN&Year=Current",
|
|
61
|
+
"hosts": [
|
|
62
|
+
"www.nationsreportcard.gov"
|
|
63
|
+
]
|
|
64
|
+
},
|
|
65
|
+
"manual": {
|
|
66
|
+
"how": "Open each link in manual_download/INSTRUCTIONS.md in a browser (each returns JSON; save it under the name shown) and upload the files. Without the links: the NAEP Data Explorer (https://www.nationsreportcard.gov/ndecore/landing) builds the same tables (choose subject, grade, jurisdictions, variables, statistics; Download > Excel); upload the export and say which table it is. The report cards at https://www.nationsreportcard.gov/ give the headline numbers with significance marks."
|
|
67
|
+
}
|
|
68
|
+
},
|
|
69
|
+
"cache": {
|
|
70
|
+
"mode": "run_only",
|
|
71
|
+
"ttl_hours": null,
|
|
72
|
+
"why": "Small queries; results change only when a new assessment is released (about every two years), but data/ is reused only within a run."
|
|
73
|
+
},
|
|
74
|
+
"redistribution": {
|
|
75
|
+
"mode": "allowed",
|
|
76
|
+
"why": "NAEP results are published by NCES, a U.S. government agency; its materials are in the public domain (17 U.S.C. 105) unless marked otherwise, and NCES asks that the source be cited."
|
|
77
|
+
},
|
|
78
|
+
"notices": [],
|
|
79
|
+
"retention": null,
|
|
80
|
+
"citation": "U.S. Department of Education, Institute of Education Sciences, National Center for Education Statistics, National Assessment of Educational Progress (NAEP), {dataset}, NAEP Data Service (nationsreportcard.gov), retrieved {retrieved_long}.",
|
|
81
|
+
"audit_hooks": [
|
|
82
|
+
{
|
|
83
|
+
"id": "naep_uncertainty",
|
|
84
|
+
"kind": "require_text",
|
|
85
|
+
"any": [
|
|
86
|
+
"standard error",
|
|
87
|
+
"significant"
|
|
88
|
+
],
|
|
89
|
+
"why": "NAEP scores are sample estimates with standard errors; a report must say whether differences are statistically significant (NAEP's own tests), not compare point estimates."
|
|
90
|
+
}
|
|
91
|
+
],
|
|
92
|
+
"clarify": [
|
|
93
|
+
"Which subject, grade(s) and year(s)? Default: reading and mathematics, grades 4 and 8, the latest year and 2019 (pre-pandemic).",
|
|
94
|
+
"Average scale score or achievement level (percent at or above Proficient)? They can move differently; default: report both.",
|
|
95
|
+
"Public schools only (NP, the comparison base for states) or all schools (NT)? Default NP when states are involved."
|
|
96
|
+
],
|
|
97
|
+
"formats": [
|
|
98
|
+
"json"
|
|
99
|
+
]
|
|
100
|
+
}
|
|
@@ -0,0 +1,120 @@
|
|
|
1
|
+
# NAEP, The Nation's Report Card (NAEP Data Service)
|
|
2
|
+
Depth: standard. Key: none. National, state and large-district results of the National Assessment of
|
|
3
|
+
Educational Progress: average scale scores, achievement levels and percentiles by subject, grade, year and
|
|
4
|
+
student group, with standard errors and NAEP's own significance tests.
|
|
5
|
+
|
|
6
|
+
## When to use
|
|
7
|
+
- K-12 achievement: reading and mathematics (grades 4 and 8, every two years; grade 12 less often),
|
|
8
|
+
science, writing, civics, U.S. history, geography, economics, technology and engineering literacy,
|
|
9
|
+
music. States versus the nation, change since 2019, gaps by race, sex, economic disadvantage.
|
|
10
|
+
- Not here: state test results (each state's own exams, not comparable across states), graduation rates
|
|
11
|
+
and school finance (nces or ed packs if present), college outcomes (college-scorecard).
|
|
12
|
+
- NAEP is a sample survey: every number is an estimate. It reports groups, never students or schools.
|
|
13
|
+
|
|
14
|
+
## Endpoints and datasets
|
|
15
|
+
All endpoints call `GetAdhocData.aspx` with a different `type`; standard errors come from `QCData=true`
|
|
16
|
+
(set by default).
|
|
17
|
+
|
|
18
|
+
| Endpoint | Returns | Key parameters |
|
|
19
|
+
|---|---|---|
|
|
20
|
+
| `scores` | estimates: `value`, `stdError`, `cellN`, `errorFlag` | `subject`, `grade`, `jurisdiction`, `Year`, `variable`, `stattype`, `subscale` |
|
|
21
|
+
| `achievement_levels` | % below Basic, at/above Basic, at/above Proficient, at Advanced | same (stattype fixed) |
|
|
22
|
+
| `compare_years` | year-vs-year test: `focalValue`, `targetValue`, `gap`, `sig`, `pValue`, `seDiff` | `Year` = 2+ years |
|
|
23
|
+
| `compare_jurisdictions` | every ordered pair of jurisdictions, tested | `jurisdiction` = 2+ codes |
|
|
24
|
+
| `compare_groups` | categories of one variable, tested (male vs female) | `variable` (not TOTAL) |
|
|
25
|
+
| `gap_years_across_jurisdictions` | is one place's change different from another's? | 2 years, 2+ jurisdictions |
|
|
26
|
+
| `gap_groups_across_years` | did a group gap change over time? | `variable`, 2+ years |
|
|
27
|
+
| `gap_groups_across_jurisdictions` | is a group gap larger in one place? | `variable`, 2+ jurisdictions |
|
|
28
|
+
| `variables` | independent variables for a subject, cohort (1, 2, 3 = grades 4, 8, 12), year | `subject`, `cohort`, `Year` |
|
|
29
|
+
|
|
30
|
+
Codes (`request_schema` with `search` finds them in the catalog):
|
|
31
|
+
- Subjects: `reading`, `math` (= mathematics), `science`, `writing`, `civics`, `history`, `geography`,
|
|
32
|
+
`economics` (grade 12), `tel` (grade 8), `music` (grade 8). Aliases: `ela`, `us history`. The pack
|
|
33
|
+
fills `subscale` with the composite scale: RRPCM, MRPCM (math grade 12: MWPCM), SRPUV, WRIRP, CIVRP,
|
|
34
|
+
HRPCM, GRPCM, ERPCM, TRPUN, MUSRP. Subscales: search `geometry`.
|
|
35
|
+
- `variable`: TOTAL, SDRACE (race/ethnicity), GENDER, ECONDIS (economically disadvantaged), PARED,
|
|
36
|
+
SCHTYPE, CHRTRPT, UTOL4 (city/suburb/town/rural), CENSREG, IEP, LEP; crosstab `SDRACE+GENDER`.
|
|
37
|
+
SLUNCH3 (lunch eligibility) ends in 2022: in 2024 every SLUNCH3 cell is 999 "Non-qualified independent
|
|
38
|
+
variable", and ECONDIS carries the poverty split (its 2019 and 2022 values equal SLUNCH3's; verified
|
|
39
|
+
2026-10-28). A trend through 2024 uses ECONDIS for every year.
|
|
40
|
+
- `stattype`: MN:MN mean; ALC:BB / ALC:AB / ALC:AP / ALC:AD cumulative levels; ALD:* discrete levels;
|
|
41
|
+
RP:RP row percent; percentiles PC:P1, PC:P2, PC:P5, PC:P7, PC:P9 (10th, 25th, 50th, 75th, 90th; other
|
|
42
|
+
PC codes answer HTTP 400 "The Statistic PC:P3 is not valid.", verified 2026-10); SD:SD.
|
|
43
|
+
- `jurisdiction`: NP national public, NT national (public and private), NR private, NL large city,
|
|
44
|
+
state postal codes, DS DoDEA, TUDA districts (XN New York City, XC Chicago, XL Los Angeles, ...).
|
|
45
|
+
NR has rows only through 2013 (later years return an empty result, verified 2026-10); for later years
|
|
46
|
+
use `jurisdiction=NT` with `variable=SCHTYPE` (Public, Catholic, Other private, Bureau of Indian
|
|
47
|
+
Education, Department of Defense: no combined private row, and Other private is often suppressed).
|
|
48
|
+
- `Year`: 2024, a list 2024,2019, or Current / Prior / Base. Suffix R2 = the old non-accommodated sample.
|
|
49
|
+
|
|
50
|
+
## Spec examples
|
|
51
|
+
```json
|
|
52
|
+
{"description": "Grade 4 reading, nation: 2024 vs 2019, estimates and test",
|
|
53
|
+
"requests": [{"name": "read4_np", "endpoint": "scores",
|
|
54
|
+
"params": {"subject": "reading", "grade": 4, "jurisdiction": "NP", "Year": "2024,2019"}},
|
|
55
|
+
{"name": "read4_change", "endpoint": "compare_years",
|
|
56
|
+
"params": {"subject": "reading", "grade": 4, "Year": "2024,2019"}}]}
|
|
57
|
+
```
|
|
58
|
+
```json
|
|
59
|
+
{"description": "Grade 8 math 2024: Massachusetts and Mississippi vs the nation; percent proficient",
|
|
60
|
+
"requests": [{"name": "math8_states", "endpoint": "compare_jurisdictions",
|
|
61
|
+
"params": {"subject": "math", "grade": 8, "jurisdiction": "NP,MA,MS", "Year": "2024"}},
|
|
62
|
+
{"name": "math8_levels", "endpoint": "achievement_levels",
|
|
63
|
+
"params": {"subject": "math", "grade": 8, "jurisdiction": "NP,MA,MS", "Year": "2024"}}]}
|
|
64
|
+
```
|
|
65
|
+
```json
|
|
66
|
+
{"description": "Grade 4 reading gap by economic disadvantage, 2019 to 2024",
|
|
67
|
+
"requests": [{"name": "poverty_gap", "endpoint": "gap_groups_across_years",
|
|
68
|
+
"params": {"subject": "reading", "grade": 4, "variable": "ECONDIS", "Year": "2024,2019"}}]}
|
|
69
|
+
```
|
|
70
|
+
|
|
71
|
+
## Data format and traps
|
|
72
|
+
- **Estimates with standard errors.** NAEP tests a sample of students, so `value` is an estimate and
|
|
73
|
+
`stdError` its standard error. Two numbers that differ may not differ significantly. Say a change or a
|
|
74
|
+
gap is real only when NAEP's test says so: use `compare_*` / `gap_*` and read `sig`: HIGHER, LOWER, or
|
|
75
|
+
EQUAL (= not significantly different), with `pValue` against `critPValue` (0.05; multiple-comparison
|
|
76
|
+
adjusted by NAEP for families, `famSize`). Do not run your own t-test on rounded numbers. Report the
|
|
77
|
+
standard error or the significance result next to every comparison (the audit checks this).
|
|
78
|
+
- In comparison rows `gap` = focal minus target; every pair appears twice (A vs B and B vs A). Keep one.
|
|
79
|
+
- **Suppressed estimates arrive as `value` 999 with `stdError` -1** and `isStatDisplayable` 0 (reporting
|
|
80
|
+
standard not met, too few students). The pack adds `value_flag` = "suppressed" for those rows: drop them,
|
|
81
|
+
never average 999. When every estimate of a request or of one year is withheld, the fetch notes it with
|
|
82
|
+
the reasons (a variable not reported that year names its replacement). `errorFlag` is a bit sum; the pack decodes it into `errorFlag_notes` ("Reporting
|
|
83
|
+
standard not met", "Race note type 1", ...). Notes such as 512 keep the value; they are footnotes.
|
|
84
|
+
- Values are unrounded (216.113410808617). NAEP publishes whole-number scores; round for display only,
|
|
85
|
+
and test on the unrounded values (or use NAEP's `sig`).
|
|
86
|
+
- Scales differ by subject and are not comparable across subjects. Reading and math grades 4 and 8 are
|
|
87
|
+
0-500 scales; math grade 12 (MWPCM) and science (SRPUV) are 0-300 and start a new trend line (2005,
|
|
88
|
+
2009 frameworks): do not join them to older years on other scales.
|
|
89
|
+
- Achievement levels are cumulative (`ALC:AP` = at or above Proficient includes Advanced). "Proficient"
|
|
90
|
+
is NAEP's demanding standard, not grade-level performance.
|
|
91
|
+
- NP (public schools) is the comparison base for states; NT includes private schools. States are public
|
|
92
|
+
only. State samples are far smaller than national ones (`cellN`: 6,025 for California vs 144,652 for
|
|
93
|
+
NP, grade 4 reading 2019), so state standard errors are several times larger.
|
|
94
|
+
- Accommodations: since 1996 (math) / 1998 (reading) results include accommodated students (sample R3);
|
|
95
|
+
`Year` with suffix R2 gives the earlier non-accommodated sample. Trend tables mix them at the break.
|
|
96
|
+
- Years: reading and math 2024, 2022, 2019, 2017, ...; other subjects are irregular (see the catalog
|
|
97
|
+
descriptions; `Year=Current` returns the latest). A year that was not
|
|
98
|
+
assessed answers HTTP 400 with a long server message ("did not return exactly 1 framework").
|
|
99
|
+
- `variables` (type=independentvariables) for 2024 arrives as malformed JSON for some subjects and
|
|
100
|
+
cohorts: survey items quoted inside `longLabel` are not escaped (verified 2026-10). The pack escapes such
|
|
101
|
+
stray quotes before parsing and adds a note; the labels are kept as published. Other years parse as is.
|
|
102
|
+
- The `scores` default `Year=Current` changes after each release; write explicit years in specs that
|
|
103
|
+
must reproduce.
|
|
104
|
+
- Not every jurisdiction exists for every subject and grade (unverified in detail: grade 12 state
|
|
105
|
+
results are rare, TUDA districts are mostly reading and math, grades 4 and 8); a missing combination
|
|
106
|
+
fails with HTTP 400 or returns suppressed rows. Check one request first.
|
|
107
|
+
|
|
108
|
+
## Access
|
|
109
|
+
No key. `fetch` works when www.nationsreportcard.gov answers. Each request is one GET returning one JSON
|
|
110
|
+
page. Manual: `manual_bundle` writes `manual_download/INSTRUCTIONS.md` with the same links (with QCData=true);
|
|
111
|
+
open each, save the JSON under the name shown, upload, then `ingest`. Without the links, build the table in the
|
|
112
|
+
NAEP Data Explorer (https://www.nationsreportcard.gov/ndecore/landing): choose subject, grade,
|
|
113
|
+
jurisdictions, variables and statistics (include standard errors), run the significance test there, and
|
|
114
|
+
download the Excel output; upload it and say which table it is.
|
|
115
|
+
|
|
116
|
+
## Citation and terms
|
|
117
|
+
"U.S. Department of Education, Institute of Education Sciences, National Center for Education
|
|
118
|
+
Statistics, National Assessment of Educational Progress (NAEP), <subject, grade, years>, retrieved
|
|
119
|
+
<date>." NCES materials are public domain unless marked; cite the source. Redistribution allowed.
|
|
120
|
+
Reports must mention standard errors or statistical significance (audit hook `naep_uncertainty`).
|