data-analyst-mcp 0.3.0 → 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.
Files changed (153) hide show
  1. package/README.md +262 -262
  2. package/dist/report/method_audit.js +7 -1
  3. package/dist/report/method_audit.js.map +1 -1
  4. package/dist/report/scan_secrets.d.ts +4 -1
  5. package/dist/report/scan_secrets.js +36 -5
  6. package/dist/report/scan_secrets.js.map +1 -1
  7. package/dist/server.d.ts +1 -1
  8. package/dist/server.js +3 -2
  9. package/dist/server.js.map +1 -1
  10. package/guide/WORKFLOW.md +134 -134
  11. package/guide/assets/disclaimer.txt +1 -1
  12. package/guide/assets/download_data.ps1 +162 -162
  13. package/guide/assets/report_template.html +597 -597
  14. package/guide/references/routing.md +171 -171
  15. package/guide/references/style_guide.md +398 -398
  16. package/package.json +56 -56
  17. package/packs/acf/endpoints.json +114 -114
  18. package/packs/acf/policy.json +104 -104
  19. package/packs/actuaries/endpoints.json +82 -82
  20. package/packs/actuaries/policy.json +109 -109
  21. package/packs/bea/assets/download_bea.ps1 +182 -182
  22. package/packs/bea/docs/bea_api.md +461 -461
  23. package/packs/bea/docs/datasets.md +157 -157
  24. package/packs/bea/docs/report_patterns.md +112 -112
  25. package/packs/bea/policy.json +170 -170
  26. package/packs/bea/source.md +152 -152
  27. package/packs/bls/assets/download_bls.ps1 +152 -152
  28. package/packs/bls/docs/analysis_patterns.md +108 -108
  29. package/packs/bls/docs/bls_api.md +73 -73
  30. package/packs/bls/docs/series_ids.md +149 -149
  31. package/packs/bls/policy.json +238 -238
  32. package/packs/bts/endpoints.json +346 -346
  33. package/packs/bts/policy.json +94 -94
  34. package/packs/cdc/endpoints.json +197 -197
  35. package/packs/cdc/policy.json +83 -83
  36. package/packs/census/endpoints.json +99 -99
  37. package/packs/cfpb/endpoints.json +326 -326
  38. package/packs/cfpb/policy.json +119 -119
  39. package/packs/clinical-trials/endpoints.json +166 -166
  40. package/packs/clinical-trials/policy.json +84 -84
  41. package/packs/cms/endpoints.json +69 -69
  42. package/packs/cms/policy.json +96 -96
  43. package/packs/college-scorecard/endpoints.json +252 -252
  44. package/packs/college-scorecard/policy.json +106 -106
  45. package/packs/congress/endpoints.json +1701 -1701
  46. package/packs/congress/policy.json +117 -117
  47. package/packs/dhs-ohss/endpoints.json +66 -66
  48. package/packs/dhs-ohss/policy.json +107 -107
  49. package/packs/doj-news/endpoints.json +59 -59
  50. package/packs/doj-news/policy.json +96 -96
  51. package/packs/dol/endpoints.json +817 -817
  52. package/packs/dol/policy.json +135 -135
  53. package/packs/eia/endpoints.json +717 -717
  54. package/packs/eia/policy.json +112 -112
  55. package/packs/epa/endpoints.json +291 -291
  56. package/packs/epa/policy.json +99 -99
  57. package/packs/epa-aqs/endpoints.json +173 -173
  58. package/packs/epa-aqs/policy.json +96 -96
  59. package/packs/fbi/endpoints.json +1841 -1841
  60. package/packs/fbi/policy.json +118 -118
  61. package/packs/fda/endpoints.json +237 -237
  62. package/packs/fda/policy.json +121 -121
  63. package/packs/fdic/endpoints.json +416 -416
  64. package/packs/fdic/policy.json +83 -83
  65. package/packs/fec/endpoints.json +707 -707
  66. package/packs/fec/policy.json +93 -93
  67. package/packs/fed-board/endpoints.json +89 -89
  68. package/packs/fed-board/policy.json +136 -136
  69. package/packs/federal-register/endpoints.json +143 -143
  70. package/packs/federal-register/policy.json +86 -86
  71. package/packs/fema/endpoints.json +645 -645
  72. package/packs/fema/policy.json +103 -103
  73. package/packs/fhfa/endpoints.json +105 -105
  74. package/packs/fhfa/policy.json +109 -109
  75. package/packs/fred/assets/download_fred.ps1 +122 -122
  76. package/packs/fred/docs/analysis_patterns.md +124 -124
  77. package/packs/fred/docs/fred_api.md +94 -94
  78. package/packs/fred/docs/series.md +188 -188
  79. package/packs/fred/policy.json +253 -253
  80. package/packs/fsa/endpoints.json +150 -150
  81. package/packs/fsa/policy.json +99 -99
  82. package/packs/govinfo/endpoints.json +519 -519
  83. package/packs/gsa-calc/endpoints.json +93 -93
  84. package/packs/gsa-calc/policy.json +97 -97
  85. package/packs/hud/endpoints.json +146 -146
  86. package/packs/hud/policy.json +84 -84
  87. package/packs/ipums/docs/report_patterns.md +117 -117
  88. package/packs/irs-soi/endpoints.json +114 -114
  89. package/packs/irs-soi/policy.json +107 -107
  90. package/packs/medicaid/endpoints.json +412 -412
  91. package/packs/medicaid/policy.json +108 -108
  92. package/packs/naep/endpoints.json +217 -217
  93. package/packs/naep/policy.json +100 -100
  94. package/packs/nhtsa/endpoints.json +132 -132
  95. package/packs/nhtsa/policy.json +93 -93
  96. package/packs/nih/endpoints.json +452 -452
  97. package/packs/nih/policy.json +86 -86
  98. package/packs/noaa/endpoints.json +431 -431
  99. package/packs/noaa/policy.json +95 -95
  100. package/packs/nrel/endpoints.json +327 -327
  101. package/packs/nrel/policy.json +96 -96
  102. package/packs/nws/endpoints.json +271 -271
  103. package/packs/nws/policy.json +82 -82
  104. package/packs/nyfed/endpoints.json +80 -80
  105. package/packs/nyfed/policy.json +92 -92
  106. package/packs/omb/endpoints.json +460 -460
  107. package/packs/omb/policy.json +106 -106
  108. package/packs/open-payments/endpoints.json +297 -297
  109. package/packs/open-payments/policy.json +101 -101
  110. package/packs/opm/assets/download_opm.ps1 +125 -125
  111. package/packs/opm/docs/fields.md +184 -184
  112. package/packs/opm/docs/opm_api.md +71 -71
  113. package/packs/opm/docs/report_patterns.md +83 -83
  114. package/packs/opm/lib/data_dictionary.csv +73 -73
  115. package/packs/pbgc/endpoints.json +483 -483
  116. package/packs/pbgc/policy.json +94 -94
  117. package/packs/philfed/endpoints.json +85 -85
  118. package/packs/philfed/policy.json +94 -94
  119. package/packs/regulations/endpoints.json +287 -287
  120. package/packs/regulations/policy.json +86 -86
  121. package/packs/sec/endpoints.json +236 -236
  122. package/packs/sec/policy.json +86 -86
  123. package/packs/senate-lobbying/endpoints.json +553 -553
  124. package/packs/senate-lobbying/policy.json +99 -99
  125. package/packs/snapqc/endpoints.json +1426 -1426
  126. package/packs/snapqc/policy.json +92 -92
  127. package/packs/treasury/catalog.json +2267 -2267
  128. package/packs/treasury/docs/api_guide.md +245 -245
  129. package/packs/treasury/docs/datasets.md +56 -56
  130. package/packs/treasury/docs/report_patterns.md +126 -126
  131. package/packs/treasury/policy.json +159 -159
  132. package/packs/treasury/source.md +170 -165
  133. package/packs/treasury-yields/endpoints.json +226 -226
  134. package/packs/treasury-yields/policy.json +86 -86
  135. package/packs/usaspending/endpoints.json +1315 -1315
  136. package/packs/usaspending/policy.json +109 -109
  137. package/packs/usda-fna/policy.json +133 -133
  138. package/packs/usda-fooddata/endpoints.json +180 -180
  139. package/packs/usda-fooddata/policy.json +94 -94
  140. package/packs/usda-nass/endpoints.json +323 -323
  141. package/packs/usda-nass/policy.json +95 -95
  142. package/packs/usda-outlook/endpoints.json +86 -86
  143. package/packs/usda-outlook/policy.json +109 -109
  144. package/packs/usgs/endpoints.json +313 -313
  145. package/packs/usgs/policy.json +95 -95
  146. package/packs/usitc/endpoints.json +74 -74
  147. package/packs/usitc/policy.json +111 -111
  148. package/packs/uspto/endpoints.json +141 -141
  149. package/packs/uspto/policy.json +95 -95
  150. package/packs/va/endpoints.json +414 -414
  151. package/packs/va/policy.json +101 -101
  152. package/packs/world-bank/endpoints.json +122 -122
  153. 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
+ }
@@ -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
+ }
@@ -1,107 +1,107 @@
1
- {
2
- "id": "dhs-ohss",
3
- "title": "DHS Office of Homeland Security Statistics: Yearbook of Immigration Statistics",
4
- "agency": "U.S. Department of Homeland Security, Office of Homeland Security Statistics",
5
- "depth": "standard",
6
- "domains": [
7
- "immigration",
8
- "demographics"
9
- ],
10
- "keywords": [
11
- "immigration statistics",
12
- "green card",
13
- "green cards",
14
- "lawful permanent resident",
15
- "lawful permanent residents",
16
- "permanent residency",
17
- "immigrants",
18
- "adjustment of status",
19
- "naturalization",
20
- "naturalizations",
21
- "new citizens",
22
- "refugees",
23
- "refugee arrivals",
24
- "asylum",
25
- "asylees",
26
- "nonimmigrant admissions",
27
- "temporary visitors",
28
- "i-94",
29
- "h-1b",
30
- "student visas",
31
- "deportations",
32
- "removals",
33
- "apprehensions",
34
- "immigration enforcement",
35
- "yearbook of immigration statistics",
36
- "dhs",
37
- "uscis"
38
- ],
39
- "questions": [
40
- "how many green cards were issued in fiscal year 2024",
41
- "lawful permanent residents by country of birth over the last decade",
42
- "family-sponsored vs employment-based green cards",
43
- "naturalizations by state",
44
- "refugee arrivals by country of nationality",
45
- "asylum grants by country",
46
- "H-1B and student nonimmigrant admissions",
47
- "removals and returns by country of nationality",
48
- "green cards so far this fiscal year by quarter"
49
- ],
50
- "homepage": "https://ohss.dhs.gov/topics/immigration/yearbook",
51
- "terms_url": "https://ohss.dhs.gov/about-our-data",
52
- "auth": {
53
- "env": null,
54
- "required": "none",
55
- "placement": "none",
56
- "param": null,
57
- "prefix": "",
58
- "home": null,
59
- "signup_url": null,
60
- "echoes_key": false,
61
- "key_only": [],
62
- "extra": {},
63
- "demo_key": null
64
- },
65
- "limits": {
66
- "rps": 1,
67
- "burst": 3,
68
- "daily_quota": null,
69
- "errors_per_min": null,
70
- "bytes_per_min": null,
71
- "max_rows": 50000
72
- },
73
- "routes": {
74
- "api": {
75
- "base": "https://ohss.dhs.gov",
76
- "probe": "https://ohss.dhs.gov/topics/immigration/yearbook",
77
- "hosts": [
78
- "ohss.dhs.gov"
79
- ]
80
- },
81
- "manual": {
82
- "how": "Open https://ohss.dhs.gov/topics/immigration/yearbook, choose the fiscal year, and download the topic's data tables workbook (e.g. \"Lawful Permanent Residents 2024 Data Tables (xlsx)\"; FY2015-2021 are .zip files); for the quarterly report open https://ohss.dhs.gov/topics/immigration/legal-immigration-and-adjustment-status-report and download the fiscal year's .xlsx. Upload the file unchanged under the name shown in INSTRUCTIONS.md: the pack reads the requested sheet from it."
83
- }
84
- },
85
- "cache": {
86
- "mode": "run_only",
87
- "ttl_hours": null,
88
- "why": "Small published workbooks that are revised and re-posted under new names; data/ is reused only within a run."
89
- },
90
- "redistribution": {
91
- "mode": "allowed",
92
- "why": "Statistics published by a U.S. federal agency are U.S. government works in the public domain (17 U.S.C. 105)."
93
- },
94
- "notices": [],
95
- "retention": null,
96
- "citation": "U.S. Department of Homeland Security, Office of Homeland Security Statistics, {dataset}, ohss.dhs.gov, retrieved {retrieved_long}.",
97
- "audit_hooks": [],
98
- "clarify": [
99
- "Which fiscal year? DHS counts by federal fiscal year (October to September), not calendar year; the newest yearbook is the default, and the quarterly report covers the current year with preliminary figures.",
100
- "All persons obtaining LPR status, or only new arrivals from abroad (or only adjustments of status inside the U.S.)? The yearbook total counts both.",
101
- "By country of birth, country of last residence, or (for refugees, asylees and the quarterly report) country of nationality? They are different tables with different counts."
102
- ],
103
- "formats": [
104
- "xlsx",
105
- "zip"
106
- ]
107
- }
1
+ {
2
+ "id": "dhs-ohss",
3
+ "title": "DHS Office of Homeland Security Statistics: Yearbook of Immigration Statistics",
4
+ "agency": "U.S. Department of Homeland Security, Office of Homeland Security Statistics",
5
+ "depth": "standard",
6
+ "domains": [
7
+ "immigration",
8
+ "demographics"
9
+ ],
10
+ "keywords": [
11
+ "immigration statistics",
12
+ "green card",
13
+ "green cards",
14
+ "lawful permanent resident",
15
+ "lawful permanent residents",
16
+ "permanent residency",
17
+ "immigrants",
18
+ "adjustment of status",
19
+ "naturalization",
20
+ "naturalizations",
21
+ "new citizens",
22
+ "refugees",
23
+ "refugee arrivals",
24
+ "asylum",
25
+ "asylees",
26
+ "nonimmigrant admissions",
27
+ "temporary visitors",
28
+ "i-94",
29
+ "h-1b",
30
+ "student visas",
31
+ "deportations",
32
+ "removals",
33
+ "apprehensions",
34
+ "immigration enforcement",
35
+ "yearbook of immigration statistics",
36
+ "dhs",
37
+ "uscis"
38
+ ],
39
+ "questions": [
40
+ "how many green cards were issued in fiscal year 2024",
41
+ "lawful permanent residents by country of birth over the last decade",
42
+ "family-sponsored vs employment-based green cards",
43
+ "naturalizations by state",
44
+ "refugee arrivals by country of nationality",
45
+ "asylum grants by country",
46
+ "H-1B and student nonimmigrant admissions",
47
+ "removals and returns by country of nationality",
48
+ "green cards so far this fiscal year by quarter"
49
+ ],
50
+ "homepage": "https://ohss.dhs.gov/topics/immigration/yearbook",
51
+ "terms_url": "https://ohss.dhs.gov/about-our-data",
52
+ "auth": {
53
+ "env": null,
54
+ "required": "none",
55
+ "placement": "none",
56
+ "param": null,
57
+ "prefix": "",
58
+ "home": null,
59
+ "signup_url": null,
60
+ "echoes_key": false,
61
+ "key_only": [],
62
+ "extra": {},
63
+ "demo_key": null
64
+ },
65
+ "limits": {
66
+ "rps": 1,
67
+ "burst": 3,
68
+ "daily_quota": null,
69
+ "errors_per_min": null,
70
+ "bytes_per_min": null,
71
+ "max_rows": 50000
72
+ },
73
+ "routes": {
74
+ "api": {
75
+ "base": "https://ohss.dhs.gov",
76
+ "probe": "https://ohss.dhs.gov/topics/immigration/yearbook",
77
+ "hosts": [
78
+ "ohss.dhs.gov"
79
+ ]
80
+ },
81
+ "manual": {
82
+ "how": "Open https://ohss.dhs.gov/topics/immigration/yearbook, choose the fiscal year, and download the topic's data tables workbook (e.g. \"Lawful Permanent Residents 2024 Data Tables (xlsx)\"; FY2015-2021 are .zip files); for the quarterly report open https://ohss.dhs.gov/topics/immigration/legal-immigration-and-adjustment-status-report and download the fiscal year's .xlsx. Upload the file unchanged under the name shown in INSTRUCTIONS.md: the pack reads the requested sheet from it."
83
+ }
84
+ },
85
+ "cache": {
86
+ "mode": "run_only",
87
+ "ttl_hours": null,
88
+ "why": "Small published workbooks that are revised and re-posted under new names; data/ is reused only within a run."
89
+ },
90
+ "redistribution": {
91
+ "mode": "allowed",
92
+ "why": "Statistics published by a U.S. federal agency are U.S. government works in the public domain (17 U.S.C. 105)."
93
+ },
94
+ "notices": [],
95
+ "retention": null,
96
+ "citation": "U.S. Department of Homeland Security, Office of Homeland Security Statistics, {dataset}, ohss.dhs.gov, retrieved {retrieved_long}.",
97
+ "audit_hooks": [],
98
+ "clarify": [
99
+ "Which fiscal year? DHS counts by federal fiscal year (October to September), not calendar year; the newest yearbook is the default, and the quarterly report covers the current year with preliminary figures.",
100
+ "All persons obtaining LPR status, or only new arrivals from abroad (or only adjustments of status inside the U.S.)? The yearbook total counts both.",
101
+ "By country of birth, country of last residence, or (for refugees, asylees and the quarterly report) country of nationality? They are different tables with different counts."
102
+ ],
103
+ "formats": [
104
+ "xlsx",
105
+ "zip"
106
+ ]
107
+ }