data-analyst-mcp 0.3.0 → 0.4.0
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 +286 -262
- package/dist/adapters/bjs.d.ts +13 -0
- package/dist/adapters/bjs.js +28 -0
- package/dist/adapters/bjs.js.map +1 -0
- package/dist/adapters/cbp.d.ts +5 -0
- package/dist/adapters/cbp.js +64 -0
- package/dist/adapters/cbp.js.map +1 -0
- package/dist/adapters/cdc-wonder.d.ts +5 -0
- package/dist/adapters/cdc-wonder.js +68 -0
- package/dist/adapters/cdc-wonder.js.map +1 -0
- package/dist/adapters/cpsc.d.ts +4 -0
- package/dist/adapters/cpsc.js +125 -0
- package/dist/adapters/cpsc.js.map +1 -0
- package/dist/adapters/fhwa.d.ts +9 -0
- package/dist/adapters/fhwa.js +16 -0
- package/dist/adapters/fhwa.js.map +1 -0
- package/dist/adapters/foreign-assistance.d.ts +9 -0
- package/dist/adapters/foreign-assistance.js +42 -0
- package/dist/adapters/foreign-assistance.js.map +1 -0
- package/dist/adapters/hud-ahar.d.ts +3 -0
- package/dist/adapters/hud-ahar.js +80 -0
- package/dist/adapters/hud-ahar.js.map +1 -0
- package/dist/adapters/nces.d.ts +10 -0
- package/dist/adapters/nces.js +32 -0
- package/dist/adapters/nces.js.map +1 -0
- package/dist/adapters/nsf.d.ts +11 -0
- package/dist/adapters/nsf.js +25 -0
- package/dist/adapters/nsf.js.map +1 -0
- package/dist/adapters/onrr.d.ts +9 -0
- package/dist/adapters/onrr.js +35 -0
- package/dist/adapters/onrr.js.map +1 -0
- package/dist/adapters/sba.d.ts +10 -0
- package/dist/adapters/sba.js +134 -0
- package/dist/adapters/sba.js.map +1 -0
- package/dist/adapters/treasury-tic.d.ts +30 -0
- package/dist/adapters/treasury-tic.js +149 -0
- package/dist/adapters/treasury-tic.js.map +1 -0
- package/dist/adapters/uscourts.d.ts +8 -0
- package/dist/adapters/uscourts.js +8 -0
- package/dist/adapters/uscourts.js.map +1 -0
- package/dist/analysis/cite.d.ts +9 -1
- package/dist/analysis/cite.js +9 -2
- package/dist/analysis/cite.js.map +1 -1
- package/dist/bin/cli.d.ts +2 -0
- package/dist/bin/cli.js +17 -0
- package/dist/bin/cli.js.map +1 -1
- package/dist/core/generic-rest.js +42 -17
- package/dist/core/generic-rest.js.map +1 -1
- package/dist/core/guard.d.ts +32 -0
- package/dist/core/guard.js +176 -0
- package/dist/core/guard.js.map +1 -0
- package/dist/core/http.d.ts +10 -0
- package/dist/core/http.js +36 -7
- package/dist/core/http.js.map +1 -1
- package/dist/core/keys.d.ts +13 -3
- package/dist/core/keys.js +67 -7
- package/dist/core/keys.js.map +1 -1
- package/dist/core/package.d.ts +12 -3
- package/dist/core/package.js +56 -12
- package/dist/core/package.js.map +1 -1
- package/dist/core/secret_patterns.d.ts +6 -0
- package/dist/core/secret_patterns.js +20 -0
- package/dist/core/secret_patterns.js.map +1 -0
- package/dist/core/tabular.d.ts +43 -1
- package/dist/core/tabular.js +149 -6
- package/dist/core/tabular.js.map +1 -1
- package/dist/envelope.js +3 -1
- package/dist/envelope.js.map +1 -1
- package/dist/index.d.ts +29 -22
- package/dist/index.js +45 -46
- package/dist/index.js.map +1 -1
- package/dist/remote/app.js +87 -31
- package/dist/remote/app.js.map +1 -1
- package/dist/remote/oauth.js +8 -1
- package/dist/remote/oauth.js.map +1 -1
- package/dist/remote/pages.d.ts +3 -7
- package/dist/remote/pages.js +49 -19
- package/dist/remote/pages.js.map +1 -1
- package/dist/remote/sign.d.ts +7 -1
- package/dist/remote/sign.js +33 -7
- package/dist/remote/sign.js.map +1 -1
- package/dist/remote/store.js +14 -5
- package/dist/remote/store.js.map +1 -1
- package/dist/report/audit_report.js +29 -7
- package/dist/report/audit_report.js.map +1 -1
- package/dist/report/build_report.js +34 -4
- package/dist/report/build_report.js.map +1 -1
- package/dist/report/method_audit.js +10 -1
- package/dist/report/method_audit.js.map +1 -1
- package/dist/report/scan_secrets.d.ts +4 -1
- package/dist/report/scan_secrets.js +38 -18
- package/dist/report/scan_secrets.js.map +1 -1
- package/dist/server.d.ts +3 -1
- package/dist/server.js +46 -13
- package/dist/server.js.map +1 -1
- package/dist/tools.js +27 -6
- package/dist/tools.js.map +1 -1
- package/guide/WORKFLOW.md +134 -134
- package/guide/assets/disclaimer.txt +1 -1
- package/guide/assets/download_data.ps1 +164 -162
- package/guide/assets/download_data.sh +8 -2
- package/guide/assets/report_template.html +597 -597
- package/guide/references/routing.md +198 -171
- package/guide/references/style_guide.md +398 -398
- package/package.json +56 -56
- package/packs/acf/endpoints.json +114 -114
- package/packs/acf/policy.json +104 -104
- package/packs/actuaries/endpoints.json +82 -82
- package/packs/actuaries/policy.json +109 -109
- package/packs/bea/assets/download_bea.ps1 +182 -182
- package/packs/bea/docs/bea_api.md +461 -461
- package/packs/bea/docs/datasets.md +157 -157
- package/packs/bea/docs/report_patterns.md +112 -112
- package/packs/bea/policy.json +170 -170
- package/packs/bea/source.md +152 -152
- package/packs/bjs/endpoints.json +150 -0
- package/packs/bjs/policy.json +114 -0
- package/packs/bjs/source.md +98 -0
- package/packs/bls/assets/download_bls.ps1 +152 -152
- package/packs/bls/docs/analysis_patterns.md +108 -108
- package/packs/bls/docs/bls_api.md +73 -73
- package/packs/bls/docs/series_ids.md +149 -149
- package/packs/bls/policy.json +238 -238
- package/packs/bts/endpoints.json +346 -346
- package/packs/bts/policy.json +94 -94
- package/packs/cbp/endpoints.json +31 -0
- package/packs/cbp/policy.json +85 -0
- package/packs/cbp/source.md +57 -0
- package/packs/cdc/endpoints.json +197 -197
- package/packs/cdc/policy.json +83 -83
- package/packs/cdc/source.md +1 -1
- package/packs/cdc-wonder/endpoints.json +26 -0
- package/packs/cdc-wonder/policy.json +84 -0
- package/packs/cdc-wonder/source.md +53 -0
- package/packs/census/endpoints.json +99 -99
- package/packs/cfpb/endpoints.json +326 -326
- package/packs/cfpb/policy.json +119 -119
- package/packs/clinical-trials/endpoints.json +166 -166
- package/packs/clinical-trials/policy.json +84 -84
- package/packs/cms/endpoints.json +69 -69
- package/packs/cms/policy.json +96 -96
- package/packs/college-scorecard/endpoints.json +252 -252
- package/packs/college-scorecard/policy.json +106 -106
- package/packs/college-scorecard/source.md +1 -1
- package/packs/congress/endpoints.json +1701 -1701
- package/packs/congress/policy.json +117 -117
- package/packs/cpsc/endpoints.json +91 -0
- package/packs/cpsc/policy.json +91 -0
- package/packs/cpsc/source.md +76 -0
- package/packs/dhs-ohss/endpoints.json +66 -66
- package/packs/dhs-ohss/policy.json +107 -107
- package/packs/dhs-ohss/source.md +1 -1
- package/packs/doj-news/endpoints.json +59 -59
- package/packs/doj-news/policy.json +96 -96
- package/packs/doj-news/source.md +1 -1
- package/packs/dol/endpoints.json +817 -817
- package/packs/dol/policy.json +135 -135
- package/packs/eia/endpoints.json +717 -717
- package/packs/eia/policy.json +112 -112
- package/packs/epa/endpoints.json +291 -291
- package/packs/epa/policy.json +99 -99
- package/packs/epa-aqs/endpoints.json +173 -173
- package/packs/epa-aqs/policy.json +96 -96
- package/packs/fbi/endpoints.json +1841 -1841
- package/packs/fbi/policy.json +118 -118
- package/packs/fbi/source.md +3 -3
- package/packs/fda/endpoints.json +237 -237
- package/packs/fda/policy.json +121 -121
- package/packs/fdic/endpoints.json +416 -416
- package/packs/fdic/policy.json +83 -83
- package/packs/fec/endpoints.json +707 -707
- package/packs/fec/policy.json +93 -93
- package/packs/fed-board/endpoints.json +89 -89
- package/packs/fed-board/policy.json +136 -136
- package/packs/federal-register/endpoints.json +143 -143
- package/packs/federal-register/policy.json +86 -86
- package/packs/fema/endpoints.json +645 -645
- package/packs/fema/policy.json +103 -103
- package/packs/fhfa/endpoints.json +105 -105
- package/packs/fhfa/policy.json +109 -109
- package/packs/fhwa/endpoints.json +48 -0
- package/packs/fhwa/policy.json +91 -0
- package/packs/fhwa/source.md +59 -0
- package/packs/foreign-assistance/endpoints.json +166 -0
- package/packs/foreign-assistance/policy.json +80 -0
- package/packs/foreign-assistance/source.md +76 -0
- package/packs/fred/assets/download_fred.ps1 +122 -122
- package/packs/fred/docs/analysis_patterns.md +124 -124
- package/packs/fred/docs/fred_api.md +94 -94
- package/packs/fred/docs/series.md +188 -188
- package/packs/fred/policy.json +253 -253
- package/packs/fsa/endpoints.json +150 -150
- package/packs/fsa/policy.json +99 -99
- package/packs/fsa/source.md +1 -1
- package/packs/govinfo/endpoints.json +519 -519
- package/packs/gsa-calc/endpoints.json +93 -93
- package/packs/gsa-calc/policy.json +97 -97
- package/packs/hud/endpoints.json +146 -146
- package/packs/hud/policy.json +84 -84
- package/packs/hud/source.md +1 -1
- package/packs/hud-ahar/endpoints.json +92 -0
- package/packs/hud-ahar/policy.json +88 -0
- package/packs/hud-ahar/source.md +72 -0
- package/packs/ipums/docs/report_patterns.md +117 -117
- package/packs/irs-soi/endpoints.json +114 -114
- package/packs/irs-soi/policy.json +107 -107
- package/packs/medicaid/endpoints.json +412 -412
- package/packs/medicaid/policy.json +108 -108
- package/packs/naep/endpoints.json +217 -217
- package/packs/naep/policy.json +100 -100
- package/packs/naep/source.md +1 -1
- package/packs/nces/endpoints.json +101 -0
- package/packs/nces/policy.json +99 -0
- package/packs/nces/source.md +75 -0
- package/packs/nhtsa/endpoints.json +132 -132
- package/packs/nhtsa/policy.json +93 -93
- package/packs/nhtsa/source.md +1 -1
- package/packs/nih/endpoints.json +452 -452
- package/packs/nih/policy.json +86 -86
- package/packs/noaa/endpoints.json +431 -431
- package/packs/noaa/policy.json +95 -95
- package/packs/nrel/endpoints.json +327 -327
- package/packs/nrel/policy.json +96 -96
- package/packs/nsf/endpoints.json +33 -0
- package/packs/nsf/policy.json +83 -0
- package/packs/nsf/source.md +59 -0
- package/packs/nws/endpoints.json +271 -271
- package/packs/nws/policy.json +82 -82
- package/packs/nyfed/endpoints.json +80 -80
- package/packs/nyfed/policy.json +92 -92
- package/packs/omb/endpoints.json +460 -460
- package/packs/omb/policy.json +106 -106
- package/packs/onrr/endpoints.json +198 -0
- package/packs/onrr/policy.json +91 -0
- package/packs/onrr/source.md +55 -0
- package/packs/open-payments/endpoints.json +297 -297
- package/packs/open-payments/policy.json +101 -101
- package/packs/opm/assets/download_opm.ps1 +125 -125
- package/packs/opm/docs/fields.md +184 -184
- package/packs/opm/docs/opm_api.md +71 -71
- package/packs/opm/docs/report_patterns.md +83 -83
- package/packs/opm/lib/data_dictionary.csv +73 -73
- package/packs/pbgc/endpoints.json +483 -483
- package/packs/pbgc/policy.json +94 -94
- package/packs/philfed/endpoints.json +85 -85
- package/packs/philfed/policy.json +94 -94
- package/packs/port.json +65 -0
- package/packs/regulations/endpoints.json +287 -287
- package/packs/regulations/policy.json +86 -86
- package/packs/sba/endpoints.json +34 -0
- package/packs/sba/policy.json +86 -0
- package/packs/sba/source.md +60 -0
- package/packs/sec/endpoints.json +236 -236
- package/packs/sec/policy.json +86 -86
- package/packs/senate-lobbying/endpoints.json +553 -553
- package/packs/senate-lobbying/policy.json +99 -99
- package/packs/snapqc/endpoints.json +1426 -1426
- package/packs/snapqc/policy.json +92 -92
- package/packs/treasury/catalog.json +2267 -2267
- package/packs/treasury/docs/api_guide.md +245 -245
- package/packs/treasury/docs/datasets.md +56 -56
- package/packs/treasury/docs/report_patterns.md +126 -126
- package/packs/treasury/policy.json +159 -159
- package/packs/treasury/source.md +170 -165
- package/packs/treasury-tic/endpoints.json +77 -0
- package/packs/treasury-tic/policy.json +89 -0
- package/packs/treasury-tic/source.md +80 -0
- package/packs/treasury-yields/endpoints.json +226 -226
- package/packs/treasury-yields/policy.json +86 -86
- package/packs/usaspending/endpoints.json +1315 -1315
- package/packs/usaspending/policy.json +109 -109
- package/packs/uscourts/endpoints.json +22 -0
- package/packs/uscourts/policy.json +87 -0
- package/packs/uscourts/source.md +56 -0
- package/packs/usda-fna/policy.json +133 -133
- package/packs/usda-fooddata/endpoints.json +180 -180
- package/packs/usda-fooddata/policy.json +94 -94
- package/packs/usda-nass/endpoints.json +323 -323
- package/packs/usda-nass/policy.json +95 -95
- package/packs/usda-outlook/endpoints.json +86 -86
- package/packs/usda-outlook/policy.json +109 -109
- package/packs/usgs/endpoints.json +313 -313
- package/packs/usgs/policy.json +95 -95
- package/packs/usitc/endpoints.json +74 -74
- package/packs/usitc/policy.json +111 -111
- package/packs/uspto/endpoints.json +141 -141
- package/packs/uspto/policy.json +95 -95
- package/packs/uspto/source.md +1 -1
- package/packs/va/endpoints.json +414 -414
- package/packs/va/policy.json +101 -101
- package/packs/world-bank/endpoints.json +122 -122
- package/packs/world-bank/policy.json +101 -101
|
@@ -1,117 +1,117 @@
|
|
|
1
|
-
{
|
|
2
|
-
"id": "congress",
|
|
3
|
-
"title": "Congress.gov API (Library of Congress) with House and Senate roll-call votes",
|
|
4
|
-
"agency": "Library of Congress (Congress.gov); Clerk of the House; Secretary of the Senate",
|
|
5
|
-
"depth": "standard",
|
|
6
|
-
"domains": [
|
|
7
|
-
"legislation",
|
|
8
|
-
"congress",
|
|
9
|
-
"votes"
|
|
10
|
-
],
|
|
11
|
-
"keywords": [
|
|
12
|
-
"veto",
|
|
13
|
-
"vetoes",
|
|
14
|
-
"veto override",
|
|
15
|
-
"congress",
|
|
16
|
-
"bill",
|
|
17
|
-
"bills",
|
|
18
|
-
"legislation",
|
|
19
|
-
"sponsor",
|
|
20
|
-
"cosponsor",
|
|
21
|
-
"cosponsors",
|
|
22
|
-
"bill status",
|
|
23
|
-
"actions",
|
|
24
|
-
"roll call",
|
|
25
|
-
"roll-call vote",
|
|
26
|
-
"vote",
|
|
27
|
-
"votes",
|
|
28
|
-
"house vote",
|
|
29
|
-
"senate vote",
|
|
30
|
-
"party line",
|
|
31
|
-
"member of congress",
|
|
32
|
-
"senator",
|
|
33
|
-
"representative",
|
|
34
|
-
"committee",
|
|
35
|
-
"committee report",
|
|
36
|
-
"hearing",
|
|
37
|
-
"nomination",
|
|
38
|
-
"confirmation",
|
|
39
|
-
"treaty",
|
|
40
|
-
"crs report",
|
|
41
|
-
"public law",
|
|
42
|
-
"enacted",
|
|
43
|
-
"laws passed",
|
|
44
|
-
"congressional review act",
|
|
45
|
-
"cra resolution",
|
|
46
|
-
"disapproval resolution",
|
|
47
|
-
"committee meetings",
|
|
48
|
-
"committee hearings held",
|
|
49
|
-
"markups"
|
|
50
|
-
],
|
|
51
|
-
"questions": [
|
|
52
|
-
"how did each party vote on a bill",
|
|
53
|
-
"how many bills became law in each Congress",
|
|
54
|
-
"cosponsors of a bill by party",
|
|
55
|
-
"bills a member sponsored",
|
|
56
|
-
"status and actions of a bill",
|
|
57
|
-
"CRS reports on a topic",
|
|
58
|
-
"nominations confirmed by the Senate"
|
|
59
|
-
],
|
|
60
|
-
"homepage": "https://www.congress.gov/",
|
|
61
|
-
"terms_url": "https://www.loc.gov/legal/",
|
|
62
|
-
"auth": {
|
|
63
|
-
"env": "DATA_GOV_API_KEY",
|
|
64
|
-
"required": "optional",
|
|
65
|
-
"placement": "query",
|
|
66
|
-
"param": "api_key",
|
|
67
|
-
"home": "data-gov",
|
|
68
|
-
"signup_url": "https://api.data.gov/signup/",
|
|
69
|
-
"echoes_key": false,
|
|
70
|
-
"demo_key": "DEMO_KEY",
|
|
71
|
-
"key_only": [
|
|
72
|
-
"more than about 10 Congress.gov requests an hour (DEMO_KEY limit); roll-call XML needs no key"
|
|
73
|
-
]
|
|
74
|
-
},
|
|
75
|
-
"limits": {
|
|
76
|
-
"rps": 2,
|
|
77
|
-
"burst": 6,
|
|
78
|
-
"daily_quota": null,
|
|
79
|
-
"max_rows": 50000
|
|
80
|
-
},
|
|
81
|
-
"routes": {
|
|
82
|
-
"api": {
|
|
83
|
-
"base": "https://api.congress.gov/v3",
|
|
84
|
-
"probe": "https://api.congress.gov/v3/congress/119?format=json",
|
|
85
|
-
"hosts": [
|
|
86
|
-
"api.congress.gov",
|
|
87
|
-
"clerk.house.gov",
|
|
88
|
-
"www.senate.gov"
|
|
89
|
-
]
|
|
90
|
-
},
|
|
91
|
-
"manual": {
|
|
92
|
-
"how": "Open each link in INSTRUCTIONS.md in a browser and save the file under the given name: Congress.gov links carry the public DEMO_KEY (about 10 requests an hour; put your own api.data.gov key in its place for more), roll-call links are the official XML files at clerk.house.gov/evs/<year>/roll<NNN>.xml and www.senate.gov/legislative/LIS/roll_call_votes/. On congress.gov, a bill's page (Actions, Cosponsors tabs) and search results can also be downloaded; upload the files."
|
|
93
|
-
}
|
|
94
|
-
},
|
|
95
|
-
"cache": {
|
|
96
|
-
"mode": "run_only",
|
|
97
|
-
"ttl_hours": null,
|
|
98
|
-
"why": "Bill status, actions and cosponsors change daily while Congress sits; data/ is reused within a run."
|
|
99
|
-
},
|
|
100
|
-
"redistribution": {
|
|
101
|
-
"mode": "allowed",
|
|
102
|
-
"why": "Legislative data from Congress.gov, the House Clerk and the Senate are U.S. government works without copyright (17 U.S.C. 105); the Library of Congress asks for attribution. CRS report texts are public; Congress.gov's terms allow reuse of its data."
|
|
103
|
-
},
|
|
104
|
-
"notices": [],
|
|
105
|
-
"retention": null,
|
|
106
|
-
"citation": "Library of Congress, Congress.gov API, {dataset}, api.congress.gov (roll-call votes: Clerk of the U.S. House of Representatives and U.S. Senate), retrieved {retrieved_long}.",
|
|
107
|
-
"audit_hooks": [],
|
|
108
|
-
"clarify": [
|
|
109
|
-
"Which Congress (two-year term) or session? Default: the current Congress.",
|
|
110
|
-
"Which vote on a bill: final passage, cloture, a motion or an amendment? A bill often has several recorded votes; default: final passage in each chamber.",
|
|
111
|
-
"Bills only (hr, s) or resolutions too? Joint resolutions can become law; simple and concurrent resolutions cannot."
|
|
112
|
-
],
|
|
113
|
-
"formats": [
|
|
114
|
-
"json",
|
|
115
|
-
"xml"
|
|
116
|
-
]
|
|
117
|
-
}
|
|
1
|
+
{
|
|
2
|
+
"id": "congress",
|
|
3
|
+
"title": "Congress.gov API (Library of Congress) with House and Senate roll-call votes",
|
|
4
|
+
"agency": "Library of Congress (Congress.gov); Clerk of the House; Secretary of the Senate",
|
|
5
|
+
"depth": "standard",
|
|
6
|
+
"domains": [
|
|
7
|
+
"legislation",
|
|
8
|
+
"congress",
|
|
9
|
+
"votes"
|
|
10
|
+
],
|
|
11
|
+
"keywords": [
|
|
12
|
+
"veto",
|
|
13
|
+
"vetoes",
|
|
14
|
+
"veto override",
|
|
15
|
+
"congress",
|
|
16
|
+
"bill",
|
|
17
|
+
"bills",
|
|
18
|
+
"legislation",
|
|
19
|
+
"sponsor",
|
|
20
|
+
"cosponsor",
|
|
21
|
+
"cosponsors",
|
|
22
|
+
"bill status",
|
|
23
|
+
"actions",
|
|
24
|
+
"roll call",
|
|
25
|
+
"roll-call vote",
|
|
26
|
+
"vote",
|
|
27
|
+
"votes",
|
|
28
|
+
"house vote",
|
|
29
|
+
"senate vote",
|
|
30
|
+
"party line",
|
|
31
|
+
"member of congress",
|
|
32
|
+
"senator",
|
|
33
|
+
"representative",
|
|
34
|
+
"committee",
|
|
35
|
+
"committee report",
|
|
36
|
+
"hearing",
|
|
37
|
+
"nomination",
|
|
38
|
+
"confirmation",
|
|
39
|
+
"treaty",
|
|
40
|
+
"crs report",
|
|
41
|
+
"public law",
|
|
42
|
+
"enacted",
|
|
43
|
+
"laws passed",
|
|
44
|
+
"congressional review act",
|
|
45
|
+
"cra resolution",
|
|
46
|
+
"disapproval resolution",
|
|
47
|
+
"committee meetings",
|
|
48
|
+
"committee hearings held",
|
|
49
|
+
"markups"
|
|
50
|
+
],
|
|
51
|
+
"questions": [
|
|
52
|
+
"how did each party vote on a bill",
|
|
53
|
+
"how many bills became law in each Congress",
|
|
54
|
+
"cosponsors of a bill by party",
|
|
55
|
+
"bills a member sponsored",
|
|
56
|
+
"status and actions of a bill",
|
|
57
|
+
"CRS reports on a topic",
|
|
58
|
+
"nominations confirmed by the Senate"
|
|
59
|
+
],
|
|
60
|
+
"homepage": "https://www.congress.gov/",
|
|
61
|
+
"terms_url": "https://www.loc.gov/legal/",
|
|
62
|
+
"auth": {
|
|
63
|
+
"env": "DATA_GOV_API_KEY",
|
|
64
|
+
"required": "optional",
|
|
65
|
+
"placement": "query",
|
|
66
|
+
"param": "api_key",
|
|
67
|
+
"home": "data-gov",
|
|
68
|
+
"signup_url": "https://api.data.gov/signup/",
|
|
69
|
+
"echoes_key": false,
|
|
70
|
+
"demo_key": "DEMO_KEY",
|
|
71
|
+
"key_only": [
|
|
72
|
+
"more than about 10 Congress.gov requests an hour (DEMO_KEY limit); roll-call XML needs no key"
|
|
73
|
+
]
|
|
74
|
+
},
|
|
75
|
+
"limits": {
|
|
76
|
+
"rps": 2,
|
|
77
|
+
"burst": 6,
|
|
78
|
+
"daily_quota": null,
|
|
79
|
+
"max_rows": 50000
|
|
80
|
+
},
|
|
81
|
+
"routes": {
|
|
82
|
+
"api": {
|
|
83
|
+
"base": "https://api.congress.gov/v3",
|
|
84
|
+
"probe": "https://api.congress.gov/v3/congress/119?format=json",
|
|
85
|
+
"hosts": [
|
|
86
|
+
"api.congress.gov",
|
|
87
|
+
"clerk.house.gov",
|
|
88
|
+
"www.senate.gov"
|
|
89
|
+
]
|
|
90
|
+
},
|
|
91
|
+
"manual": {
|
|
92
|
+
"how": "Open each link in INSTRUCTIONS.md in a browser and save the file under the given name: Congress.gov links carry the public DEMO_KEY (about 10 requests an hour; put your own api.data.gov key in its place for more), roll-call links are the official XML files at clerk.house.gov/evs/<year>/roll<NNN>.xml and www.senate.gov/legislative/LIS/roll_call_votes/. On congress.gov, a bill's page (Actions, Cosponsors tabs) and search results can also be downloaded; upload the files."
|
|
93
|
+
}
|
|
94
|
+
},
|
|
95
|
+
"cache": {
|
|
96
|
+
"mode": "run_only",
|
|
97
|
+
"ttl_hours": null,
|
|
98
|
+
"why": "Bill status, actions and cosponsors change daily while Congress sits; data/ is reused within a run."
|
|
99
|
+
},
|
|
100
|
+
"redistribution": {
|
|
101
|
+
"mode": "allowed",
|
|
102
|
+
"why": "Legislative data from Congress.gov, the House Clerk and the Senate are U.S. government works without copyright (17 U.S.C. 105); the Library of Congress asks for attribution. CRS report texts are public; Congress.gov's terms allow reuse of its data."
|
|
103
|
+
},
|
|
104
|
+
"notices": [],
|
|
105
|
+
"retention": null,
|
|
106
|
+
"citation": "Library of Congress, Congress.gov API, {dataset}, api.congress.gov (roll-call votes: Clerk of the U.S. House of Representatives and U.S. Senate), retrieved {retrieved_long}.",
|
|
107
|
+
"audit_hooks": [],
|
|
108
|
+
"clarify": [
|
|
109
|
+
"Which Congress (two-year term) or session? Default: the current Congress.",
|
|
110
|
+
"Which vote on a bill: final passage, cloture, a motion or an amendment? A bill often has several recorded votes; default: final passage in each chamber.",
|
|
111
|
+
"Bills only (hr, s) or resolutions too? Joint resolutions can become law; simple and concurrent resolutions cannot."
|
|
112
|
+
],
|
|
113
|
+
"formats": [
|
|
114
|
+
"json",
|
|
115
|
+
"xml"
|
|
116
|
+
]
|
|
117
|
+
}
|
|
@@ -0,0 +1,91 @@
|
|
|
1
|
+
{
|
|
2
|
+
"base_url": "https://www.saferproducts.gov/RestWebServices",
|
|
3
|
+
"timeout": 60,
|
|
4
|
+
"endpoints": {
|
|
5
|
+
"recalls": {
|
|
6
|
+
"path": "/Recall",
|
|
7
|
+
"method": "GET",
|
|
8
|
+
"description": "CPSC product recalls (SaferProducts.gov Recall API): one row per recall with products, units, hazards, remedies, injuries, manufacturers, retailers and importers. Give at least one filter; text filters match part of the field.",
|
|
9
|
+
"params": {
|
|
10
|
+
"RecallDateStart": {
|
|
11
|
+
"desc": "recalls announced on or after this date, YYYY-MM-DD"
|
|
12
|
+
},
|
|
13
|
+
"RecallDateEnd": {
|
|
14
|
+
"desc": "recalls announced on or before this date, YYYY-MM-DD"
|
|
15
|
+
},
|
|
16
|
+
"LastPublishDateStart": {
|
|
17
|
+
"desc": "recalls published or updated on or after this date, YYYY-MM-DD"
|
|
18
|
+
},
|
|
19
|
+
"RecallNumber": {
|
|
20
|
+
"desc": "CPSC recall number, e.g. 27066"
|
|
21
|
+
},
|
|
22
|
+
"ProductName": {
|
|
23
|
+
"desc": "part of a product name (crib, dresser)"
|
|
24
|
+
},
|
|
25
|
+
"ProductType": {
|
|
26
|
+
"desc": "part of CPSC's product type (Slides, Cribs, Dressers)"
|
|
27
|
+
},
|
|
28
|
+
"RecallTitle": {
|
|
29
|
+
"desc": "part of the recall title"
|
|
30
|
+
},
|
|
31
|
+
"RecallDescription": {
|
|
32
|
+
"desc": "part of the recall description"
|
|
33
|
+
},
|
|
34
|
+
"Manufacturer": {
|
|
35
|
+
"desc": "part of a manufacturer name"
|
|
36
|
+
},
|
|
37
|
+
"Retailer": {
|
|
38
|
+
"desc": "part of the retailer text (Amazon, Walmart)"
|
|
39
|
+
},
|
|
40
|
+
"Importer": {
|
|
41
|
+
"desc": "part of an importer name"
|
|
42
|
+
},
|
|
43
|
+
"Injury": {
|
|
44
|
+
"desc": "part of the injuries text (death, burn)"
|
|
45
|
+
},
|
|
46
|
+
"Remedy": {
|
|
47
|
+
"desc": "part of the remedy text (Refund, Repair, Replace)"
|
|
48
|
+
},
|
|
49
|
+
"hazard": {
|
|
50
|
+
"in": "spec",
|
|
51
|
+
"desc": "keep recalls whose hazard text contains this (case-insensitive); filtered here, because the API's own Hazard filter matches nothing"
|
|
52
|
+
},
|
|
53
|
+
"country": {
|
|
54
|
+
"in": "spec",
|
|
55
|
+
"desc": "keep recalls with this manufacturer country (China, Vietnam); filtered here"
|
|
56
|
+
}
|
|
57
|
+
},
|
|
58
|
+
"defaults": {
|
|
59
|
+
"format": "json"
|
|
60
|
+
},
|
|
61
|
+
"records": "",
|
|
62
|
+
"paging": {
|
|
63
|
+
"type": "none"
|
|
64
|
+
},
|
|
65
|
+
"max_rows": 20000,
|
|
66
|
+
"flatten": false
|
|
67
|
+
},
|
|
68
|
+
"neiss": {
|
|
69
|
+
"path": "https://www.cpsc.gov/cgibin/NEISSQuery/home.aspx",
|
|
70
|
+
"method": "GET",
|
|
71
|
+
"description": "NEISS: one year of emergency-department injury cases involving consumer products (about 300,000 sampled cases a year, with national weights). Manual only: cpsc.gov refuses scripts; the user downloads the archived year as Tab Delimited Text (or Excel) and uploads it.",
|
|
72
|
+
"params": {
|
|
73
|
+
"year": {
|
|
74
|
+
"in": "spec",
|
|
75
|
+
"required": true,
|
|
76
|
+
"desc": "the data year, 2006 or later"
|
|
77
|
+
},
|
|
78
|
+
"product": {
|
|
79
|
+
"in": "spec",
|
|
80
|
+
"desc": "keep cases with this NEISS product code in Product_1, Product_2 or Product_3 (a code or a list; the codes are in the NEISS Coding Manual)"
|
|
81
|
+
}
|
|
82
|
+
},
|
|
83
|
+
"records": "$tsv",
|
|
84
|
+
"header_row": 1,
|
|
85
|
+
"paging": {
|
|
86
|
+
"type": "none"
|
|
87
|
+
},
|
|
88
|
+
"max_rows": 1000000
|
|
89
|
+
}
|
|
90
|
+
}
|
|
91
|
+
}
|
|
@@ -0,0 +1,91 @@
|
|
|
1
|
+
{
|
|
2
|
+
"id": "cpsc",
|
|
3
|
+
"title": "Consumer Product Safety Commission: product recalls and NEISS injury data",
|
|
4
|
+
"agency": "U.S. Consumer Product Safety Commission",
|
|
5
|
+
"depth": "standard",
|
|
6
|
+
"domains": [
|
|
7
|
+
"consumer safety",
|
|
8
|
+
"product recalls",
|
|
9
|
+
"injuries",
|
|
10
|
+
"health"
|
|
11
|
+
],
|
|
12
|
+
"keywords": [
|
|
13
|
+
"cpsc",
|
|
14
|
+
"consumer product safety commission",
|
|
15
|
+
"product recall",
|
|
16
|
+
"recalls",
|
|
17
|
+
"recalled product",
|
|
18
|
+
"saferproducts",
|
|
19
|
+
"crib recall",
|
|
20
|
+
"dresser tip-over",
|
|
21
|
+
"toy recall",
|
|
22
|
+
"neiss",
|
|
23
|
+
"national electronic injury surveillance system",
|
|
24
|
+
"emergency department injuries",
|
|
25
|
+
"product-related injuries",
|
|
26
|
+
"injury estimates",
|
|
27
|
+
"consumer product injuries"
|
|
28
|
+
],
|
|
29
|
+
"questions": [
|
|
30
|
+
"consumer product recalls announced this year",
|
|
31
|
+
"recalls of cribs, dressers or strollers",
|
|
32
|
+
"recalled products made in China",
|
|
33
|
+
"recalls that mention deaths",
|
|
34
|
+
"emergency department visits for injuries involving a product (NEISS)",
|
|
35
|
+
"national estimate of injuries by product, age or sex"
|
|
36
|
+
],
|
|
37
|
+
"homepage": "https://www.cpsc.gov/Recalls",
|
|
38
|
+
"terms_url": "https://www.saferproducts.gov/",
|
|
39
|
+
"auth": {
|
|
40
|
+
"env": null,
|
|
41
|
+
"required": "none",
|
|
42
|
+
"placement": "none",
|
|
43
|
+
"signup_url": null,
|
|
44
|
+
"echoes_key": false
|
|
45
|
+
},
|
|
46
|
+
"limits": {
|
|
47
|
+
"rps": 2,
|
|
48
|
+
"burst": 4,
|
|
49
|
+
"max_rows": 1000000
|
|
50
|
+
},
|
|
51
|
+
"routes": {
|
|
52
|
+
"api": {
|
|
53
|
+
"base": "https://www.saferproducts.gov/RestWebServices",
|
|
54
|
+
"probe": "https://www.saferproducts.gov/RestWebServices/Recall?format=json&RecallNumber=27066",
|
|
55
|
+
"hosts": [
|
|
56
|
+
"www.saferproducts.gov"
|
|
57
|
+
]
|
|
58
|
+
},
|
|
59
|
+
"manual": {
|
|
60
|
+
"how": "Recalls: open the Recall API link (https://www.saferproducts.gov/RestWebServices/Recall?format=json&RecallDateStart=YYYY-MM-DD) in a browser and save the JSON. NEISS: open https://www.cpsc.gov/cgibin/NEISSQuery/home.aspx, pick a User Affiliation, choose the year under Archived Annual NEISS Data with File Format Tab Delimited Text, click Find Data, save the file. Upload with ingest."
|
|
61
|
+
}
|
|
62
|
+
},
|
|
63
|
+
"cache": {
|
|
64
|
+
"mode": "run_only",
|
|
65
|
+
"ttl_hours": null,
|
|
66
|
+
"why": "Recalls are added and updated daily; data/ is reused within a run."
|
|
67
|
+
},
|
|
68
|
+
"redistribution": {
|
|
69
|
+
"mode": "allowed",
|
|
70
|
+
"why": "CPSC recall notices and NEISS public-use data are U.S. government works in the public domain (17 U.S.C. 105)."
|
|
71
|
+
},
|
|
72
|
+
"notices": [],
|
|
73
|
+
"retention": null,
|
|
74
|
+
"citation": "U.S. Consumer Product Safety Commission, {dataset}, saferproducts.gov and cpsc.gov, retrieved {retrieved_long}.",
|
|
75
|
+
"audit_hooks": [],
|
|
76
|
+
"clarify": [
|
|
77
|
+
"Recalls or injuries? Recalls list products CPSC and firms recalled (counts of recalls and units); NEISS estimates emergency-department visits for injuries associated with products (national estimates from a sample, not counts of incidents). Default: recalls for 'recalled products', NEISS for 'how many injuries'.",
|
|
78
|
+
"Which period? Recalls by announcement date (RecallDateStart/End); NEISS by treatment year. Default: the last full calendar year."
|
|
79
|
+
],
|
|
80
|
+
"formats": [
|
|
81
|
+
"json",
|
|
82
|
+
"tsv",
|
|
83
|
+
"xlsx"
|
|
84
|
+
],
|
|
85
|
+
"aliases": [
|
|
86
|
+
"CPSC",
|
|
87
|
+
"Consumer Product Safety Commission",
|
|
88
|
+
"NEISS",
|
|
89
|
+
"SaferProducts.gov"
|
|
90
|
+
]
|
|
91
|
+
}
|
|
@@ -0,0 +1,76 @@
|
|
|
1
|
+
# Consumer Product Safety Commission: product recalls and NEISS injury data
|
|
2
|
+
Depth: standard. Key: none.
|
|
3
|
+
- Recalls: from the SaferProducts.gov Recall API, one row per recall with products, units, hazards, injuries,
|
|
4
|
+
remedies, firms and countries.
|
|
5
|
+
- NEISS: the National Electronic Injury Surveillance System, a probability sample of hospital emergency
|
|
6
|
+
departments with weights for national estimates of product-related injuries. NEISS is manual only: the user
|
|
7
|
+
downloads the yearly file and uploads it.
|
|
8
|
+
|
|
9
|
+
## When to use
|
|
10
|
+
- Which consumer products were recalled, when, why (hazard), how many units, the remedy, who made, imported
|
|
11
|
+
or sold them, and where they were made; recalls that mention injuries or deaths.
|
|
12
|
+
- Emergency-department-treated injuries associated with consumer products: national estimates by product,
|
|
13
|
+
age, sex, body part, diagnosis, disposition, location.
|
|
14
|
+
- Not here: vehicle, tire and car-seat recalls (nhtsa); food, drug, device and cosmetic recalls (fda);
|
|
15
|
+
injury deaths from death certificates (cdc).
|
|
16
|
+
|
|
17
|
+
## Endpoints
|
|
18
|
+
| Endpoint | Returns | Parameters |
|
|
19
|
+
|---|---|---|
|
|
20
|
+
| `recalls` | one row per recall: `recall_number`, `recall_date`, `title`, `products`, `product_types`, `number_of_units`, `hazards`, `injuries`, `remedies`, `remedy_options`, `manufacturers`, `importers`, `distributors`, `retailers`, `manufacturer_countries`, `upcs`, `description`, `url`, `last_publish_date`, `recall_id` | API filters (at least one): `RecallDateStart`, `RecallDateEnd`, `LastPublishDateStart` (YYYY-MM-DD), `RecallNumber`, `ProductName`, `ProductType`, `RecallTitle`, `RecallDescription`, `Manufacturer`, `Retailer`, `Importer`, `Injury`, `Remedy`; filtered here: `hazard`, `country` |
|
|
21
|
+
| `neiss` | the uploaded NEISS year as published: `CPSC_Case_Number`, `Treatment_Date`, `Age`, `Sex`, `Race`, `Other_Race`, `Hispanic`, `Body_Part`, `Body_Part_2`, `Diagnosis`, `Diagnosis_2`, `Other_Diagnosis`, `Other_Diagnosis_2`, `Disposition`, `Location`, `Fire_Involvement`, `Alcohol`, `Drug`, `Product_1`, `Product_2`, `Product_3`, `Narrative`, `Stratum`, `PSU`, `Weight` (2019 on; earlier years lack the `_2`, `Hispanic`, `Alcohol`, `Drug`, `Product_3` columns) | `year` (required), `product` (codes kept in any product column) |
|
|
22
|
+
|
|
23
|
+
## Spec examples
|
|
24
|
+
```json
|
|
25
|
+
{"description": "Consumer product recalls announced in 2025 with fire hazards",
|
|
26
|
+
"requests": [{"name": "fire_2025", "endpoint": "recalls",
|
|
27
|
+
"params": {"RecallDateStart": "2025-01-01", "RecallDateEnd": "2025-12-31", "hazard": "fire"}}]}
|
|
28
|
+
```
|
|
29
|
+
```json
|
|
30
|
+
{"description": "Crib recalls since 2020",
|
|
31
|
+
"requests": [{"name": "cribs", "endpoint": "recalls", "params": {"ProductName": "crib", "RecallDateStart": "2020-01-01"}}]}
|
|
32
|
+
```
|
|
33
|
+
```json
|
|
34
|
+
{"description": "NEISS 2024 cases (manual: manual_bundle, then ingest)",
|
|
35
|
+
"requests": [{"name": "neiss_2024", "endpoint": "neiss", "params": {"year": "2024"}}]}
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
## Data format and traps
|
|
39
|
+
- Recall filters (verified 2026-11-07):
|
|
40
|
+
- Text filters match part of the field. With no filter the API returns nothing, so the pack asks for one.
|
|
41
|
+
- An unknown parameter is ignored silently. Only the names above are sent; check the rows match what was
|
|
42
|
+
asked.
|
|
43
|
+
- The API's `Hazard`, `ManufacturerCountry` and `ProductModel` filters match nothing, so use `hazard` and
|
|
44
|
+
`country` here (they filter the returned rows). Narrow by date first.
|
|
45
|
+
- One recall can cover several products. The list fields are joined with ` | `. `number_of_units` is free text
|
|
46
|
+
as published ("About 10,318", "5.9 million", "About 338,800 (In addition, about 36,300 were sold in Canada)"):
|
|
47
|
+
parse it with care, never sum it blindly, and say when Canadian or Mexican units are included.
|
|
48
|
+
- `retailers` is free text ("Sold At: ... from May 2025 through September 2026 for about $20") and sometimes also
|
|
49
|
+
names the seller or importer. `recall_date` is the announcement date. A recall number's first two digits are
|
|
50
|
+
CPSC's fiscal year (27xxx = FY2027, from October 2026).
|
|
51
|
+
- Recalls are announcements, not incidents: a count of recalls measures CPSC and firm actions, not product
|
|
52
|
+
danger.
|
|
53
|
+
- NEISS is a sample: each case has a `Weight`. National estimates are the sum of weights; the number of cases is
|
|
54
|
+
not an estimate. Report the number of cases behind every estimate, and say when an estimate rests on few
|
|
55
|
+
cases. CPSC's NEISS Estimates Query Builder gives the case count, coefficient of variation and 95% confidence
|
|
56
|
+
interval for its own estimates: prefer those for a published-quality figure. Standard errors need the
|
|
57
|
+
`Stratum` and `PSU` design and are not computed here.
|
|
58
|
+
- NEISS counts injuries *associated with* a product, not caused by it: a fall in a bathtub involves the
|
|
59
|
+
bathtub. Products are codes (`Product_1` ... `Product_3`); a case can involve up to three. The codes and the
|
|
60
|
+
values of `Body_Part`, `Diagnosis`, `Disposition` and `Location` are in the NEISS Coding Manual and the data
|
|
61
|
+
dictionary (https://www.cpsc.gov/s3fs-public/DataDictionary042022.xlsx). `Age` 201-223 means 1-23 months. Treatment
|
|
62
|
+
year, not incident year.
|
|
63
|
+
- The `Narrative` is free text from the hospital record. Quote it only as examples, never as counts.
|
|
64
|
+
|
|
65
|
+
## Access
|
|
66
|
+
No key. `fetch` works for recalls (www.saferproducts.gov). NEISS: www.cpsc.gov answers scripts with HTTP 403, and
|
|
67
|
+
the archived yearly files sit behind a form, so `fetch` refuses `neiss` and points to `manual_bundle`. The user
|
|
68
|
+
opens https://www.cpsc.gov/cgibin/NEISSQuery/home.aspx in a browser, picks a User Affiliation, chooses the year
|
|
69
|
+
under "Archived Annual NEISS Data" with File Format "Tab Delimited Text" (Excel also works), clicks Find Data,
|
|
70
|
+
saves the file and uploads it; then `ingest`.
|
|
71
|
+
|
|
72
|
+
## Citation and terms
|
|
73
|
+
"U.S. Consumer Product Safety Commission, Recalls (SaferProducts.gov Recall API), retrieved <date>" or "U.S.
|
|
74
|
+
Consumer Product Safety Commission, National Electronic Injury Surveillance System (NEISS), <year> data,
|
|
75
|
+
downloaded <date>." Public domain (17 U.S.C. 105). Estimates computed from NEISS cases are the analyst's own,
|
|
76
|
+
not CPSC's: say so.
|
|
@@ -1,66 +1,66 @@
|
|
|
1
|
-
{
|
|
2
|
-
"base_url": "https://ohss.dhs.gov",
|
|
3
|
-
"timeout": 60,
|
|
4
|
-
"endpoints": {
|
|
5
|
-
"yearbook_table": {
|
|
6
|
-
"path": "/topics/immigration/yearbook/{fiscal_year}",
|
|
7
|
-
"description": "One table (one sheet) of the Yearbook of Immigration Statistics workbook for a topic and fiscal year. The pack reads the year page, finds the topic's published .xlsx (FY2022 on) or .zip of one .xlsx per table (FY2015-2021), and returns the sheet as published: the header row is detected (a two-row header is joined), section label rows (REGION, COUNTRY, NEW ARRIVALS ...) become a `section` column, and the footnote, Notes and Source lines go into the fetch notes.",
|
|
8
|
-
"params": {
|
|
9
|
-
"topic": {"in": "spec", "required": true,
|
|
10
|
-
"enum": ["lpr", "lpr_supplementary", "lpr_expanded", "refugees", "asylees", "refugees_asylees",
|
|
11
|
-
"naturalizations", "naturalizations_supplementary", "nonimmigrant",
|
|
12
|
-
"nonimmigrant_supplementary", "enforcement"],
|
|
13
|
-
"desc": "which workbook of the year: lpr (Tables 1-12, plus the LPR supplemental tables from FY2022), lpr_expanded (Tables 8-11 split into adjustments of status and new arrivals), refugees, asylees (refugees_asylees: the combined workbook up to FY2022), naturalizations, nonimmigrant, enforcement; *_supplementary = the separate supplementary zip of FY2015-2021"},
|
|
14
|
-
"fiscal_year": {"in": "path", "desc": "fiscal year of the yearbook (Oct-Sep), e.g. 2024; default: the newest year page that has the topic's file"},
|
|
15
|
-
"table": {"in": "spec", "desc": "sheet name as published, e.g. \"Table 6\", \"LPRSuppTable 1\", \"NISuppTable1\" (also \"6\" or \"table6\"); a wrong or missing name fails with the workbook's sheets and their titles"},
|
|
16
|
-
"header_row": {"in": "spec", "desc": "optional: 1-based row (among the rows the workbook stores) that holds the column names; default: detected"}
|
|
17
|
-
},
|
|
18
|
-
"records": "$xlsx",
|
|
19
|
-
"paging": {"type": "none"}
|
|
20
|
-
},
|
|
21
|
-
"lir_table": {
|
|
22
|
-
"path": "/topics/immigration/legal-immigration-and-adjustment-status-report",
|
|
23
|
-
"description": "One table of the quarterly Legal Immigration and Adjustment of Status Report workbook (preliminary quarterly LPR, refugee, naturalization and nonimmigrant counts for the fiscal year so far, FY2016 on). Read the same way as yearbook_table.",
|
|
24
|
-
"params": {
|
|
25
|
-
"fiscal_year": {"in": "spec", "desc": "fiscal year of the report, e.g. 2025; default: the newest posted"},
|
|
26
|
-
"table": {"in": "spec", "desc": "sheet name, e.g. \"Table 1A\" (LPR by nationality and quarter), \"Table 1B\" (LPR by class of admission), \"Table 2\" (refugee arrivals), \"Table 3\" (naturalizations), \"Table 4A\"/\"Table 4B\" (nonimmigrant admissions)"},
|
|
27
|
-
"header_row": {"in": "spec", "desc": "optional: 1-based header row; default: detected"}
|
|
28
|
-
},
|
|
29
|
-
"records": "$xlsx",
|
|
30
|
-
"paging": {"type": "none"}
|
|
31
|
-
},
|
|
32
|
-
"yearbook_files": {
|
|
33
|
-
"path": "/topics/immigration/yearbook/{fiscal_year}",
|
|
34
|
-
"description": "The data files posted on a yearbook year page (one row per file: fiscal_year, topic, title, url, format), scraped from the page because the file names carry upload dates. Use it to see what a year has before asking for a table.",
|
|
35
|
-
"params": {
|
|
36
|
-
"fiscal_year": {"in": "path", "desc": "one year (2015 on has data files), a list of years, or omit for the newest year page"},
|
|
37
|
-
"topic": {"in": "spec", "desc": "optional: keep only this topic's files (same names as yearbook_table)"}
|
|
38
|
-
},
|
|
39
|
-
"paging": {"type": "none"}
|
|
40
|
-
},
|
|
41
|
-
"lir_files": {
|
|
42
|
-
"path": "/topics/immigration/legal-immigration-and-adjustment-status-report",
|
|
43
|
-
"description": "The Legal Immigration and Adjustment of Status Report workbooks posted (one row per fiscal year: fiscal_year, through_quarter, title, url).",
|
|
44
|
-
"params": {},
|
|
45
|
-
"paging": {"type": "none"}
|
|
46
|
-
}
|
|
47
|
-
},
|
|
48
|
-
"catalog": {
|
|
49
|
-
"lpr": {"id": "lpr", "endpoint": "yearbook_table", "name": "Lawful permanent residents (green cards), Yearbook Tables 1-12",
|
|
50
|
-
"description": "persons obtaining lawful permanent resident status (green card holders) by year, country of birth, last residence, state, metro area, class of admission (family, employment, diversity, refugee, asylee), adjustments of status vs new arrivals, sex, age, occupation"},
|
|
51
|
-
"lpr_expanded": {"id": "lpr_expanded", "endpoint": "yearbook_table", "name": "Expanded Tables 8-11 (adjustments of status and new arrivals)",
|
|
52
|
-
"description": "LPR demographic and country tables split by adjustment of status and new arrival"},
|
|
53
|
-
"refugees": {"id": "refugees", "endpoint": "yearbook_table", "name": "Refugee arrivals, Yearbook Tables 13-15",
|
|
54
|
-
"description": "refugee arrivals by year, country of nationality, relationship, sex, age"},
|
|
55
|
-
"asylees": {"id": "asylees", "endpoint": "yearbook_table", "name": "Individuals granted asylum, Yearbook Tables 16-20",
|
|
56
|
-
"description": "asylum granted affirmatively (USCIS) or defensively (immigration courts) by country of nationality"},
|
|
57
|
-
"naturalizations": {"id": "naturalizations", "endpoint": "yearbook_table", "name": "Naturalizations, Yearbook Tables 21-25",
|
|
58
|
-
"description": "persons naturalized (new U.S. citizens), applications filed and denied, by country of birth, state, metro area"},
|
|
59
|
-
"nonimmigrant": {"id": "nonimmigrant", "endpoint": "yearbook_table", "name": "Nonimmigrant admissions, Yearbook Tables 26-33",
|
|
60
|
-
"description": "temporary visitor admissions (I-94) by class of admission (tourist, student F-1, H-1B worker), country of citizenship, state of destination, month"},
|
|
61
|
-
"enforcement": {"id": "enforcement", "endpoint": "yearbook_table", "name": "Immigration enforcement actions, Yearbook Tables 33-42",
|
|
62
|
-
"description": "apprehensions, encounters, inadmissibility determinations, removals (deportations), returns, expulsions by country of nationality and criminal status"},
|
|
63
|
-
"lir": {"id": "lir", "endpoint": "lir_table", "name": "Legal Immigration and Adjustment of Status Report (quarterly)",
|
|
64
|
-
"description": "preliminary quarterly green card, refugee, naturalization and nonimmigrant admission counts for the current fiscal year"}
|
|
65
|
-
}
|
|
66
|
-
}
|
|
1
|
+
{
|
|
2
|
+
"base_url": "https://ohss.dhs.gov",
|
|
3
|
+
"timeout": 60,
|
|
4
|
+
"endpoints": {
|
|
5
|
+
"yearbook_table": {
|
|
6
|
+
"path": "/topics/immigration/yearbook/{fiscal_year}",
|
|
7
|
+
"description": "One table (one sheet) of the Yearbook of Immigration Statistics workbook for a topic and fiscal year. The pack reads the year page, finds the topic's published .xlsx (FY2022 on) or .zip of one .xlsx per table (FY2015-2021), and returns the sheet as published: the header row is detected (a two-row header is joined), section label rows (REGION, COUNTRY, NEW ARRIVALS ...) become a `section` column, and the footnote, Notes and Source lines go into the fetch notes.",
|
|
8
|
+
"params": {
|
|
9
|
+
"topic": {"in": "spec", "required": true,
|
|
10
|
+
"enum": ["lpr", "lpr_supplementary", "lpr_expanded", "refugees", "asylees", "refugees_asylees",
|
|
11
|
+
"naturalizations", "naturalizations_supplementary", "nonimmigrant",
|
|
12
|
+
"nonimmigrant_supplementary", "enforcement"],
|
|
13
|
+
"desc": "which workbook of the year: lpr (Tables 1-12, plus the LPR supplemental tables from FY2022), lpr_expanded (Tables 8-11 split into adjustments of status and new arrivals), refugees, asylees (refugees_asylees: the combined workbook up to FY2022), naturalizations, nonimmigrant, enforcement; *_supplementary = the separate supplementary zip of FY2015-2021"},
|
|
14
|
+
"fiscal_year": {"in": "path", "desc": "fiscal year of the yearbook (Oct-Sep), e.g. 2024; default: the newest year page that has the topic's file"},
|
|
15
|
+
"table": {"in": "spec", "desc": "sheet name as published, e.g. \"Table 6\", \"LPRSuppTable 1\", \"NISuppTable1\" (also \"6\" or \"table6\"); a wrong or missing name fails with the workbook's sheets and their titles"},
|
|
16
|
+
"header_row": {"in": "spec", "desc": "optional: 1-based row (among the rows the workbook stores) that holds the column names; default: detected"}
|
|
17
|
+
},
|
|
18
|
+
"records": "$xlsx",
|
|
19
|
+
"paging": {"type": "none"}
|
|
20
|
+
},
|
|
21
|
+
"lir_table": {
|
|
22
|
+
"path": "/topics/immigration/legal-immigration-and-adjustment-status-report",
|
|
23
|
+
"description": "One table of the quarterly Legal Immigration and Adjustment of Status Report workbook (preliminary quarterly LPR, refugee, naturalization and nonimmigrant counts for the fiscal year so far, FY2016 on). Read the same way as yearbook_table.",
|
|
24
|
+
"params": {
|
|
25
|
+
"fiscal_year": {"in": "spec", "desc": "fiscal year of the report, e.g. 2025; default: the newest posted"},
|
|
26
|
+
"table": {"in": "spec", "desc": "sheet name, e.g. \"Table 1A\" (LPR by nationality and quarter), \"Table 1B\" (LPR by class of admission), \"Table 2\" (refugee arrivals), \"Table 3\" (naturalizations), \"Table 4A\"/\"Table 4B\" (nonimmigrant admissions)"},
|
|
27
|
+
"header_row": {"in": "spec", "desc": "optional: 1-based header row; default: detected"}
|
|
28
|
+
},
|
|
29
|
+
"records": "$xlsx",
|
|
30
|
+
"paging": {"type": "none"}
|
|
31
|
+
},
|
|
32
|
+
"yearbook_files": {
|
|
33
|
+
"path": "/topics/immigration/yearbook/{fiscal_year}",
|
|
34
|
+
"description": "The data files posted on a yearbook year page (one row per file: fiscal_year, topic, title, url, format), scraped from the page because the file names carry upload dates. Use it to see what a year has before asking for a table.",
|
|
35
|
+
"params": {
|
|
36
|
+
"fiscal_year": {"in": "path", "desc": "one year (2015 on has data files), a list of years, or omit for the newest year page"},
|
|
37
|
+
"topic": {"in": "spec", "desc": "optional: keep only this topic's files (same names as yearbook_table)"}
|
|
38
|
+
},
|
|
39
|
+
"paging": {"type": "none"}
|
|
40
|
+
},
|
|
41
|
+
"lir_files": {
|
|
42
|
+
"path": "/topics/immigration/legal-immigration-and-adjustment-status-report",
|
|
43
|
+
"description": "The Legal Immigration and Adjustment of Status Report workbooks posted (one row per fiscal year: fiscal_year, through_quarter, title, url).",
|
|
44
|
+
"params": {},
|
|
45
|
+
"paging": {"type": "none"}
|
|
46
|
+
}
|
|
47
|
+
},
|
|
48
|
+
"catalog": {
|
|
49
|
+
"lpr": {"id": "lpr", "endpoint": "yearbook_table", "name": "Lawful permanent residents (green cards), Yearbook Tables 1-12",
|
|
50
|
+
"description": "persons obtaining lawful permanent resident status (green card holders) by year, country of birth, last residence, state, metro area, class of admission (family, employment, diversity, refugee, asylee), adjustments of status vs new arrivals, sex, age, occupation"},
|
|
51
|
+
"lpr_expanded": {"id": "lpr_expanded", "endpoint": "yearbook_table", "name": "Expanded Tables 8-11 (adjustments of status and new arrivals)",
|
|
52
|
+
"description": "LPR demographic and country tables split by adjustment of status and new arrival"},
|
|
53
|
+
"refugees": {"id": "refugees", "endpoint": "yearbook_table", "name": "Refugee arrivals, Yearbook Tables 13-15",
|
|
54
|
+
"description": "refugee arrivals by year, country of nationality, relationship, sex, age"},
|
|
55
|
+
"asylees": {"id": "asylees", "endpoint": "yearbook_table", "name": "Individuals granted asylum, Yearbook Tables 16-20",
|
|
56
|
+
"description": "asylum granted affirmatively (USCIS) or defensively (immigration courts) by country of nationality"},
|
|
57
|
+
"naturalizations": {"id": "naturalizations", "endpoint": "yearbook_table", "name": "Naturalizations, Yearbook Tables 21-25",
|
|
58
|
+
"description": "persons naturalized (new U.S. citizens), applications filed and denied, by country of birth, state, metro area"},
|
|
59
|
+
"nonimmigrant": {"id": "nonimmigrant", "endpoint": "yearbook_table", "name": "Nonimmigrant admissions, Yearbook Tables 26-33",
|
|
60
|
+
"description": "temporary visitor admissions (I-94) by class of admission (tourist, student F-1, H-1B worker), country of citizenship, state of destination, month"},
|
|
61
|
+
"enforcement": {"id": "enforcement", "endpoint": "yearbook_table", "name": "Immigration enforcement actions, Yearbook Tables 33-42",
|
|
62
|
+
"description": "apprehensions, encounters, inadmissibility determinations, removals (deportations), returns, expulsions by country of nationality and criminal status"},
|
|
63
|
+
"lir": {"id": "lir", "endpoint": "lir_table", "name": "Legal Immigration and Adjustment of Status Report (quarterly)",
|
|
64
|
+
"description": "preliminary quarterly green card, refugee, naturalization and nonimmigrant admission counts for the current fiscal year"}
|
|
65
|
+
}
|
|
66
|
+
}
|