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,111 @@
|
|
|
1
|
+
{
|
|
2
|
+
"id": "usitc",
|
|
3
|
+
"title": "USITC Harmonized Tariff Schedule (HTS REST API: duty rates by HTS line)",
|
|
4
|
+
"agency": "U.S. International Trade Commission",
|
|
5
|
+
"depth": "standard",
|
|
6
|
+
"domains": [
|
|
7
|
+
"trade",
|
|
8
|
+
"tariffs",
|
|
9
|
+
"customs duties"
|
|
10
|
+
],
|
|
11
|
+
"keywords": [
|
|
12
|
+
"tariff rate",
|
|
13
|
+
"duty rate",
|
|
14
|
+
"hts",
|
|
15
|
+
"harmonized tariff schedule",
|
|
16
|
+
"hts code",
|
|
17
|
+
"mfn rate",
|
|
18
|
+
"general rate of duty",
|
|
19
|
+
"column 2",
|
|
20
|
+
"special rate",
|
|
21
|
+
"free trade agreement",
|
|
22
|
+
"preference program",
|
|
23
|
+
"chapter 99",
|
|
24
|
+
"section 301",
|
|
25
|
+
"section 232",
|
|
26
|
+
"additional duties",
|
|
27
|
+
"ad valorem",
|
|
28
|
+
"specific duty",
|
|
29
|
+
"tariff schedule"
|
|
30
|
+
],
|
|
31
|
+
"questions": [
|
|
32
|
+
"what is the general (MFN) duty rate on passenger cars, HTS 8703",
|
|
33
|
+
"which HTS lines for steel flat-rolled products are duty free under the general rate",
|
|
34
|
+
"the statutory duty rate per HTS line, to multiply by import values for a customs revenue estimate",
|
|
35
|
+
"which chapter 99 additional duties apply to an HTS subheading",
|
|
36
|
+
"which free trade agreement partners get duty-free treatment on a product"
|
|
37
|
+
],
|
|
38
|
+
"homepage": "https://hts.usitc.gov/",
|
|
39
|
+
"terms_url": "https://www.usitc.gov/node/16948",
|
|
40
|
+
"auth": {
|
|
41
|
+
"env": null,
|
|
42
|
+
"required": "none",
|
|
43
|
+
"placement": "none",
|
|
44
|
+
"param": null,
|
|
45
|
+
"prefix": "",
|
|
46
|
+
"home": null,
|
|
47
|
+
"signup_url": null,
|
|
48
|
+
"echoes_key": false,
|
|
49
|
+
"key_only": [],
|
|
50
|
+
"extra": {},
|
|
51
|
+
"demo_key": null
|
|
52
|
+
},
|
|
53
|
+
"limits": {
|
|
54
|
+
"rps": 1,
|
|
55
|
+
"burst": 2,
|
|
56
|
+
"daily_quota": null,
|
|
57
|
+
"errors_per_min": null,
|
|
58
|
+
"bytes_per_min": null,
|
|
59
|
+
"max_rows": 30000
|
|
60
|
+
},
|
|
61
|
+
"routes": {
|
|
62
|
+
"api": {
|
|
63
|
+
"base": "https://hts.usitc.gov/reststop",
|
|
64
|
+
"probe": "https://hts.usitc.gov/reststop/currentRelease",
|
|
65
|
+
"hosts": [
|
|
66
|
+
"hts.usitc.gov"
|
|
67
|
+
]
|
|
68
|
+
},
|
|
69
|
+
"manual": {
|
|
70
|
+
"how": "Open each link in manual_download/INSTRUCTIONS.md in a browser and save the JSON page under the name shown, then upload it. Without the links: on https://hts.usitc.gov/ search the HTS number or keyword, or use Export (choose the range of HTS numbers and JSON or CSV) and upload the file; past editions and revisions are under 'Archive' at https://hts.usitc.gov/ (PDF and CSV per revision)."
|
|
71
|
+
}
|
|
72
|
+
},
|
|
73
|
+
"cache": {
|
|
74
|
+
"mode": "run_only",
|
|
75
|
+
"ttl_hours": null,
|
|
76
|
+
"why": "The schedule is revised several times a month; data/ is reused only within a run."
|
|
77
|
+
},
|
|
78
|
+
"redistribution": {
|
|
79
|
+
"mode": "allowed",
|
|
80
|
+
"why": "The HTS is published by the U.S. International Trade Commission, a U.S. government work in the public domain (17 U.S.C. 105)."
|
|
81
|
+
},
|
|
82
|
+
"notices": [],
|
|
83
|
+
"retention": null,
|
|
84
|
+
"citation": "U.S. International Trade Commission, Harmonized Tariff Schedule of the United States ({dataset}), hts.usitc.gov, retrieved {retrieved_long}.",
|
|
85
|
+
"audit_hooks": [],
|
|
86
|
+
"clarify": [
|
|
87
|
+
"Which rate: the general (MFN, column 1) rate, a free trade agreement or preference rate (special), or column 2? Default: general, with any chapter 99 additional duties named separately.",
|
|
88
|
+
"Statutory rate or the rate actually collected? Default: statutory rates from this pack; the duty actually collected on imports (calculated duty by product and country) comes from census international trade."
|
|
89
|
+
],
|
|
90
|
+
"formats": [
|
|
91
|
+
"json"
|
|
92
|
+
],
|
|
93
|
+
"use_instead": [
|
|
94
|
+
{
|
|
95
|
+
"question": "Duties actually collected, import values and quantities by HS code and country",
|
|
96
|
+
"source": "census",
|
|
97
|
+
"terms": [
|
|
98
|
+
"tariff revenue"
|
|
99
|
+
],
|
|
100
|
+
"why": "Census international trade reports import values and calculated duty; the HTS gives the statutory rates only."
|
|
101
|
+
},
|
|
102
|
+
{
|
|
103
|
+
"question": "Total customs duties received by the Treasury, monthly or by fiscal year",
|
|
104
|
+
"source": "treasury",
|
|
105
|
+
"terms": [
|
|
106
|
+
"customs"
|
|
107
|
+
],
|
|
108
|
+
"why": "The Monthly Treasury Statement reports customs duty receipts."
|
|
109
|
+
}
|
|
110
|
+
]
|
|
111
|
+
}
|
|
@@ -0,0 +1,90 @@
|
|
|
1
|
+
# USITC Harmonized Tariff Schedule (HTS REST API: duty rates by HTS line)
|
|
2
|
+
Depth: standard. Key: none. The current Harmonized Tariff Schedule of the United States from the U.S.
|
|
3
|
+
International Trade Commission: every HTS line with its general (MFN), special (trade agreement and preference)
|
|
4
|
+
and column 2 duty rates, units of quantity, and the chapter 99 headings (additional duties) its footnotes name.
|
|
5
|
+
|
|
6
|
+
## When to use
|
|
7
|
+
- The statutory duty rate on a product or a range of HTS lines, as the rate input to a customs revenue
|
|
8
|
+
estimate (rate times import value) or to the static cost of a tariff change; which lines are duty free; which
|
|
9
|
+
trade agreement partners get duty-free or reduced rates (program codes in `special`); the text of chapter 99
|
|
10
|
+
additional duties (Section 232, Section 301 and other actions, headings 9903.xx.xx) and which lines point to
|
|
11
|
+
them.
|
|
12
|
+
- Not here: import values, quantities and duties actually collected by product and country (census
|
|
13
|
+
international trade; it needs CENSUS_API_KEY); customs duty receipts in the federal budget (treasury, Monthly
|
|
14
|
+
Treasury Statement); tariff rates of past revisions through the API (see traps). Trade elasticities and
|
|
15
|
+
revenue scores are not published here.
|
|
16
|
+
|
|
17
|
+
## Endpoints and datasets
|
|
18
|
+
Base `https://hts.usitc.gov/reststop`, keyless, JSON (verified live 2026-11-04). One CSV per request.
|
|
19
|
+
|
|
20
|
+
| Endpoint | Returns (one row per) | Key parameters | Notes |
|
|
21
|
+
|---|---|---|---|
|
|
22
|
+
| `schedule` | HTS line, in schedule order | `from`, `to` (HTS numbers, 4 to 10 digits; `to` includes every line under it: `8703` to `8703` is the whole heading, `8703` to `8704` both headings) | headings, subheadings (8-digit, where rates sit) and statistical suffixes (10-digit); about 60 rows per heading, 17,000+ statistical lines in all |
|
|
23
|
+
| `search` | matching HTS line | `keyword` (word, phrase or HTS number) | same columns; loose match (lines matching any word, plus chapter 99 and 9902 lines); use it to find headings, then fetch them with `schedule` |
|
|
24
|
+
| `current_release` | one row | none | the revision the API serves now, e.g. `2026HTSRev22` |
|
|
25
|
+
| `releases` | edition or revision | none | name, description, date posted, status (`current` or `archive`), since 2015 |
|
|
26
|
+
|
|
27
|
+
Columns of `schedule` and `search`: `htsno`, `indent` (0 = heading; deeper = narrower), `description` (a line's
|
|
28
|
+
full meaning includes the descriptions of the lines above it with lower indent), `units`, `general`, `special`,
|
|
29
|
+
`other` (column 2: only the countries listed in general note 3(b)), `footnotes`, `quotaQuantity`,
|
|
30
|
+
`additionalDuties`. Columns added by the pack: `rate_line` (the line whose rates apply), `general_effective`,
|
|
31
|
+
`general_rate_type` (`free`, `ad_valorem`, `specific`, `compound`, `chapter99`, `other`, `none`),
|
|
32
|
+
`general_ad_valorem_pct` (number, only for Free = 0 or a plain percent), `chapter99_refs`.
|
|
33
|
+
|
|
34
|
+
## Spec examples
|
|
35
|
+
```json
|
|
36
|
+
{"description": "Current HTS revision and the general duty rates on passenger cars and light trucks (headings 8703-8704)",
|
|
37
|
+
"requests": [
|
|
38
|
+
{"name": "release", "endpoint": "current_release", "params": {}},
|
|
39
|
+
{"name": "vehicles", "endpoint": "schedule", "params": {"from": "8703", "to": "8704"}}]}
|
|
40
|
+
```
|
|
41
|
+
```json
|
|
42
|
+
{"description": "HTS lines matching lithium-ion batteries, and the Section 301 China headings 9903.88",
|
|
43
|
+
"requests": [
|
|
44
|
+
{"name": "li_ion", "endpoint": "search", "params": {"keyword": "lithium-ion"}},
|
|
45
|
+
{"name": "s301", "endpoint": "schedule", "params": {"from": "9903.88", "to": "9903.89"}}]}
|
|
46
|
+
```
|
|
47
|
+
|
|
48
|
+
## Data format and traps
|
|
49
|
+
- Rates are published text. `general` may be `Free`, a percent (`2.5%`), a specific rate (`1.7¢/kg`,
|
|
50
|
+
`$1.646/kg`, `3.2¢/liter`), a compound rate (a specific rate plus a percent), or text. Only Free and plain percents become
|
|
51
|
+
`general_ad_valorem_pct`; a specific or compound rate needs the unit value (import value per kg or liter,
|
|
52
|
+
from census trade data) to convert to an ad valorem equivalent: say so, never guess the conversion.
|
|
53
|
+
- Rates sit on the line that carries them, usually the 8-digit subheading; 10-digit statistical lines and
|
|
54
|
+
label rows are blank in `general`. Use `rate_line` and `general_effective` (the pack's carry-down from the
|
|
55
|
+
nearest line above whose number it extends), not the blank `general` of a 10-digit line. Rows with an empty
|
|
56
|
+
`htsno` are label rows ("Other:") that only give context.
|
|
57
|
+
- `search` returns scattered lines: a statistical line whose rate line is not among the hits has
|
|
58
|
+
`general_rate_type` `none`. Take the rate from `schedule` for that heading, never from a neighbouring hit.
|
|
59
|
+
- Additional duties are not in `general`. Chapter 99 lines (9903.xx.xx) hold Section 232, Section 301,
|
|
60
|
+
safeguard and other actions as text such as "The duty provided in the applicable subheading + 25%"; a line's
|
|
61
|
+
`footnotes` / `chapter99_refs` point to some of them, but coverage is decided by the chapter 99 notes and
|
|
62
|
+
their product lists, country of origin and exclusions. Each footnote in `footnotes` starts with the rate column it
|
|
63
|
+
concerns (`[general]`, `[other]`...): a reference marked `[other]` concerns column 2 only. Report the statutory general rate and any additional
|
|
64
|
+
duty separately and name the chapter 99 heading; do not add them without checking the heading's scope.
|
|
65
|
+
- `special` lists the rate with program codes in parentheses (for example A, AU, CL, KR, S); the codes are
|
|
66
|
+
defined in General Note 3(c) of the HTS. `other` (column 2) applies only to the countries in general note 3(b).
|
|
67
|
+
- The API serves only the current revision: the `release` parameter of the export is ignored (verified
|
|
68
|
+
2026-11-04: the same bytes for any value). Always fetch `current_release` and name the revision with every
|
|
69
|
+
rate. Rates of an earlier date come from the archived revision files (downloaded by hand; see Access).
|
|
70
|
+
- Statutory rates are not effective rates: duty collected over import value is lower where imports enter
|
|
71
|
+
under trade agreements, preference programs or exclusions. For collected duty use census trade data
|
|
72
|
+
(calculated duty) or treasury customs receipts.
|
|
73
|
+
- `from`/`to` take digits with or without dots (the pack sends the dotted form: the API answers undotted
|
|
74
|
+
numbers with no rows, and keeps only lines up to the `to` line itself, so the pack asks past `to` and cuts the
|
|
75
|
+
reply there). A range over many chapters returns tens of thousands of rows (the pack stops at 30,000 and says
|
|
76
|
+
so): fetch one chapter or heading range per request.
|
|
77
|
+
|
|
78
|
+
## Access
|
|
79
|
+
No key; the host answers scripts (verified 2026-11-04). Limit used: one request per second. `fetch`
|
|
80
|
+
works directly. Manual is the browser: the links `manual_bundle` writes to `manual_download/INSTRUCTIONS.md` open
|
|
81
|
+
each JSON reply (save the page, upload it, then `ingest`), or use Export on https://hts.usitc.gov/ (choose the
|
|
82
|
+
HTS range and JSON or CSV).
|
|
83
|
+
Past revisions: the archive on https://hts.usitc.gov/ lists every edition and revision (`releases` gives the
|
|
84
|
+
names) with downloadable files.
|
|
85
|
+
|
|
86
|
+
## Citation and terms
|
|
87
|
+
U.S. International Trade Commission, Harmonized Tariff Schedule of the United States (<dataset>; name the
|
|
88
|
+
revision, e.g. 2026 HTS Revision 22), hts.usitc.gov, retrieved <date>. A U.S. government work in the public
|
|
89
|
+
domain (17 U.S.C. 105); redistribution allowed. The HTS General Notes and chapter notes are the legal text
|
|
90
|
+
that decides how a rate applies.
|
|
@@ -0,0 +1,141 @@
|
|
|
1
|
+
{
|
|
2
|
+
"base_url": "https://api.uspto.gov",
|
|
3
|
+
"endpoints": {
|
|
4
|
+
"applications_search": {
|
|
5
|
+
"path": "/api/v1/patent/applications/search",
|
|
6
|
+
"description": "Patent File Wrapper search: patent applications and grants (bibliographic data, status, continuity, assignments) matching a query. Refreshed daily.",
|
|
7
|
+
"params": {
|
|
8
|
+
"q": {"desc": "query: free text, field:value, AND/OR/NOT, wildcards, ranges, e.g. applicationMetaData.filingDate:[2024-01-01 TO 2024-12-31]"},
|
|
9
|
+
"filters": {"desc": "'field value1,value2', e.g. 'applicationMetaData.applicationTypeCode UTL,DES'"},
|
|
10
|
+
"rangeFilters": {"desc": "'field from:to', e.g. 'applicationMetaData.grantDate 2020-01-01:2024-12-31'"},
|
|
11
|
+
"sort": {"desc": "'field asc|desc', e.g. 'applicationMetaData.filingDate desc' (text fields cannot be sorted)"},
|
|
12
|
+
"fields": {"desc": "comma-separated fields to return, e.g. applicationNumberText,applicationMetaData.patentNumber,applicationMetaData.filingDate"},
|
|
13
|
+
"facets": {"desc": "comma-separated fields to count by (returned in the response, not as rows)"}
|
|
14
|
+
},
|
|
15
|
+
"records": "patentFileWrapperDataBag", "total": "count",
|
|
16
|
+
"paging": {"type": "offset", "limit_param": "limit", "offset_param": "offset", "size": 100},
|
|
17
|
+
"max_rows": 10000
|
|
18
|
+
},
|
|
19
|
+
"application": {
|
|
20
|
+
"path": "/api/v1/patent/applications/{applicationNumberText}",
|
|
21
|
+
"description": "Everything ODP holds for one application (metadata, events, continuity, assignments, attorney, PTA).",
|
|
22
|
+
"params": {"applicationNumberText": {"in": "path", "required": true, "desc": "application number without punctuation, e.g. 14412875"}},
|
|
23
|
+
"records": "patentFileWrapperDataBag", "paging": {"type": "none"}
|
|
24
|
+
},
|
|
25
|
+
"application_meta_data": {
|
|
26
|
+
"path": "/api/v1/patent/applications/{applicationNumberText}/meta-data",
|
|
27
|
+
"description": "Bibliographic metadata of one application.",
|
|
28
|
+
"params": {"applicationNumberText": {"in": "path", "required": true, "desc": "application number"}},
|
|
29
|
+
"records": "patentFileWrapperDataBag", "paging": {"type": "none"}
|
|
30
|
+
},
|
|
31
|
+
"application_continuity": {
|
|
32
|
+
"path": "/api/v1/patent/applications/{applicationNumberText}/continuity",
|
|
33
|
+
"description": "Parent and child applications (continuations, divisionals).",
|
|
34
|
+
"params": {"applicationNumberText": {"in": "path", "required": true, "desc": "application number"}},
|
|
35
|
+
"records": "patentFileWrapperDataBag", "paging": {"type": "none"}
|
|
36
|
+
},
|
|
37
|
+
"application_assignment": {
|
|
38
|
+
"path": "/api/v1/patent/applications/{applicationNumberText}/assignment",
|
|
39
|
+
"description": "Recorded ownership transfers (assignors, assignees, reel/frame).",
|
|
40
|
+
"params": {"applicationNumberText": {"in": "path", "required": true, "desc": "application number"}},
|
|
41
|
+
"records": "patentFileWrapperDataBag", "paging": {"type": "none"}
|
|
42
|
+
},
|
|
43
|
+
"application_transactions": {
|
|
44
|
+
"path": "/api/v1/patent/applications/{applicationNumberText}/transactions",
|
|
45
|
+
"description": "Prosecution history events (eventDataBag: code, description, date).",
|
|
46
|
+
"params": {"applicationNumberText": {"in": "path", "required": true, "desc": "application number"}},
|
|
47
|
+
"records": "patentFileWrapperDataBag", "paging": {"type": "none"}
|
|
48
|
+
},
|
|
49
|
+
"application_adjustment": {
|
|
50
|
+
"path": "/api/v1/patent/applications/{applicationNumberText}/adjustment",
|
|
51
|
+
"description": "Patent term adjustment (A, B, C delays, applicant delay, total days).",
|
|
52
|
+
"params": {"applicationNumberText": {"in": "path", "required": true, "desc": "application number"}},
|
|
53
|
+
"records": "patentFileWrapperDataBag", "paging": {"type": "none"}
|
|
54
|
+
},
|
|
55
|
+
"application_foreign_priority": {
|
|
56
|
+
"path": "/api/v1/patent/applications/{applicationNumberText}/foreign-priority",
|
|
57
|
+
"description": "Foreign priority claims.",
|
|
58
|
+
"params": {"applicationNumberText": {"in": "path", "required": true, "desc": "application number"}},
|
|
59
|
+
"records": "patentFileWrapperDataBag", "paging": {"type": "none"}
|
|
60
|
+
},
|
|
61
|
+
"application_attorney": {
|
|
62
|
+
"path": "/api/v1/patent/applications/{applicationNumberText}/attorney",
|
|
63
|
+
"description": "Attorney/agent of record and correspondence address.",
|
|
64
|
+
"params": {"applicationNumberText": {"in": "path", "required": true, "desc": "application number"}},
|
|
65
|
+
"records": "patentFileWrapperDataBag", "paging": {"type": "none"}
|
|
66
|
+
},
|
|
67
|
+
"application_documents": {
|
|
68
|
+
"path": "/api/v1/patent/applications/{applicationNumberText}/documents",
|
|
69
|
+
"description": "List of documents in the file wrapper (code, date, download options). Counts against the 1.2M-a-week documents quota.",
|
|
70
|
+
"params": {"applicationNumberText": {"in": "path", "required": true, "desc": "application number"},
|
|
71
|
+
"documentCodes": {"desc": "comma-separated document codes, e.g. CTNF,NOA"},
|
|
72
|
+
"officialDateFrom": {"desc": "yyyy-MM-dd"}, "officialDateTo": {"desc": "yyyy-MM-dd"}},
|
|
73
|
+
"records": "documentBag", "paging": {"type": "none"}
|
|
74
|
+
},
|
|
75
|
+
"datasets_search": {
|
|
76
|
+
"path": "/api/v1/datasets/products/search",
|
|
77
|
+
"description": "Bulk dataset directory: products (grant/application full text XML, assignments, research datasets) and their files.",
|
|
78
|
+
"params": {"q": {"desc": "query, e.g. productTitleText:*assignment*"},
|
|
79
|
+
"productTitle": {"desc": "product title words"}, "fields": {"desc": "fields to return"}},
|
|
80
|
+
"records": "bulkDataProductBag", "total": "count",
|
|
81
|
+
"paging": {"type": "offset", "limit_param": "limit", "offset_param": "offset", "size": 100},
|
|
82
|
+
"max_rows": 2000
|
|
83
|
+
},
|
|
84
|
+
"dataset_product": {
|
|
85
|
+
"path": "/api/v1/datasets/products/{productIdentifier}",
|
|
86
|
+
"description": "One bulk product and its file list (fileDataFromDate / fileDataToDate narrow the files).",
|
|
87
|
+
"params": {"productIdentifier": {"in": "path", "required": true, "desc": "e.g. PTGRXML"},
|
|
88
|
+
"fileDataFromDate": {"desc": "yyyy-MM-dd"}, "fileDataToDate": {"desc": "yyyy-MM-dd"}},
|
|
89
|
+
"records": "bulkDataProductBag", "paging": {"type": "none"}
|
|
90
|
+
},
|
|
91
|
+
"petition_decisions_search": {
|
|
92
|
+
"path": "/api/v1/petition/decisions/search",
|
|
93
|
+
"description": "Final petition decisions (Office of Petitions, etc.).",
|
|
94
|
+
"params": {"q": {"desc": "query, e.g. decisionTypeCodeDescriptionText:Denied"},
|
|
95
|
+
"filters": {"desc": "'field value1,value2'"}, "rangeFilters": {"desc": "'field from:to', e.g. 'petitionMailDate 2024-01-01:2024-12-31'"},
|
|
96
|
+
"sort": {"desc": "'petitionMailDate desc'"}, "fields": {"desc": "fields to return"}},
|
|
97
|
+
"records": "petitionDecisionDataBag", "total": "count",
|
|
98
|
+
"paging": {"type": "offset", "limit_param": "limit", "offset_param": "offset", "size": 100},
|
|
99
|
+
"max_rows": 10000
|
|
100
|
+
},
|
|
101
|
+
"ptab_proceedings_search": {
|
|
102
|
+
"path": "/api/v1/patent/trials/proceedings/search",
|
|
103
|
+
"description": "PTAB trial proceedings (IPR, PGR, CBM, DER). GET form and record key follow the ODP pattern; not verified with a key.",
|
|
104
|
+
"params": {"q": {"desc": "query, e.g. trialMetaData.trialTypeCode:IPR"},
|
|
105
|
+
"filters": {"desc": "'field value1,value2'"}, "rangeFilters": {"desc": "'field from:to'"},
|
|
106
|
+
"sort": {"desc": "'field asc|desc'"}, "fields": {"desc": "fields to return"}},
|
|
107
|
+
"records": "patentTrialProceedingDataBag", "total": "count",
|
|
108
|
+
"paging": {"type": "offset", "limit_param": "limit", "offset_param": "offset", "size": 100},
|
|
109
|
+
"max_rows": 10000
|
|
110
|
+
},
|
|
111
|
+
"ptab_proceeding": {
|
|
112
|
+
"path": "/api/v1/patent/trials/proceedings/{trialNumber}",
|
|
113
|
+
"description": "One PTAB trial, e.g. IPR2023-00001.",
|
|
114
|
+
"params": {"trialNumber": {"in": "path", "required": true, "desc": "trial number, e.g. IPR2023-00001"}},
|
|
115
|
+
"records": "patentTrialProceedingDataBag", "paging": {"type": "none"}
|
|
116
|
+
},
|
|
117
|
+
"ptab_decisions_search": {
|
|
118
|
+
"path": "/api/v1/patent/trials/decisions/search",
|
|
119
|
+
"description": "PTAB trial decisions (institution, final written decisions). Not verified with a key.",
|
|
120
|
+
"params": {"q": {"desc": "query"}, "filters": {"desc": "'field value1,value2'"},
|
|
121
|
+
"rangeFilters": {"desc": "'field from:to'"}, "sort": {"desc": "'field asc|desc'"}, "fields": {"desc": "fields"}},
|
|
122
|
+
"records": "patentTrialDecisionDataBag", "total": "count",
|
|
123
|
+
"paging": {"type": "offset", "limit_param": "limit", "offset_param": "offset", "size": 100},
|
|
124
|
+
"max_rows": 10000
|
|
125
|
+
}
|
|
126
|
+
},
|
|
127
|
+
"catalog": {
|
|
128
|
+
"type_codes": {"id": "applicationMetaData.applicationTypeCode", "name": "Application type codes",
|
|
129
|
+
"description": "UTL utility, DES design, PLT plant, PPA provisional, REI reissue (filter: 'applicationMetaData.applicationTypeCode UTL')",
|
|
130
|
+
"endpoint": "applications_search"},
|
|
131
|
+
"status_patented": {"id": "applicationMetaData.applicationStatusCode:150", "name": "Status 150 Patented Case",
|
|
132
|
+
"description": "status code 150 = Patented Case (from the documented example); read applicationStatusDescriptionText for other codes",
|
|
133
|
+
"endpoint": "applications_search"},
|
|
134
|
+
"trial_types": {"id": "IPR PGR CBM DER", "name": "PTAB trial types",
|
|
135
|
+
"description": "IPR inter partes review, PGR post-grant review, CBM covered business method, DER derivation",
|
|
136
|
+
"endpoint": "ptab_proceedings_search"},
|
|
137
|
+
"bulk_grant_xml": {"id": "PTGRXML", "name": "Patent grant full text XML (weekly)",
|
|
138
|
+
"description": "bulk product: weekly patent grant full text (XML); APPXML = pre-grant publications",
|
|
139
|
+
"endpoint": "dataset_product"}
|
|
140
|
+
}
|
|
141
|
+
}
|
|
@@ -0,0 +1,95 @@
|
|
|
1
|
+
{
|
|
2
|
+
"id": "uspto",
|
|
3
|
+
"title": "USPTO Open Data Portal (patent applications, PTAB, petitions, bulk datasets)",
|
|
4
|
+
"agency": "United States Patent and Trademark Office (U.S. Department of Commerce)",
|
|
5
|
+
"depth": "standard",
|
|
6
|
+
"domains": [
|
|
7
|
+
"patents",
|
|
8
|
+
"innovation",
|
|
9
|
+
"intellectual property",
|
|
10
|
+
"research"
|
|
11
|
+
],
|
|
12
|
+
"keywords": [
|
|
13
|
+
"patent",
|
|
14
|
+
"patents",
|
|
15
|
+
"patent application",
|
|
16
|
+
"uspto",
|
|
17
|
+
"inventor",
|
|
18
|
+
"assignee",
|
|
19
|
+
"assignment",
|
|
20
|
+
"grant",
|
|
21
|
+
"granted patents",
|
|
22
|
+
"cpc",
|
|
23
|
+
"continuation",
|
|
24
|
+
"prosecution",
|
|
25
|
+
"ptab",
|
|
26
|
+
"inter partes review",
|
|
27
|
+
"ipr",
|
|
28
|
+
"petition",
|
|
29
|
+
"patent term adjustment",
|
|
30
|
+
"file wrapper",
|
|
31
|
+
"intellectual property",
|
|
32
|
+
"innovation"
|
|
33
|
+
],
|
|
34
|
+
"questions": [
|
|
35
|
+
"patents granted to a company in a year",
|
|
36
|
+
"status and history of a patent application",
|
|
37
|
+
"who owns a patent (assignments)",
|
|
38
|
+
"PTAB inter partes review proceedings for a patent",
|
|
39
|
+
"patent applications filed in a CPC class over time"
|
|
40
|
+
],
|
|
41
|
+
"homepage": "https://data.uspto.gov/",
|
|
42
|
+
"terms_url": "https://www.uspto.gov/terms-use-uspto-websites",
|
|
43
|
+
"auth": {
|
|
44
|
+
"env": "USPTO_API_KEY",
|
|
45
|
+
"required": "required",
|
|
46
|
+
"placement": "header",
|
|
47
|
+
"param": "X-API-KEY",
|
|
48
|
+
"prefix": "",
|
|
49
|
+
"home": "uspto",
|
|
50
|
+
"signup_url": "https://data.uspto.gov/apis/getting-started",
|
|
51
|
+
"echoes_key": false,
|
|
52
|
+
"key_only": [
|
|
53
|
+
"every ODP API call"
|
|
54
|
+
]
|
|
55
|
+
},
|
|
56
|
+
"limits": {
|
|
57
|
+
"rps": 4,
|
|
58
|
+
"burst": 1,
|
|
59
|
+
"daily_quota": null,
|
|
60
|
+
"max_rows": 10000
|
|
61
|
+
},
|
|
62
|
+
"routes": {
|
|
63
|
+
"api": {
|
|
64
|
+
"base": "https://api.uspto.gov",
|
|
65
|
+
"probe": "https://api.uspto.gov/api/v1/patent/applications/search?q=applicationNumberText:14412875&limit=1&fields=applicationNumberText",
|
|
66
|
+
"hosts": [
|
|
67
|
+
"api.uspto.gov"
|
|
68
|
+
]
|
|
69
|
+
},
|
|
70
|
+
"manual": {
|
|
71
|
+
"how": "The ODP API needs a key in the X-API-KEY header, so browser links do not work: on your own computer run download_data.sh / download_data.ps1 from manual_download/ (one command; it asks for USPTO_API_KEY with hidden input), then upload the JSON files. Without a key: sign in at https://data.uspto.gov (USPTO.gov account with MFA, required since 2026-06-18), open Patent File Wrapper search (https://data.uspto.gov/patent-file-wrapper/search), run the query, download the results as JSON or CSV and upload them."
|
|
72
|
+
}
|
|
73
|
+
},
|
|
74
|
+
"cache": {
|
|
75
|
+
"mode": "run_only",
|
|
76
|
+
"ttl_hours": null,
|
|
77
|
+
"why": "Application data are refreshed daily; data/ is reused within a run."
|
|
78
|
+
},
|
|
79
|
+
"redistribution": {
|
|
80
|
+
"mode": "allowed",
|
|
81
|
+
"why": "Patent bibliographic data published by the USPTO are U.S. government information, not subject to copyright (17 U.S.C. 105; USPTO terms of use at https://www.uspto.gov/terms-use-uspto-websites). Records name inventors, attorneys and addresses: report aggregates, not people."
|
|
82
|
+
},
|
|
83
|
+
"notices": [],
|
|
84
|
+
"retention": null,
|
|
85
|
+
"citation": "United States Patent and Trademark Office, Open Data Portal API, {dataset}, api.uspto.gov, retrieved {retrieved_long}.",
|
|
86
|
+
"audit_hooks": [],
|
|
87
|
+
"clarify": [
|
|
88
|
+
"Count by filing date, publication date or grant date? They differ by years; say which date defines the period.",
|
|
89
|
+
"Applications or granted patents? Search returns both; filter on grant (applicationMetaData.patentNumber present, or status 150) for grants.",
|
|
90
|
+
"Count organizations by first applicant or by current assignee? Ownership changes after filing (assignments)."
|
|
91
|
+
],
|
|
92
|
+
"formats": [
|
|
93
|
+
"json"
|
|
94
|
+
]
|
|
95
|
+
}
|
|
@@ -0,0 +1,101 @@
|
|
|
1
|
+
# USPTO Open Data Portal (patent applications, PTAB, petitions, bulk datasets)
|
|
2
|
+
Depth: standard. Key: required (USPTO_API_KEY). U.S. patent applications and grants from the Patent File
|
|
3
|
+
Wrapper (bibliographic data, status, prosecution events, continuity, assignments, term adjustment), PTAB
|
|
4
|
+
trials, final petition decisions, and the bulk-dataset directory, via api.uspto.gov.
|
|
5
|
+
|
|
6
|
+
## When to use
|
|
7
|
+
- Patents or applications by company, inventor, CPC class, filing or grant date; the status and history
|
|
8
|
+
of one application; ownership (assignments); continuation families; PTAB IPR/PGR trials; petitions.
|
|
9
|
+
- Not here: trademarks (not in this pack), full patent text search (USPTO Patent Public Search at
|
|
10
|
+
https://ppubs.uspto.gov, a web tool), patent counts by state or country as official statistics (USPTO
|
|
11
|
+
PTMT reports, not covered), R&D spending (nsf or bea packs if present).
|
|
12
|
+
- Counts built from search results are your own tabulations, not official USPTO statistics: say so.
|
|
13
|
+
|
|
14
|
+
## Endpoints and datasets
|
|
15
|
+
| Endpoint | Returns | Key parameters |
|
|
16
|
+
|---|---|---|
|
|
17
|
+
| `applications_search` | applications/grants matching a query, one row each | `q`, `filters`, `rangeFilters`, `sort`, `fields`, `facets` |
|
|
18
|
+
| `application` | everything for one application | `applicationNumberText` (digits) |
|
|
19
|
+
| `application_meta_data`, `_continuity`, `_assignment`, `_transactions`, `_adjustment`, `_foreign_priority`, `_attorney` | one section of an application | `applicationNumberText` |
|
|
20
|
+
| `application_documents` | documents in the file wrapper (codes, dates, download links) | `applicationNumberText`, `documentCodes`, `officialDateFrom/To` |
|
|
21
|
+
| `datasets_search` / `dataset_product` | bulk products (grant XML PTGRXML, pre-grant APPXML, assignments, research data) and their files | `q`, `productIdentifier`, `fileDataFromDate/ToDate` |
|
|
22
|
+
| `petition_decisions_search` | final petition decisions | `q`, `filters`, `rangeFilters`, `sort` |
|
|
23
|
+
| `ptab_proceedings_search` / `ptab_proceeding` | PTAB trials (IPR, PGR, CBM, DER) | `q`, `trialNumber` (IPR2023-00001) |
|
|
24
|
+
| `ptab_decisions_search` | PTAB trial decisions | `q` |
|
|
25
|
+
|
|
26
|
+
Search syntax (`q`): free text; `field:value`; `AND` `OR` `NOT`; wildcards `*` `?`; phrases in double
|
|
27
|
+
quotes; ranges `applicationMetaData.filingDate:[2024-01-01 TO 2024-12-31]`; comparisons
|
|
28
|
+
`applicationMetaData.applicationStatusCode:>600`. `filters` is `'field v1,v2'` (values OR-ed, filters
|
|
29
|
+
AND-ed); `rangeFilters` is `'field from:to'` (dates and numbers only). Field names are dotted paths, e.g.
|
|
30
|
+
`applicationMetaData.firstApplicantName`, `applicationMetaData.cpcClassificationBag`,
|
|
31
|
+
`applicationMetaData.grantDate`, `applicationMetaData.applicationTypeCode` (UTL, DES, PLT, PPA, REI).
|
|
32
|
+
Field dictionary: https://data.uspto.gov/documents/documents/patent-data-schema.json (sign-in needed).
|
|
33
|
+
`request_schema` with `search: "trial"` lists the catalog notes (type codes, trial types, bulk product ids).
|
|
34
|
+
|
|
35
|
+
## Spec examples
|
|
36
|
+
```json
|
|
37
|
+
{"description": "Utility patents granted to one applicant in 2024 (selected fields)",
|
|
38
|
+
"requests": [{"name": "pacbio_2024_grants", "endpoint": "applications_search",
|
|
39
|
+
"params": {"q": "applicationMetaData.firstApplicantName:\"Pacific Biosciences of California, Inc.\"",
|
|
40
|
+
"filters": "applicationMetaData.applicationTypeCode UTL",
|
|
41
|
+
"rangeFilters": "applicationMetaData.grantDate 2024-01-01:2024-12-31",
|
|
42
|
+
"fields": "applicationNumberText,applicationMetaData.patentNumber,applicationMetaData.grantDate,applicationMetaData.inventionTitle,applicationMetaData.cpcClassificationBag",
|
|
43
|
+
"sort": "applicationMetaData.grantDate asc"}, "max_rows": 2000}]}
|
|
44
|
+
```
|
|
45
|
+
```json
|
|
46
|
+
{"description": "One application: record, prosecution history, continuity",
|
|
47
|
+
"requests": [{"name": "app", "endpoint": "application", "params": {"applicationNumberText": "14412875"}},
|
|
48
|
+
{"name": "app_events", "endpoint": "application_transactions", "params": {"applicationNumberText": "14412875"}},
|
|
49
|
+
{"name": "app_family", "endpoint": "application_continuity", "params": {"applicationNumberText": "14412875"}}]}
|
|
50
|
+
```
|
|
51
|
+
```json
|
|
52
|
+
{"description": "IPR trials numbered IPR2024-* (PTAB query form not verified with a key)",
|
|
53
|
+
"requests": [{"name": "ipr_2024", "endpoint": "ptab_proceedings_search",
|
|
54
|
+
"params": {"q": "IPR2024*"}, "max_rows": 3000}]}
|
|
55
|
+
```
|
|
56
|
+
Do not set `limit`/`offset`: paging is automatic (100 per page); cap with `max_rows`.
|
|
57
|
+
|
|
58
|
+
## Data format and traps
|
|
59
|
+
- Records are deeply nested. The CSV flattens objects into dotted columns
|
|
60
|
+
(`applicationMetaData.patentNumber`); lists of objects (`inventorBag`, `assignmentBag`,
|
|
61
|
+
`eventDataBag`, `parentContinuityBag`) become JSON text in one cell, and lists of strings
|
|
62
|
+
(`cpcClassificationBag`) become "; "-joined text. `compute` does not unpack them: work from the flat
|
|
63
|
+
columns, or (local mode) parse them with your own code and save the result as a CSV before citing it. Use
|
|
64
|
+
`fields` to keep rows small.
|
|
65
|
+
- One row per application, not per patent: an application without `patentNumber` was not granted (yet).
|
|
66
|
+
Status is a code plus `applicationStatusDescriptionText` ("Patented Case" = 150).
|
|
67
|
+
- Dates are ISO (YYYY-MM-DD). Filing, effective filing, earliest publication and grant dates differ by
|
|
68
|
+
years; continuations share an effective filing date with their parent. Pick one and say which.
|
|
69
|
+
- Applicant and assignee names are free text with variants ("Inc." vs "INC.", subsidiaries). Group names
|
|
70
|
+
deliberately; the first applicant is not always the current owner (check `assignmentBag`).
|
|
71
|
+
- Recent years are incomplete: applications publish about 18 months after filing, so filing-year counts
|
|
72
|
+
for the last two years undercount.
|
|
73
|
+
- Coverage of older applications in ODP is uneven (older third-party docs say filings since 2001);
|
|
74
|
+
unverified for the current release: check counts before analysing pre-2001 years.
|
|
75
|
+
- `facets` counts come back in the response body, not as rows; the generic fetch keeps only rows.
|
|
76
|
+
- Unverified (no key when built): the maximum page size (the pack uses 100), the GET form and record keys
|
|
77
|
+
of the PTAB endpoints (`patentTrialProceedingDataBag`, `patentTrialDecisionDataBag`), and `documentBag`. The search response shape is verified from USPTO's documented example.
|
|
78
|
+
If a PTAB request fails with HTTP 400/404, report it and use the ODP web search instead.
|
|
79
|
+
- Records name inventors, attorneys, examiners and addresses (published by law). Report aggregates.
|
|
80
|
+
|
|
81
|
+
## Access
|
|
82
|
+
Key required for every call: a free ODP API key, sent in the `X-API-KEY` header. Getting one needs a
|
|
83
|
+
USPTO.gov account with multi-factor authentication and an ID.me identity check
|
|
84
|
+
(https://data.uspto.gov/apis/getting-started). Since 2026-10-08 keys of accounts missing the extra profile
|
|
85
|
+
fields are deactivated; reactivate under Manage API Key. Without a key, `fetch` stops with `key_missing`:
|
|
86
|
+
the user stores the key with `npx -y data-analyst-mcp setup uspto` in their own terminal (never in chat), or
|
|
87
|
+
uses `manual_bundle`.
|
|
88
|
+
Limits (USPTO rate-limits page): one request at a time per key (parallel calls with the same key are
|
|
89
|
+
blocked), 4 to 15 requests a second, 5 million metadata calls and 1.2 million document calls a week,
|
|
90
|
+
reset Sunday 00:00 UTC; on HTTP 429 wait at least 5 seconds. The pack sends 4 a second, never in parallel.
|
|
91
|
+
Manual: browser links cannot send the header, so the `manual_download/` folder that `manual_bundle` writes holds
|
|
92
|
+
scripts (`download_data.sh`, `.ps1`; one command) that ask for USPTO_API_KEY with hidden input on the
|
|
93
|
+
user's computer and save the JSON files; upload them, then `ingest`. Without a key: sign in at
|
|
94
|
+
https://data.uspto.gov (required since 2026-06-18), use the Patent File Wrapper search page, save the results, and upload them. Bulk XML files
|
|
95
|
+
(PTGRXML, APPXML) are listed by `datasets_search`; this pack does not parse them.
|
|
96
|
+
|
|
97
|
+
## Citation and terms
|
|
98
|
+
"United States Patent and Trademark Office, Open Data Portal API, <endpoint/query>, api.uspto.gov,
|
|
99
|
+
retrieved <date>." Patent bibliographic data are U.S. government information, not subject to copyright
|
|
100
|
+
(USPTO terms of use: https://www.uspto.gov/terms-use-uspto-websites). Redistribution allowed; keep
|
|
101
|
+
personal names out of published tables unless the question is about them.
|