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,237 @@
|
|
|
1
|
+
{
|
|
2
|
+
"base_url": "https://data.sec.gov",
|
|
3
|
+
"endpoints": {
|
|
4
|
+
"company_search": {
|
|
5
|
+
"path": "https://efts.sec.gov/LATEST/search-index",
|
|
6
|
+
"method": "GET",
|
|
7
|
+
"description": "Find companies (and people) by ticker or name: cik, name, tickers (EDGAR's search-box index).",
|
|
8
|
+
"params": {
|
|
9
|
+
"text": {
|
|
10
|
+
"required": true,
|
|
11
|
+
"desc": "ticker or name, e.g. 'AAPL' or 'apple'"
|
|
12
|
+
}
|
|
13
|
+
},
|
|
14
|
+
"records": "hits.hits",
|
|
15
|
+
"paging": {
|
|
16
|
+
"type": "none"
|
|
17
|
+
}
|
|
18
|
+
},
|
|
19
|
+
"submissions": {
|
|
20
|
+
"path": "/submissions/CIK{cik10}.json",
|
|
21
|
+
"method": "GET",
|
|
22
|
+
"description": "A company's filing history: one row per filing (form, filingDate, reportDate, accessionNumber, primaryDocument, url), newest first; profile columns cik, entity_name, sic.",
|
|
23
|
+
"params": {
|
|
24
|
+
"cik": {
|
|
25
|
+
"desc": "CIK number (any length; zero-padded to 10 digits)"
|
|
26
|
+
},
|
|
27
|
+
"ticker": {
|
|
28
|
+
"desc": "ticker (AAPL, BRK-B) or company name; resolved to a CIK with EDGAR's company search"
|
|
29
|
+
},
|
|
30
|
+
"forms": {
|
|
31
|
+
"desc": "comma-separated forms to keep, e.g. '10-K,10-Q' (amendments 10-K/A kept only if listed)"
|
|
32
|
+
},
|
|
33
|
+
"since": {
|
|
34
|
+
"desc": "keep filings on or after YYYY-MM-DD"
|
|
35
|
+
},
|
|
36
|
+
"all": {
|
|
37
|
+
"desc": "true = also read the older-filings files (filings.files); otherwise the latest 1,000 or so"
|
|
38
|
+
}
|
|
39
|
+
},
|
|
40
|
+
"records": "filings.recent",
|
|
41
|
+
"paging": {
|
|
42
|
+
"type": "none"
|
|
43
|
+
}
|
|
44
|
+
},
|
|
45
|
+
"company_concept": {
|
|
46
|
+
"path": "/api/xbrl/companyconcept/CIK{cik10}/{taxonomy}/{tag}.json",
|
|
47
|
+
"method": "GET",
|
|
48
|
+
"description": "Every value one company reported for one XBRL concept: one row per fact (start, end, period_days, val, unit, fy, fp, form, filed, accn, frame).",
|
|
49
|
+
"params": {
|
|
50
|
+
"cik": {
|
|
51
|
+
"desc": "CIK number (any length; zero-padded to 10 digits)"
|
|
52
|
+
},
|
|
53
|
+
"ticker": {
|
|
54
|
+
"desc": "ticker (AAPL, BRK-B) or company name; resolved to a CIK with EDGAR's company search"
|
|
55
|
+
},
|
|
56
|
+
"tag": {
|
|
57
|
+
"required": true,
|
|
58
|
+
"desc": "XBRL concept, e.g. NetIncomeLoss, Revenues, Assets (case-sensitive)"
|
|
59
|
+
},
|
|
60
|
+
"taxonomy": {
|
|
61
|
+
"desc": "us-gaap (default), ifrs-full, dei, srt"
|
|
62
|
+
},
|
|
63
|
+
"unit": {
|
|
64
|
+
"desc": "unit to keep: USD, shares, USD/shares, pure (default: all); USD-per-shares is accepted and sent as USD/shares"
|
|
65
|
+
},
|
|
66
|
+
"forms": {
|
|
67
|
+
"desc": "comma-separated forms to keep, e.g. '10-K' (prefix match: 10-K keeps 10-K/A)"
|
|
68
|
+
},
|
|
69
|
+
"frames_only": {
|
|
70
|
+
"desc": "true = one value per period: the framed fact, or the latest filed when SEC gave a period of the series' own length (annual, quarter, instant) no frame; other lengths (YTD) are skipped"
|
|
71
|
+
},
|
|
72
|
+
"duration": {
|
|
73
|
+
"desc": "annual (350-380 days) or quarter (80-100 days): keep duration facts of that length (period_days column); instant facts are dropped"
|
|
74
|
+
}
|
|
75
|
+
},
|
|
76
|
+
"defaults": {
|
|
77
|
+
"taxonomy": "us-gaap"
|
|
78
|
+
},
|
|
79
|
+
"records": "units",
|
|
80
|
+
"paging": {
|
|
81
|
+
"type": "none"
|
|
82
|
+
}
|
|
83
|
+
},
|
|
84
|
+
"company_facts": {
|
|
85
|
+
"path": "/api/xbrl/companyfacts/CIK{cik10}.json",
|
|
86
|
+
"method": "GET",
|
|
87
|
+
"description": "Every XBRL fact a company reported, all concepts: one row per fact with taxonomy and tag columns (large: tens of thousands of rows for big filers; set tags).",
|
|
88
|
+
"params": {
|
|
89
|
+
"cik": {
|
|
90
|
+
"desc": "CIK number (any length; zero-padded to 10 digits)"
|
|
91
|
+
},
|
|
92
|
+
"ticker": {
|
|
93
|
+
"desc": "ticker (AAPL, BRK-B) or company name; resolved to a CIK with EDGAR's company search"
|
|
94
|
+
},
|
|
95
|
+
"tags": {
|
|
96
|
+
"desc": "comma-separated concepts to keep, e.g. 'Revenues,NetIncomeLoss,Assets'"
|
|
97
|
+
},
|
|
98
|
+
"taxonomy": {
|
|
99
|
+
"desc": "keep one taxonomy (us-gaap, dei, ifrs-full)"
|
|
100
|
+
},
|
|
101
|
+
"forms": {
|
|
102
|
+
"desc": "comma-separated forms to keep (prefix match)"
|
|
103
|
+
},
|
|
104
|
+
"unit": {
|
|
105
|
+
"desc": "unit to keep: USD, shares, USD/shares, pure (default: all); USD-per-shares is accepted and sent as USD/shares"
|
|
106
|
+
},
|
|
107
|
+
"frames_only": {
|
|
108
|
+
"desc": "true = one value per period: the framed fact, or the latest filed when SEC gave a period of the series' own length (annual, quarter, instant) no frame; other lengths (YTD) are skipped"
|
|
109
|
+
},
|
|
110
|
+
"duration": {
|
|
111
|
+
"desc": "annual (350-380 days) or quarter (80-100 days): keep duration facts of that length (period_days column); instant facts are dropped"
|
|
112
|
+
}
|
|
113
|
+
},
|
|
114
|
+
"records": "facts",
|
|
115
|
+
"paging": {
|
|
116
|
+
"type": "none"
|
|
117
|
+
}
|
|
118
|
+
},
|
|
119
|
+
"frames": {
|
|
120
|
+
"path": "/api/xbrl/frames/{taxonomy}/{tag}/{unit}/{period}.json",
|
|
121
|
+
"method": "GET",
|
|
122
|
+
"description": "One concept for every reporting company in one calendar period: one row per company (cik, entityName, loc, start, end, val, accn).",
|
|
123
|
+
"params": {
|
|
124
|
+
"tag": {
|
|
125
|
+
"required": true,
|
|
126
|
+
"desc": "XBRL concept, e.g. Assets"
|
|
127
|
+
},
|
|
128
|
+
"period": {
|
|
129
|
+
"required": true,
|
|
130
|
+
"desc": "CY2023 (annual), CY2023Q1 (quarter), CY2023Q4I (instant: balance-sheet items)"
|
|
131
|
+
},
|
|
132
|
+
"unit": {
|
|
133
|
+
"desc": "USD (default), shares, USD-per-shares, pure; USD/shares is accepted and sent as USD-per-shares"
|
|
134
|
+
},
|
|
135
|
+
"taxonomy": {
|
|
136
|
+
"desc": "us-gaap (default)"
|
|
137
|
+
}
|
|
138
|
+
},
|
|
139
|
+
"defaults": {
|
|
140
|
+
"taxonomy": "us-gaap",
|
|
141
|
+
"unit": "USD"
|
|
142
|
+
},
|
|
143
|
+
"records": "data",
|
|
144
|
+
"paging": {
|
|
145
|
+
"type": "none"
|
|
146
|
+
}
|
|
147
|
+
},
|
|
148
|
+
"full_text_search": {
|
|
149
|
+
"path": "https://efts.sec.gov/LATEST/search-index",
|
|
150
|
+
"method": "GET",
|
|
151
|
+
"description": "EDGAR full-text search (2001-): one row per matching DOCUMENT (a filing's main file and each exhibit are separate hits): adsh, form, file_date, entity, file_type, url.",
|
|
152
|
+
"params": {
|
|
153
|
+
"q": {
|
|
154
|
+
"required": true,
|
|
155
|
+
"desc": "words; quote phrases: '\"climate risk\"'; AND/OR/NOT supported"
|
|
156
|
+
},
|
|
157
|
+
"forms": {
|
|
158
|
+
"desc": "comma-separated forms, e.g. '10-K' or '8-K,8-K/A'"
|
|
159
|
+
},
|
|
160
|
+
"startdt": {
|
|
161
|
+
"desc": "YYYY-MM-DD"
|
|
162
|
+
},
|
|
163
|
+
"enddt": {
|
|
164
|
+
"desc": "YYYY-MM-DD"
|
|
165
|
+
},
|
|
166
|
+
"ciks": {
|
|
167
|
+
"desc": "limit to one company: 10-digit CIK"
|
|
168
|
+
}
|
|
169
|
+
},
|
|
170
|
+
"records": "hits.hits",
|
|
171
|
+
"paging": {
|
|
172
|
+
"type": "none"
|
|
173
|
+
},
|
|
174
|
+
"max_rows": 10000
|
|
175
|
+
},
|
|
176
|
+
"insider_filings": {
|
|
177
|
+
"path": "https://efts.sec.gov/LATEST/search-index",
|
|
178
|
+
"method": "GET",
|
|
179
|
+
"description": "Insider ownership filings (Form 4 by default; 3, 5) where the company is the issuer: one row per filing with insider name and CIK, filing and period dates, link.",
|
|
180
|
+
"params": {
|
|
181
|
+
"cik": {
|
|
182
|
+
"desc": "CIK number (any length; zero-padded to 10 digits)"
|
|
183
|
+
},
|
|
184
|
+
"ticker": {
|
|
185
|
+
"desc": "ticker (AAPL, BRK-B) or company name; resolved to a CIK with EDGAR's company search"
|
|
186
|
+
},
|
|
187
|
+
"forms": {
|
|
188
|
+
"desc": "4 (default), 3, 5 or a comma list"
|
|
189
|
+
},
|
|
190
|
+
"startdt": {
|
|
191
|
+
"desc": "YYYY-MM-DD"
|
|
192
|
+
},
|
|
193
|
+
"enddt": {
|
|
194
|
+
"desc": "YYYY-MM-DD"
|
|
195
|
+
}
|
|
196
|
+
},
|
|
197
|
+
"defaults": {
|
|
198
|
+
"forms": "4"
|
|
199
|
+
},
|
|
200
|
+
"records": "hits.hits",
|
|
201
|
+
"paging": {
|
|
202
|
+
"type": "none"
|
|
203
|
+
},
|
|
204
|
+
"max_rows": 10000
|
|
205
|
+
}
|
|
206
|
+
},
|
|
207
|
+
"catalog": {},
|
|
208
|
+
"concepts": {
|
|
209
|
+
"Revenues": "Total revenue (many companies use RevenueFromContractWithCustomerExcludingAssessedTax instead)",
|
|
210
|
+
"RevenueFromContractWithCustomerExcludingAssessedTax": "Revenue from contracts with customers (ASC 606, 2018-)",
|
|
211
|
+
"NetIncomeLoss": "Net income (loss) attributable to the parent",
|
|
212
|
+
"OperatingIncomeLoss": "Operating income (loss)",
|
|
213
|
+
"GrossProfit": "Gross profit",
|
|
214
|
+
"Assets": "Total assets (instant)",
|
|
215
|
+
"Liabilities": "Total liabilities (instant; not reported by every filer)",
|
|
216
|
+
"LiabilitiesAndStockholdersEquity": "Total liabilities and equity (instant)",
|
|
217
|
+
"StockholdersEquity": "Total stockholders' equity (instant)",
|
|
218
|
+
"CashAndCashEquivalentsAtCarryingValue": "Cash and cash equivalents (instant)",
|
|
219
|
+
"LongTermDebt": "Long-term debt (instant)",
|
|
220
|
+
"EarningsPerShareBasic": "Basic EPS (unit USD/shares)",
|
|
221
|
+
"EarningsPerShareDiluted": "Diluted EPS (unit USD/shares)",
|
|
222
|
+
"CommonStockSharesOutstanding": "Common shares outstanding (unit shares)",
|
|
223
|
+
"EntityCommonStockSharesOutstanding": "dei: shares outstanding on the cover page",
|
|
224
|
+
"Goodwill": "Goodwill (instant)",
|
|
225
|
+
"GoodwillImpairmentLoss": "Goodwill impairment loss",
|
|
226
|
+
"ResearchAndDevelopmentExpense": "R&D expense",
|
|
227
|
+
"SellingGeneralAndAdministrativeExpense": "SG&A expense",
|
|
228
|
+
"InterestExpense": "Interest expense",
|
|
229
|
+
"IncomeTaxExpenseBenefit": "Income tax expense (benefit)",
|
|
230
|
+
"NetCashProvidedByUsedInOperatingActivities": "Operating cash flow",
|
|
231
|
+
"PaymentsForRepurchaseOfCommonStock": "Share buybacks",
|
|
232
|
+
"PaymentsOfDividends": "Dividends paid"
|
|
233
|
+
},
|
|
234
|
+
"headers": {
|
|
235
|
+
"Accept": "application/json"
|
|
236
|
+
}
|
|
237
|
+
}
|
|
@@ -0,0 +1,86 @@
|
|
|
1
|
+
{
|
|
2
|
+
"id": "sec",
|
|
3
|
+
"title": "SEC EDGAR (XBRL financial data, filings, full-text search)",
|
|
4
|
+
"agency": "U.S. Securities and Exchange Commission",
|
|
5
|
+
"depth": "standard",
|
|
6
|
+
"domains": [
|
|
7
|
+
"finance",
|
|
8
|
+
"corporations",
|
|
9
|
+
"securities"
|
|
10
|
+
],
|
|
11
|
+
"keywords": [
|
|
12
|
+
"sec",
|
|
13
|
+
"edgar",
|
|
14
|
+
"10-k",
|
|
15
|
+
"10-q",
|
|
16
|
+
"8-k",
|
|
17
|
+
"annual report",
|
|
18
|
+
"public company",
|
|
19
|
+
"company financials",
|
|
20
|
+
"revenue",
|
|
21
|
+
"net income",
|
|
22
|
+
"earnings per share",
|
|
23
|
+
"total assets",
|
|
24
|
+
"xbrl",
|
|
25
|
+
"filings",
|
|
26
|
+
"insider trading",
|
|
27
|
+
"form 4",
|
|
28
|
+
"full-text search",
|
|
29
|
+
"cik",
|
|
30
|
+
"ticker"
|
|
31
|
+
],
|
|
32
|
+
"questions": [
|
|
33
|
+
"a public company's annual revenue and net income over ten years",
|
|
34
|
+
"total assets of every public company in 2023",
|
|
35
|
+
"which 10-K filings mention climate risk",
|
|
36
|
+
"recent insider (Form 4) filings for a company",
|
|
37
|
+
"list of a company's 8-K filings since 2024"
|
|
38
|
+
],
|
|
39
|
+
"homepage": "https://www.sec.gov/search-filings/edgar-application-programming-interfaces",
|
|
40
|
+
"terms_url": "https://www.sec.gov/about/privacy-information#security",
|
|
41
|
+
"auth": {
|
|
42
|
+
"env": null,
|
|
43
|
+
"required": "none",
|
|
44
|
+
"placement": "none",
|
|
45
|
+
"signup_url": null,
|
|
46
|
+
"echoes_key": false
|
|
47
|
+
},
|
|
48
|
+
"limits": {
|
|
49
|
+
"rps": 5,
|
|
50
|
+
"burst": 5,
|
|
51
|
+
"max_rows": 100000
|
|
52
|
+
},
|
|
53
|
+
"routes": {
|
|
54
|
+
"api": {
|
|
55
|
+
"base": "https://data.sec.gov",
|
|
56
|
+
"probe": "https://data.sec.gov/api/xbrl/frames/us-gaap/GoodwillImpairmentLoss/USD/CY2023Q4.json",
|
|
57
|
+
"hosts": [
|
|
58
|
+
"data.sec.gov",
|
|
59
|
+
"efts.sec.gov"
|
|
60
|
+
]
|
|
61
|
+
},
|
|
62
|
+
"manual": {
|
|
63
|
+
"how": "Open the JSON links in INSTRUCTIONS.md in a browser (data.sec.gov and efts.sec.gov accept a browser) and save each under the name shown, or use EDGAR full-text search (https://efts.sec.gov/LATEST/search-index is behind https://www.sec.gov/edgar/search/) and company pages (https://www.sec.gov/edgar/searchedgar/companysearch); upload the files."
|
|
64
|
+
}
|
|
65
|
+
},
|
|
66
|
+
"cache": {
|
|
67
|
+
"mode": "run_only",
|
|
68
|
+
"ttl_hours": null,
|
|
69
|
+
"why": "Filings arrive continuously and companyfacts change with each filing; data/ is reused within a run."
|
|
70
|
+
},
|
|
71
|
+
"redistribution": {
|
|
72
|
+
"mode": "allowed",
|
|
73
|
+
"why": "EDGAR filings are public records and SEC data are U.S. government works (17 U.S.C. 105); SEC's fair-access policy limits request rates, not reuse."
|
|
74
|
+
},
|
|
75
|
+
"notices": [],
|
|
76
|
+
"retention": null,
|
|
77
|
+
"citation": "U.S. Securities and Exchange Commission, EDGAR {dataset}, data.sec.gov, retrieved {retrieved_long}.",
|
|
78
|
+
"audit_hooks": [],
|
|
79
|
+
"clarify": [
|
|
80
|
+
"Fiscal or calendar years? XBRL facts carry the company's fiscal year (fy) and period dates; the frames API realigns to calendar periods.",
|
|
81
|
+
"As first reported or latest restated values? Each 10-K repeats and may restate prior years; frames_only keeps the latest filed value per period."
|
|
82
|
+
],
|
|
83
|
+
"formats": [
|
|
84
|
+
"json"
|
|
85
|
+
]
|
|
86
|
+
}
|
|
@@ -0,0 +1,101 @@
|
|
|
1
|
+
# SEC EDGAR (XBRL financial data, filings, full-text search)
|
|
2
|
+
Depth: standard. Key: none (set SEC_USER_AGENT, see Access). Financial statement values that public
|
|
3
|
+
companies tag in XBRL (2009-), every company's filing history, EDGAR full-text search (2001-) and
|
|
4
|
+
insider ownership filings (Forms 3, 4, 5).
|
|
5
|
+
|
|
6
|
+
## When to use
|
|
7
|
+
- A company's revenue, net income, assets, EPS, cash flow over time (`company_concept`, `company_facts`);
|
|
8
|
+
one line item across all filers for a period, for rankings and screens (`frames`); a company's 10-K,
|
|
9
|
+
10-Q, 8-K list with links (`submissions`); which filings mention a phrase (`full_text_search`);
|
|
10
|
+
insider Form 4 filings for an issuer (`insider_filings`); ticker or name to CIK (`company_search`).
|
|
11
|
+
- Not here: stock prices and market data (not covered); bank Call Reports (fdic: banks file there,
|
|
12
|
+
holding companies file here); consumer complaints about companies (cfpb); federal contracts
|
|
13
|
+
(usaspending). Transaction details inside a Form 4 (shares, prices) are in the linked filing, not here.
|
|
14
|
+
|
|
15
|
+
## Endpoints and datasets
|
|
16
|
+
| Endpoint | Returns (one row per) | Key parameters |
|
|
17
|
+
|---|---|---|
|
|
18
|
+
| `company_concept` | reported fact of one concept | `cik` or `ticker`, `tag`, `taxonomy` (us-gaap), `unit`, `forms`, `frames_only`, `duration` |
|
|
19
|
+
| `company_facts` | fact, all concepts of a company | `cik`/`ticker`, `tags` (comma list), `taxonomy`, `unit`, `forms`, `frames_only`, `duration` |
|
|
20
|
+
| `frames` | company, for one concept and period | `tag`, `period` (CY2023, CY2023Q1, CY2023Q4I), `unit` (USD, shares, USD-per-shares) |
|
|
21
|
+
| `submissions` | filing | `cik`/`ticker`, `forms` ("10-K,10-Q"), `since` (YYYY-MM-DD), `all` (older files too) |
|
|
22
|
+
| `full_text_search` | matching document | `q`, `forms`, `startdt`, `enddt`, `ciks` |
|
|
23
|
+
| `insider_filings` | Form 4 (or 3, 5) filing | `cik`/`ticker`, `forms` (4), `startdt`, `enddt` |
|
|
24
|
+
| `company_search` | matching company or person (none: an empty table with a note, the other requests still run) | `text` |
|
|
25
|
+
Fact rows: cik, entity_name, taxonomy, tag, label, unit, start, end, period_days, val, fy, fp, form,
|
|
26
|
+
filed, accn, frame. Common tags (`request_schema` with `search: "revenue"`): Revenues,
|
|
27
|
+
RevenueFromContractWithCustomerExcludingAssessedTax, NetIncomeLoss, OperatingIncomeLoss, Assets,
|
|
28
|
+
Liabilities, StockholdersEquity, EarningsPerShareDiluted, NetCashProvidedByUsedInOperatingActivities.
|
|
29
|
+
|
|
30
|
+
## Spec examples
|
|
31
|
+
```json
|
|
32
|
+
{"description": "Apple annual net income, one value per fiscal year",
|
|
33
|
+
"requests": [{"name": "aapl_net_income", "endpoint": "company_concept",
|
|
34
|
+
"params": {"ticker": "AAPL", "tag": "NetIncomeLoss", "forms": "10-K", "frames_only": true, "duration": "annual"}}]}
|
|
35
|
+
```
|
|
36
|
+
```json
|
|
37
|
+
{"description": "Goodwill impairment losses reported for calendar Q4 2023, all companies",
|
|
38
|
+
"requests": [{"name": "goodwill_impairment_2023q4", "endpoint": "frames",
|
|
39
|
+
"params": {"tag": "GoodwillImpairmentLoss", "period": "CY2023Q4"}}]}
|
|
40
|
+
```
|
|
41
|
+
```json
|
|
42
|
+
{"description": "8-K documents mentioning goodwill impairment, 1-5 January 2024; Apple Form 4s, Q1 2025",
|
|
43
|
+
"requests": [
|
|
44
|
+
{"name": "goodwill_8k", "endpoint": "full_text_search",
|
|
45
|
+
"params": {"q": "\"goodwill impairment\"", "forms": "8-K", "startdt": "2024-01-01", "enddt": "2024-01-05"}},
|
|
46
|
+
{"name": "aapl_form4", "endpoint": "insider_filings", "params": {"cik": "320193", "startdt": "2025-01-01", "enddt": "2025-03-31"}}]}
|
|
47
|
+
```
|
|
48
|
+
|
|
49
|
+
## Data format and traps
|
|
50
|
+
- Values (`val`) are in the unit shown, unscaled: USD in dollars (Apple's 112010000000 is $112.0
|
|
51
|
+
billion), EPS in USD/shares, counts in shares. Ratio units are spelled differently per endpoint:
|
|
52
|
+
company_concept and company_facts key them `USD/shares` (a `USD-per-shares` filter there keeps
|
|
53
|
+
nothing), while the frames URL needs `USD-per-shares` (`USD/shares` is HTTP 404); verified 2026-10-22.
|
|
54
|
+
The pack accepts either spelling in `unit` and sends the one each endpoint uses; the `unit` column
|
|
55
|
+
always reads `USD/shares`.
|
|
56
|
+
- One fact appears many times: each 10-K repeats prior years (and 10-Ks contain Q4-only durations),
|
|
57
|
+
so a raw concept has several rows per period. For a clean annual series use `forms: "10-K"`,
|
|
58
|
+
`frames_only: true` (one value per period, the latest filed) and `duration: "annual"` (350-380
|
|
59
|
+
day facts; `period_days` shows the length). Instant (balance-sheet) facts have no `start`.
|
|
60
|
+
SEC leaves many periods without any framed fact (two retailers' last 5-6 fiscal years, checked
|
|
61
|
+
2026-10-28), so `frames_only` keeps the framed fact where there is one and otherwise the latest-filed
|
|
62
|
+
fact of that period (its `frame` is empty), but only for lengths the series has (annual, quarter, instant,
|
|
63
|
+
from the framed facts or `duration`): unframed 6- and 9-month year-to-date facts overlap and are skipped.
|
|
64
|
+
The fetch notes how many periods were restored and skipped.
|
|
65
|
+
- `fy` and `fp` describe the FILING, not the fact: Apple's fiscal 2007 net income carries fy 2009 from a
|
|
66
|
+
10-K/A. Label periods by `end` (or `frame`), never by `fy`.
|
|
67
|
+
- Fiscal vs calendar: `frame` (CY2023, CY2023Q4, CY2023Q4I) maps each fact to the nearest calendar
|
|
68
|
+
period; Apple's fiscal year ending 2023-09-30 is frame CY2023. `frames` compares companies with
|
|
69
|
+
different fiscal years in the same calendar slot; say so when ranking.
|
|
70
|
+
- Tags differ across companies and years: revenue is `Revenues` for some filers and
|
|
71
|
+
`RevenueFromContractWithCustomerExcludingAssessedTax` (ASC 606, 2018-) for others; `Liabilities` is
|
|
72
|
+
missing for many filers (use LiabilitiesAndStockholdersEquity minus StockholdersEquity and say so).
|
|
73
|
+
Tags are case-sensitive; a tag the company never used answers 404: the fetch still runs every other
|
|
74
|
+
request and names each missing one. To try several candidate tags at once, use `company_facts` with
|
|
75
|
+
`tags` (it notes the ones not reported), or mark the uncertain requests `"allow_empty": true`.
|
|
76
|
+
- `frames` lists only companies that tagged that concept for that exact period; absence is not zero.
|
|
77
|
+
- Full-text search returns documents, not filings: a filing's main document and each exhibit are
|
|
78
|
+
separate rows (same `adsh`). Count distinct `adsh` for filings. The index returns at most 10,000
|
|
79
|
+
hits (100 per page); totals of 10,000 mean "10,000 or more". Coverage starts in 2001.
|
|
80
|
+
- `submissions` holds about the latest 1,000 filings (Apple: 1,001 back to 2015); `all: true` also
|
|
81
|
+
reads the older files (Apple: one more file, 1994-2015).
|
|
82
|
+
- Insider rows give the reporting owner's name and CIK; the trade itself is in the filing (index_url).
|
|
83
|
+
- EDGAR search sometimes answers HTTP 200 with an error body ("errorType"); the pack reports it as an
|
|
84
|
+
error. Retry after a minute.
|
|
85
|
+
|
|
86
|
+
## Access
|
|
87
|
+
No key. SEC's fair-access policy asks automated tools to declare who they are with a contact email in
|
|
88
|
+
the User-Agent and to stay under 10 requests a second (this pack sends at most 5). Set
|
|
89
|
+
`SEC_USER_AGENT` (environment variable, or "env" in keys.json or Claude Code's settings.json) to e.g.
|
|
90
|
+
`"Jane Analyst jane.analyst@example.org"`; without it the pack sends a generic tool name, which
|
|
91
|
+
data.sec.gov and efts.sec.gov accepted in 2026-10 but SEC may block. The pack never sends a GitHub
|
|
92
|
+
URL (SEC answers 403 to those). Tickers are resolved with EDGAR's company search (efts), because
|
|
93
|
+
www.sec.gov/files/company_tickers.json refuses User-Agents without an email.
|
|
94
|
+
Manual: `manual_bundle`'s INSTRUCTIONS.md lists the data.sec.gov / efts JSON links (a browser sends its own
|
|
95
|
+
User-Agent); save each under the name shown, upload, then `ingest`. Requests that use a ticker need the CIK for
|
|
96
|
+
the manual links: find it at https://www.sec.gov/edgar/searchedgar/companysearch.
|
|
97
|
+
|
|
98
|
+
## Citation and terms
|
|
99
|
+
"U.S. Securities and Exchange Commission, EDGAR <API> (<company or concept>), data.sec.gov, retrieved
|
|
100
|
+
<date>." Filings are public records; SEC data are public domain. Redistribution allowed. Values are as
|
|
101
|
+
filed by the companies (not audited by SEC); cite the filing (accn) for a key number.
|