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.
Files changed (292) hide show
  1. package/README.md +286 -262
  2. package/dist/adapters/bjs.d.ts +13 -0
  3. package/dist/adapters/bjs.js +28 -0
  4. package/dist/adapters/bjs.js.map +1 -0
  5. package/dist/adapters/cbp.d.ts +5 -0
  6. package/dist/adapters/cbp.js +64 -0
  7. package/dist/adapters/cbp.js.map +1 -0
  8. package/dist/adapters/cdc-wonder.d.ts +5 -0
  9. package/dist/adapters/cdc-wonder.js +68 -0
  10. package/dist/adapters/cdc-wonder.js.map +1 -0
  11. package/dist/adapters/cpsc.d.ts +4 -0
  12. package/dist/adapters/cpsc.js +125 -0
  13. package/dist/adapters/cpsc.js.map +1 -0
  14. package/dist/adapters/fhwa.d.ts +9 -0
  15. package/dist/adapters/fhwa.js +16 -0
  16. package/dist/adapters/fhwa.js.map +1 -0
  17. package/dist/adapters/foreign-assistance.d.ts +9 -0
  18. package/dist/adapters/foreign-assistance.js +42 -0
  19. package/dist/adapters/foreign-assistance.js.map +1 -0
  20. package/dist/adapters/hud-ahar.d.ts +3 -0
  21. package/dist/adapters/hud-ahar.js +80 -0
  22. package/dist/adapters/hud-ahar.js.map +1 -0
  23. package/dist/adapters/nces.d.ts +10 -0
  24. package/dist/adapters/nces.js +32 -0
  25. package/dist/adapters/nces.js.map +1 -0
  26. package/dist/adapters/nsf.d.ts +11 -0
  27. package/dist/adapters/nsf.js +25 -0
  28. package/dist/adapters/nsf.js.map +1 -0
  29. package/dist/adapters/onrr.d.ts +9 -0
  30. package/dist/adapters/onrr.js +35 -0
  31. package/dist/adapters/onrr.js.map +1 -0
  32. package/dist/adapters/sba.d.ts +10 -0
  33. package/dist/adapters/sba.js +134 -0
  34. package/dist/adapters/sba.js.map +1 -0
  35. package/dist/adapters/treasury-tic.d.ts +30 -0
  36. package/dist/adapters/treasury-tic.js +149 -0
  37. package/dist/adapters/treasury-tic.js.map +1 -0
  38. package/dist/adapters/uscourts.d.ts +8 -0
  39. package/dist/adapters/uscourts.js +8 -0
  40. package/dist/adapters/uscourts.js.map +1 -0
  41. package/dist/analysis/cite.d.ts +9 -1
  42. package/dist/analysis/cite.js +9 -2
  43. package/dist/analysis/cite.js.map +1 -1
  44. package/dist/bin/cli.d.ts +2 -0
  45. package/dist/bin/cli.js +17 -0
  46. package/dist/bin/cli.js.map +1 -1
  47. package/dist/core/generic-rest.js +42 -17
  48. package/dist/core/generic-rest.js.map +1 -1
  49. package/dist/core/guard.d.ts +32 -0
  50. package/dist/core/guard.js +176 -0
  51. package/dist/core/guard.js.map +1 -0
  52. package/dist/core/http.d.ts +10 -0
  53. package/dist/core/http.js +36 -7
  54. package/dist/core/http.js.map +1 -1
  55. package/dist/core/keys.d.ts +13 -3
  56. package/dist/core/keys.js +67 -7
  57. package/dist/core/keys.js.map +1 -1
  58. package/dist/core/package.d.ts +12 -3
  59. package/dist/core/package.js +56 -12
  60. package/dist/core/package.js.map +1 -1
  61. package/dist/core/secret_patterns.d.ts +6 -0
  62. package/dist/core/secret_patterns.js +20 -0
  63. package/dist/core/secret_patterns.js.map +1 -0
  64. package/dist/core/tabular.d.ts +43 -1
  65. package/dist/core/tabular.js +149 -6
  66. package/dist/core/tabular.js.map +1 -1
  67. package/dist/envelope.js +3 -1
  68. package/dist/envelope.js.map +1 -1
  69. package/dist/index.d.ts +29 -22
  70. package/dist/index.js +45 -46
  71. package/dist/index.js.map +1 -1
  72. package/dist/remote/app.js +87 -31
  73. package/dist/remote/app.js.map +1 -1
  74. package/dist/remote/oauth.js +8 -1
  75. package/dist/remote/oauth.js.map +1 -1
  76. package/dist/remote/pages.d.ts +3 -7
  77. package/dist/remote/pages.js +49 -19
  78. package/dist/remote/pages.js.map +1 -1
  79. package/dist/remote/sign.d.ts +7 -1
  80. package/dist/remote/sign.js +33 -7
  81. package/dist/remote/sign.js.map +1 -1
  82. package/dist/remote/store.js +14 -5
  83. package/dist/remote/store.js.map +1 -1
  84. package/dist/report/audit_report.js +29 -7
  85. package/dist/report/audit_report.js.map +1 -1
  86. package/dist/report/build_report.js +34 -4
  87. package/dist/report/build_report.js.map +1 -1
  88. package/dist/report/method_audit.js +10 -1
  89. package/dist/report/method_audit.js.map +1 -1
  90. package/dist/report/scan_secrets.d.ts +4 -1
  91. package/dist/report/scan_secrets.js +38 -18
  92. package/dist/report/scan_secrets.js.map +1 -1
  93. package/dist/server.d.ts +3 -1
  94. package/dist/server.js +46 -13
  95. package/dist/server.js.map +1 -1
  96. package/dist/tools.js +27 -6
  97. package/dist/tools.js.map +1 -1
  98. package/guide/WORKFLOW.md +134 -134
  99. package/guide/assets/disclaimer.txt +1 -1
  100. package/guide/assets/download_data.ps1 +164 -162
  101. package/guide/assets/download_data.sh +8 -2
  102. package/guide/assets/report_template.html +597 -597
  103. package/guide/references/routing.md +198 -171
  104. package/guide/references/style_guide.md +398 -398
  105. package/package.json +56 -56
  106. package/packs/acf/endpoints.json +114 -114
  107. package/packs/acf/policy.json +104 -104
  108. package/packs/actuaries/endpoints.json +82 -82
  109. package/packs/actuaries/policy.json +109 -109
  110. package/packs/bea/assets/download_bea.ps1 +182 -182
  111. package/packs/bea/docs/bea_api.md +461 -461
  112. package/packs/bea/docs/datasets.md +157 -157
  113. package/packs/bea/docs/report_patterns.md +112 -112
  114. package/packs/bea/policy.json +170 -170
  115. package/packs/bea/source.md +152 -152
  116. package/packs/bjs/endpoints.json +150 -0
  117. package/packs/bjs/policy.json +114 -0
  118. package/packs/bjs/source.md +98 -0
  119. package/packs/bls/assets/download_bls.ps1 +152 -152
  120. package/packs/bls/docs/analysis_patterns.md +108 -108
  121. package/packs/bls/docs/bls_api.md +73 -73
  122. package/packs/bls/docs/series_ids.md +149 -149
  123. package/packs/bls/policy.json +238 -238
  124. package/packs/bts/endpoints.json +346 -346
  125. package/packs/bts/policy.json +94 -94
  126. package/packs/cbp/endpoints.json +31 -0
  127. package/packs/cbp/policy.json +85 -0
  128. package/packs/cbp/source.md +57 -0
  129. package/packs/cdc/endpoints.json +197 -197
  130. package/packs/cdc/policy.json +83 -83
  131. package/packs/cdc/source.md +1 -1
  132. package/packs/cdc-wonder/endpoints.json +26 -0
  133. package/packs/cdc-wonder/policy.json +84 -0
  134. package/packs/cdc-wonder/source.md +53 -0
  135. package/packs/census/endpoints.json +99 -99
  136. package/packs/cfpb/endpoints.json +326 -326
  137. package/packs/cfpb/policy.json +119 -119
  138. package/packs/clinical-trials/endpoints.json +166 -166
  139. package/packs/clinical-trials/policy.json +84 -84
  140. package/packs/cms/endpoints.json +69 -69
  141. package/packs/cms/policy.json +96 -96
  142. package/packs/college-scorecard/endpoints.json +252 -252
  143. package/packs/college-scorecard/policy.json +106 -106
  144. package/packs/college-scorecard/source.md +1 -1
  145. package/packs/congress/endpoints.json +1701 -1701
  146. package/packs/congress/policy.json +117 -117
  147. package/packs/cpsc/endpoints.json +91 -0
  148. package/packs/cpsc/policy.json +91 -0
  149. package/packs/cpsc/source.md +76 -0
  150. package/packs/dhs-ohss/endpoints.json +66 -66
  151. package/packs/dhs-ohss/policy.json +107 -107
  152. package/packs/dhs-ohss/source.md +1 -1
  153. package/packs/doj-news/endpoints.json +59 -59
  154. package/packs/doj-news/policy.json +96 -96
  155. package/packs/doj-news/source.md +1 -1
  156. package/packs/dol/endpoints.json +817 -817
  157. package/packs/dol/policy.json +135 -135
  158. package/packs/eia/endpoints.json +717 -717
  159. package/packs/eia/policy.json +112 -112
  160. package/packs/epa/endpoints.json +291 -291
  161. package/packs/epa/policy.json +99 -99
  162. package/packs/epa-aqs/endpoints.json +173 -173
  163. package/packs/epa-aqs/policy.json +96 -96
  164. package/packs/fbi/endpoints.json +1841 -1841
  165. package/packs/fbi/policy.json +118 -118
  166. package/packs/fbi/source.md +3 -3
  167. package/packs/fda/endpoints.json +237 -237
  168. package/packs/fda/policy.json +121 -121
  169. package/packs/fdic/endpoints.json +416 -416
  170. package/packs/fdic/policy.json +83 -83
  171. package/packs/fec/endpoints.json +707 -707
  172. package/packs/fec/policy.json +93 -93
  173. package/packs/fed-board/endpoints.json +89 -89
  174. package/packs/fed-board/policy.json +136 -136
  175. package/packs/federal-register/endpoints.json +143 -143
  176. package/packs/federal-register/policy.json +86 -86
  177. package/packs/fema/endpoints.json +645 -645
  178. package/packs/fema/policy.json +103 -103
  179. package/packs/fhfa/endpoints.json +105 -105
  180. package/packs/fhfa/policy.json +109 -109
  181. package/packs/fhwa/endpoints.json +48 -0
  182. package/packs/fhwa/policy.json +91 -0
  183. package/packs/fhwa/source.md +59 -0
  184. package/packs/foreign-assistance/endpoints.json +166 -0
  185. package/packs/foreign-assistance/policy.json +80 -0
  186. package/packs/foreign-assistance/source.md +76 -0
  187. package/packs/fred/assets/download_fred.ps1 +122 -122
  188. package/packs/fred/docs/analysis_patterns.md +124 -124
  189. package/packs/fred/docs/fred_api.md +94 -94
  190. package/packs/fred/docs/series.md +188 -188
  191. package/packs/fred/policy.json +253 -253
  192. package/packs/fsa/endpoints.json +150 -150
  193. package/packs/fsa/policy.json +99 -99
  194. package/packs/fsa/source.md +1 -1
  195. package/packs/govinfo/endpoints.json +519 -519
  196. package/packs/gsa-calc/endpoints.json +93 -93
  197. package/packs/gsa-calc/policy.json +97 -97
  198. package/packs/hud/endpoints.json +146 -146
  199. package/packs/hud/policy.json +84 -84
  200. package/packs/hud/source.md +1 -1
  201. package/packs/hud-ahar/endpoints.json +92 -0
  202. package/packs/hud-ahar/policy.json +88 -0
  203. package/packs/hud-ahar/source.md +72 -0
  204. package/packs/ipums/docs/report_patterns.md +117 -117
  205. package/packs/irs-soi/endpoints.json +114 -114
  206. package/packs/irs-soi/policy.json +107 -107
  207. package/packs/medicaid/endpoints.json +412 -412
  208. package/packs/medicaid/policy.json +108 -108
  209. package/packs/naep/endpoints.json +217 -217
  210. package/packs/naep/policy.json +100 -100
  211. package/packs/naep/source.md +1 -1
  212. package/packs/nces/endpoints.json +101 -0
  213. package/packs/nces/policy.json +99 -0
  214. package/packs/nces/source.md +75 -0
  215. package/packs/nhtsa/endpoints.json +132 -132
  216. package/packs/nhtsa/policy.json +93 -93
  217. package/packs/nhtsa/source.md +1 -1
  218. package/packs/nih/endpoints.json +452 -452
  219. package/packs/nih/policy.json +86 -86
  220. package/packs/noaa/endpoints.json +431 -431
  221. package/packs/noaa/policy.json +95 -95
  222. package/packs/nrel/endpoints.json +327 -327
  223. package/packs/nrel/policy.json +96 -96
  224. package/packs/nsf/endpoints.json +33 -0
  225. package/packs/nsf/policy.json +83 -0
  226. package/packs/nsf/source.md +59 -0
  227. package/packs/nws/endpoints.json +271 -271
  228. package/packs/nws/policy.json +82 -82
  229. package/packs/nyfed/endpoints.json +80 -80
  230. package/packs/nyfed/policy.json +92 -92
  231. package/packs/omb/endpoints.json +460 -460
  232. package/packs/omb/policy.json +106 -106
  233. package/packs/onrr/endpoints.json +198 -0
  234. package/packs/onrr/policy.json +91 -0
  235. package/packs/onrr/source.md +55 -0
  236. package/packs/open-payments/endpoints.json +297 -297
  237. package/packs/open-payments/policy.json +101 -101
  238. package/packs/opm/assets/download_opm.ps1 +125 -125
  239. package/packs/opm/docs/fields.md +184 -184
  240. package/packs/opm/docs/opm_api.md +71 -71
  241. package/packs/opm/docs/report_patterns.md +83 -83
  242. package/packs/opm/lib/data_dictionary.csv +73 -73
  243. package/packs/pbgc/endpoints.json +483 -483
  244. package/packs/pbgc/policy.json +94 -94
  245. package/packs/philfed/endpoints.json +85 -85
  246. package/packs/philfed/policy.json +94 -94
  247. package/packs/port.json +65 -0
  248. package/packs/regulations/endpoints.json +287 -287
  249. package/packs/regulations/policy.json +86 -86
  250. package/packs/sba/endpoints.json +34 -0
  251. package/packs/sba/policy.json +86 -0
  252. package/packs/sba/source.md +60 -0
  253. package/packs/sec/endpoints.json +236 -236
  254. package/packs/sec/policy.json +86 -86
  255. package/packs/senate-lobbying/endpoints.json +553 -553
  256. package/packs/senate-lobbying/policy.json +99 -99
  257. package/packs/snapqc/endpoints.json +1426 -1426
  258. package/packs/snapqc/policy.json +92 -92
  259. package/packs/treasury/catalog.json +2267 -2267
  260. package/packs/treasury/docs/api_guide.md +245 -245
  261. package/packs/treasury/docs/datasets.md +56 -56
  262. package/packs/treasury/docs/report_patterns.md +126 -126
  263. package/packs/treasury/policy.json +159 -159
  264. package/packs/treasury/source.md +170 -165
  265. package/packs/treasury-tic/endpoints.json +77 -0
  266. package/packs/treasury-tic/policy.json +89 -0
  267. package/packs/treasury-tic/source.md +80 -0
  268. package/packs/treasury-yields/endpoints.json +226 -226
  269. package/packs/treasury-yields/policy.json +86 -86
  270. package/packs/usaspending/endpoints.json +1315 -1315
  271. package/packs/usaspending/policy.json +109 -109
  272. package/packs/uscourts/endpoints.json +22 -0
  273. package/packs/uscourts/policy.json +87 -0
  274. package/packs/uscourts/source.md +56 -0
  275. package/packs/usda-fna/policy.json +133 -133
  276. package/packs/usda-fooddata/endpoints.json +180 -180
  277. package/packs/usda-fooddata/policy.json +94 -94
  278. package/packs/usda-nass/endpoints.json +323 -323
  279. package/packs/usda-nass/policy.json +95 -95
  280. package/packs/usda-outlook/endpoints.json +86 -86
  281. package/packs/usda-outlook/policy.json +109 -109
  282. package/packs/usgs/endpoints.json +313 -313
  283. package/packs/usgs/policy.json +95 -95
  284. package/packs/usitc/endpoints.json +74 -74
  285. package/packs/usitc/policy.json +111 -111
  286. package/packs/uspto/endpoints.json +141 -141
  287. package/packs/uspto/policy.json +95 -95
  288. package/packs/uspto/source.md +1 -1
  289. package/packs/va/endpoints.json +414 -414
  290. package/packs/va/policy.json +101 -101
  291. package/packs/world-bank/endpoints.json +122 -122
  292. package/packs/world-bank/policy.json +101 -101
@@ -1,95 +1,95 @@
1
- {
2
- "id": "usgs",
3
- "title": "USGS earthquakes (ComCat) and Water Data (streamflow, groundwater)",
4
- "agency": "U.S. Geological Survey (U.S. Department of the Interior)",
5
- "depth": "standard",
6
- "domains": [
7
- "natural hazards",
8
- "earthquakes",
9
- "water",
10
- "environment"
11
- ],
12
- "keywords": [
13
- "earthquake",
14
- "earthquakes",
15
- "seismic",
16
- "magnitude",
17
- "quake",
18
- "tsunami",
19
- "usgs",
20
- "streamflow",
21
- "stream flow",
22
- "river flow",
23
- "discharge",
24
- "gage height",
25
- "river level",
26
- "flood stage",
27
- "groundwater",
28
- "water level",
29
- "water temperature",
30
- "nwis",
31
- "drought",
32
- "peak flow"
33
- ],
34
- "questions": [
35
- "earthquakes of magnitude 5 or more in California since 2000",
36
- "how many earthquakes hit Oklahoma each year",
37
- "daily streamflow of the Potomac River last year",
38
- "current river levels in a state",
39
- "groundwater level trend at a well"
40
- ],
41
- "homepage": "https://www.usgs.gov/products/data",
42
- "terms_url": "https://www.usgs.gov/information-policies-and-instructions/copyrights-and-credits",
43
- "auth": {
44
- "env": "DATA_GOV_API_KEY",
45
- "required": "optional",
46
- "placement": "header",
47
- "param": "X-Api-Key",
48
- "home": "data-gov",
49
- "signup_url": "https://api.waterdata.usgs.gov/signup/",
50
- "echoes_key": false,
51
- "key_only": [
52
- "more than a few water-data requests an hour (an api.data.gov key allows about 1,000 an hour); earthquakes never need a key"
53
- ]
54
- },
55
- "limits": {
56
- "rps": 2,
57
- "burst": 5,
58
- "max_rows": 200000
59
- },
60
- "routes": {
61
- "api": {
62
- "base": "https://api.waterdata.usgs.gov/ogcapi/v1",
63
- "probe": "https://earthquake.usgs.gov/fdsnws/event/1/version",
64
- "hosts": [
65
- "earthquake.usgs.gov",
66
- "api.waterdata.usgs.gov"
67
- ]
68
- },
69
- "manual": {
70
- "how": "Open each link in manual_download/INSTRUCTIONS.md in a browser and save the JSON under the name shown (earthquakes: add &format=csv for CSV; water: change f=json to f=csv), then upload. Without the links: earthquakes at https://earthquake.usgs.gov/earthquakes/search/ (Output Options > CSV); water at https://waterdata.usgs.gov (site page > Download data)."
71
- }
72
- },
73
- "cache": {
74
- "mode": "run_only",
75
- "ttl_hours": null,
76
- "why": "Earthquake locations and magnitudes are revised for days to months and provisional water data change; data/ is reused only within a run."
77
- },
78
- "redistribution": {
79
- "mode": "allowed",
80
- "why": "USGS data are U.S. government works in the public domain (17 U.S.C. 105; https://www.usgs.gov/information-policies-and-instructions/copyrights-and-credits); credit the USGS."
81
- },
82
- "notices": [],
83
- "retention": null,
84
- "citation": "U.S. Geological Survey, {dataset}, retrieved {retrieved_long} (earthquake.usgs.gov / api.waterdata.usgs.gov).",
85
- "audit_hooks": [],
86
- "clarify": [
87
- "Which magnitude threshold and area (circle or box)? Counts depend strongly on both; small events are missing from older years.",
88
- "Provisional or only approved water data? Recent values are provisional (approval_status) and may be revised."
89
- ],
90
- "formats": [
91
- "geojson",
92
- "json",
93
- "csv"
94
- ]
95
- }
1
+ {
2
+ "id": "usgs",
3
+ "title": "USGS earthquakes (ComCat) and Water Data (streamflow, groundwater)",
4
+ "agency": "U.S. Geological Survey (U.S. Department of the Interior)",
5
+ "depth": "standard",
6
+ "domains": [
7
+ "natural hazards",
8
+ "earthquakes",
9
+ "water",
10
+ "environment"
11
+ ],
12
+ "keywords": [
13
+ "earthquake",
14
+ "earthquakes",
15
+ "seismic",
16
+ "magnitude",
17
+ "quake",
18
+ "tsunami",
19
+ "usgs",
20
+ "streamflow",
21
+ "stream flow",
22
+ "river flow",
23
+ "discharge",
24
+ "gage height",
25
+ "river level",
26
+ "flood stage",
27
+ "groundwater",
28
+ "water level",
29
+ "water temperature",
30
+ "nwis",
31
+ "drought",
32
+ "peak flow"
33
+ ],
34
+ "questions": [
35
+ "earthquakes of magnitude 5 or more in California since 2000",
36
+ "how many earthquakes hit Oklahoma each year",
37
+ "daily streamflow of the Potomac River last year",
38
+ "current river levels in a state",
39
+ "groundwater level trend at a well"
40
+ ],
41
+ "homepage": "https://www.usgs.gov/products/data",
42
+ "terms_url": "https://www.usgs.gov/information-policies-and-instructions/copyrights-and-credits",
43
+ "auth": {
44
+ "env": "DATA_GOV_API_KEY",
45
+ "required": "optional",
46
+ "placement": "header",
47
+ "param": "X-Api-Key",
48
+ "home": "data-gov",
49
+ "signup_url": "https://api.waterdata.usgs.gov/signup/",
50
+ "echoes_key": false,
51
+ "key_only": [
52
+ "more than a few water-data requests an hour (an api.data.gov key allows about 1,000 an hour); earthquakes never need a key"
53
+ ]
54
+ },
55
+ "limits": {
56
+ "rps": 2,
57
+ "burst": 5,
58
+ "max_rows": 200000
59
+ },
60
+ "routes": {
61
+ "api": {
62
+ "base": "https://api.waterdata.usgs.gov/ogcapi/v1",
63
+ "probe": "https://earthquake.usgs.gov/fdsnws/event/1/version",
64
+ "hosts": [
65
+ "earthquake.usgs.gov",
66
+ "api.waterdata.usgs.gov"
67
+ ]
68
+ },
69
+ "manual": {
70
+ "how": "Open each link in manual_download/INSTRUCTIONS.md in a browser and save the JSON under the name shown (earthquakes: add &format=csv for CSV; water: change f=json to f=csv), then upload. Without the links: earthquakes at https://earthquake.usgs.gov/earthquakes/search/ (Output Options > CSV); water at https://waterdata.usgs.gov (site page > Download data)."
71
+ }
72
+ },
73
+ "cache": {
74
+ "mode": "run_only",
75
+ "ttl_hours": null,
76
+ "why": "Earthquake locations and magnitudes are revised for days to months and provisional water data change; data/ is reused only within a run."
77
+ },
78
+ "redistribution": {
79
+ "mode": "allowed",
80
+ "why": "USGS data are U.S. government works in the public domain (17 U.S.C. 105; https://www.usgs.gov/information-policies-and-instructions/copyrights-and-credits); credit the USGS."
81
+ },
82
+ "notices": [],
83
+ "retention": null,
84
+ "citation": "U.S. Geological Survey, {dataset}, retrieved {retrieved_long} (earthquake.usgs.gov / api.waterdata.usgs.gov).",
85
+ "audit_hooks": [],
86
+ "clarify": [
87
+ "Which magnitude threshold and area (circle or box)? Counts depend strongly on both; small events are missing from older years.",
88
+ "Provisional or only approved water data? Recent values are provisional (approval_status) and may be revised."
89
+ ],
90
+ "formats": [
91
+ "geojson",
92
+ "json",
93
+ "csv"
94
+ ]
95
+ }
@@ -1,74 +1,74 @@
1
- {
2
- "base_url": "https://hts.usitc.gov/reststop",
3
- "timeout": 90,
4
- "endpoints": {
5
- "schedule": {
6
- "path": "/exportList",
7
- "description": "Lines of the current Harmonized Tariff Schedule (HTS) from one HTS number to another, in schedule order: htsno, indent, description, units, general (column 1 general / MFN), special (FTA and preference programs, with program codes), other (column 2), footnotes (chapter 99 references), quota. The pack adds the rate inherited by statistical (10-digit) lines, the rate type, a numeric ad valorem percent where the rate is Free or a plain percent, and the chapter 99 headings the footnotes point to.",
8
- "params": {
9
- "from": {
10
- "required": true,
11
- "desc": "first HTS number, 4 to 10 digits with or without dots (e.g. \"7208\", \"8703.80\"); chapter 99 lines (additional duties: Sections 232, 301 and other actions) start at 9903"
12
- },
13
- "to": {
14
- "required": true,
15
- "desc": "last HTS number, including every line under it (from=8703, to=8703 returns the whole heading 8703); keep ranges to a few chapters per request"
16
- },
17
- "format": {
18
- "desc": "fixed by the pack",
19
- "enum": [
20
- "JSON"
21
- ]
22
- },
23
- "styles": {
24
- "desc": "fixed by the pack",
25
- "enum": [
26
- "false"
27
- ]
28
- }
29
- },
30
- "defaults": {
31
- "format": "JSON",
32
- "styles": "false"
33
- },
34
- "records": "",
35
- "paging": {
36
- "type": "none"
37
- },
38
- "max_rows": 30000
39
- },
40
- "search": {
41
- "path": "/search",
42
- "description": "Keyword search of the current HTS (descriptions and HTS numbers), one row per matching line, in schedule order, with the same rate columns as schedule.",
43
- "params": {
44
- "keyword": {
45
- "required": true,
46
- "desc": "a word, phrase or HTS number, e.g. \"copper\", \"lithium-ion\", \"8507.60\""
47
- }
48
- },
49
- "records": "",
50
- "paging": {
51
- "type": "none"
52
- },
53
- "max_rows": 5000
54
- },
55
- "current_release": {
56
- "path": "/currentRelease",
57
- "description": "The HTS revision the API serves now (name, description, title), one row. Record it with every rate: the schedule changes several times a month.",
58
- "params": {},
59
- "records": "",
60
- "paging": {
61
- "type": "none"
62
- }
63
- },
64
- "releases": {
65
- "path": "/releaseList",
66
- "description": "Every published HTS edition and revision since 2015 (name, description, date posted, status current or archive), newest first; about 185 rows.",
67
- "params": {},
68
- "records": "",
69
- "paging": {
70
- "type": "none"
71
- }
72
- }
73
- }
74
- }
1
+ {
2
+ "base_url": "https://hts.usitc.gov/reststop",
3
+ "timeout": 90,
4
+ "endpoints": {
5
+ "schedule": {
6
+ "path": "/exportList",
7
+ "description": "Lines of the current Harmonized Tariff Schedule (HTS) from one HTS number to another, in schedule order: htsno, indent, description, units, general (column 1 general / MFN), special (FTA and preference programs, with program codes), other (column 2), footnotes (chapter 99 references), quota. The pack adds the rate inherited by statistical (10-digit) lines, the rate type, a numeric ad valorem percent where the rate is Free or a plain percent, and the chapter 99 headings the footnotes point to.",
8
+ "params": {
9
+ "from": {
10
+ "required": true,
11
+ "desc": "first HTS number, 4 to 10 digits with or without dots (e.g. \"7208\", \"8703.80\"); chapter 99 lines (additional duties: Sections 232, 301 and other actions) start at 9903"
12
+ },
13
+ "to": {
14
+ "required": true,
15
+ "desc": "last HTS number, including every line under it (from=8703, to=8703 returns the whole heading 8703); keep ranges to a few chapters per request"
16
+ },
17
+ "format": {
18
+ "desc": "fixed by the pack",
19
+ "enum": [
20
+ "JSON"
21
+ ]
22
+ },
23
+ "styles": {
24
+ "desc": "fixed by the pack",
25
+ "enum": [
26
+ "false"
27
+ ]
28
+ }
29
+ },
30
+ "defaults": {
31
+ "format": "JSON",
32
+ "styles": "false"
33
+ },
34
+ "records": "",
35
+ "paging": {
36
+ "type": "none"
37
+ },
38
+ "max_rows": 30000
39
+ },
40
+ "search": {
41
+ "path": "/search",
42
+ "description": "Keyword search of the current HTS (descriptions and HTS numbers), one row per matching line, in schedule order, with the same rate columns as schedule.",
43
+ "params": {
44
+ "keyword": {
45
+ "required": true,
46
+ "desc": "a word, phrase or HTS number, e.g. \"copper\", \"lithium-ion\", \"8507.60\""
47
+ }
48
+ },
49
+ "records": "",
50
+ "paging": {
51
+ "type": "none"
52
+ },
53
+ "max_rows": 5000
54
+ },
55
+ "current_release": {
56
+ "path": "/currentRelease",
57
+ "description": "The HTS revision the API serves now (name, description, title), one row. Record it with every rate: the schedule changes several times a month.",
58
+ "params": {},
59
+ "records": "",
60
+ "paging": {
61
+ "type": "none"
62
+ }
63
+ },
64
+ "releases": {
65
+ "path": "/releaseList",
66
+ "description": "Every published HTS edition and revision since 2015 (name, description, date posted, status current or archive), newest first; about 185 rows.",
67
+ "params": {},
68
+ "records": "",
69
+ "paging": {
70
+ "type": "none"
71
+ }
72
+ }
73
+ }
74
+ }
@@ -1,111 +1,111 @@
1
- {
2
- "id": "usitc",
3
- "title": "USITC Harmonized Tariff Schedule (HTS REST API: duty rates by HTS line)",
4
- "agency": "U.S. International Trade Commission",
5
- "depth": "standard",
6
- "domains": [
7
- "trade",
8
- "tariffs",
9
- "customs duties"
10
- ],
11
- "keywords": [
12
- "tariff rate",
13
- "duty rate",
14
- "hts",
15
- "harmonized tariff schedule",
16
- "hts code",
17
- "mfn rate",
18
- "general rate of duty",
19
- "column 2",
20
- "special rate",
21
- "free trade agreement",
22
- "preference program",
23
- "chapter 99",
24
- "section 301",
25
- "section 232",
26
- "additional duties",
27
- "ad valorem",
28
- "specific duty",
29
- "tariff schedule"
30
- ],
31
- "questions": [
32
- "what is the general (MFN) duty rate on passenger cars, HTS 8703",
33
- "which HTS lines for steel flat-rolled products are duty free under the general rate",
34
- "the statutory duty rate per HTS line, to multiply by import values for a customs revenue estimate",
35
- "which chapter 99 additional duties apply to an HTS subheading",
36
- "which free trade agreement partners get duty-free treatment on a product"
37
- ],
38
- "homepage": "https://hts.usitc.gov/",
39
- "terms_url": "https://www.usitc.gov/node/16948",
40
- "auth": {
41
- "env": null,
42
- "required": "none",
43
- "placement": "none",
44
- "param": null,
45
- "prefix": "",
46
- "home": null,
47
- "signup_url": null,
48
- "echoes_key": false,
49
- "key_only": [],
50
- "extra": {},
51
- "demo_key": null
52
- },
53
- "limits": {
54
- "rps": 1,
55
- "burst": 2,
56
- "daily_quota": null,
57
- "errors_per_min": null,
58
- "bytes_per_min": null,
59
- "max_rows": 30000
60
- },
61
- "routes": {
62
- "api": {
63
- "base": "https://hts.usitc.gov/reststop",
64
- "probe": "https://hts.usitc.gov/reststop/currentRelease",
65
- "hosts": [
66
- "hts.usitc.gov"
67
- ]
68
- },
69
- "manual": {
70
- "how": "Open each link in manual_download/INSTRUCTIONS.md in a browser and save the JSON page under the name shown, then upload it. Without the links: on https://hts.usitc.gov/ search the HTS number or keyword, or use Export (choose the range of HTS numbers and JSON or CSV) and upload the file; past editions and revisions are under 'Archive' at https://hts.usitc.gov/ (PDF and CSV per revision)."
71
- }
72
- },
73
- "cache": {
74
- "mode": "run_only",
75
- "ttl_hours": null,
76
- "why": "The schedule is revised several times a month; data/ is reused only within a run."
77
- },
78
- "redistribution": {
79
- "mode": "allowed",
80
- "why": "The HTS is published by the U.S. International Trade Commission, a U.S. government work in the public domain (17 U.S.C. 105)."
81
- },
82
- "notices": [],
83
- "retention": null,
84
- "citation": "U.S. International Trade Commission, Harmonized Tariff Schedule of the United States ({dataset}), hts.usitc.gov, retrieved {retrieved_long}.",
85
- "audit_hooks": [],
86
- "clarify": [
87
- "Which rate: the general (MFN, column 1) rate, a free trade agreement or preference rate (special), or column 2? Default: general, with any chapter 99 additional duties named separately.",
88
- "Statutory rate or the rate actually collected? Default: statutory rates from this pack; the duty actually collected on imports (calculated duty by product and country) comes from census international trade."
89
- ],
90
- "formats": [
91
- "json"
92
- ],
93
- "use_instead": [
94
- {
95
- "question": "Duties actually collected, import values and quantities by HS code and country",
96
- "source": "census",
97
- "terms": [
98
- "tariff revenue"
99
- ],
100
- "why": "Census international trade reports import values and calculated duty; the HTS gives the statutory rates only."
101
- },
102
- {
103
- "question": "Total customs duties received by the Treasury, monthly or by fiscal year",
104
- "source": "treasury",
105
- "terms": [
106
- "customs"
107
- ],
108
- "why": "The Monthly Treasury Statement reports customs duty receipts."
109
- }
110
- ]
111
- }
1
+ {
2
+ "id": "usitc",
3
+ "title": "USITC Harmonized Tariff Schedule (HTS REST API: duty rates by HTS line)",
4
+ "agency": "U.S. International Trade Commission",
5
+ "depth": "standard",
6
+ "domains": [
7
+ "trade",
8
+ "tariffs",
9
+ "customs duties"
10
+ ],
11
+ "keywords": [
12
+ "tariff rate",
13
+ "duty rate",
14
+ "hts",
15
+ "harmonized tariff schedule",
16
+ "hts code",
17
+ "mfn rate",
18
+ "general rate of duty",
19
+ "column 2",
20
+ "special rate",
21
+ "free trade agreement",
22
+ "preference program",
23
+ "chapter 99",
24
+ "section 301",
25
+ "section 232",
26
+ "additional duties",
27
+ "ad valorem",
28
+ "specific duty",
29
+ "tariff schedule"
30
+ ],
31
+ "questions": [
32
+ "what is the general (MFN) duty rate on passenger cars, HTS 8703",
33
+ "which HTS lines for steel flat-rolled products are duty free under the general rate",
34
+ "the statutory duty rate per HTS line, to multiply by import values for a customs revenue estimate",
35
+ "which chapter 99 additional duties apply to an HTS subheading",
36
+ "which free trade agreement partners get duty-free treatment on a product"
37
+ ],
38
+ "homepage": "https://hts.usitc.gov/",
39
+ "terms_url": "https://www.usitc.gov/node/16948",
40
+ "auth": {
41
+ "env": null,
42
+ "required": "none",
43
+ "placement": "none",
44
+ "param": null,
45
+ "prefix": "",
46
+ "home": null,
47
+ "signup_url": null,
48
+ "echoes_key": false,
49
+ "key_only": [],
50
+ "extra": {},
51
+ "demo_key": null
52
+ },
53
+ "limits": {
54
+ "rps": 1,
55
+ "burst": 2,
56
+ "daily_quota": null,
57
+ "errors_per_min": null,
58
+ "bytes_per_min": null,
59
+ "max_rows": 30000
60
+ },
61
+ "routes": {
62
+ "api": {
63
+ "base": "https://hts.usitc.gov/reststop",
64
+ "probe": "https://hts.usitc.gov/reststop/currentRelease",
65
+ "hosts": [
66
+ "hts.usitc.gov"
67
+ ]
68
+ },
69
+ "manual": {
70
+ "how": "Open each link in manual_download/INSTRUCTIONS.md in a browser and save the JSON page under the name shown, then upload it. Without the links: on https://hts.usitc.gov/ search the HTS number or keyword, or use Export (choose the range of HTS numbers and JSON or CSV) and upload the file; past editions and revisions are under 'Archive' at https://hts.usitc.gov/ (PDF and CSV per revision)."
71
+ }
72
+ },
73
+ "cache": {
74
+ "mode": "run_only",
75
+ "ttl_hours": null,
76
+ "why": "The schedule is revised several times a month; data/ is reused only within a run."
77
+ },
78
+ "redistribution": {
79
+ "mode": "allowed",
80
+ "why": "The HTS is published by the U.S. International Trade Commission, a U.S. government work in the public domain (17 U.S.C. 105)."
81
+ },
82
+ "notices": [],
83
+ "retention": null,
84
+ "citation": "U.S. International Trade Commission, Harmonized Tariff Schedule of the United States ({dataset}), hts.usitc.gov, retrieved {retrieved_long}.",
85
+ "audit_hooks": [],
86
+ "clarify": [
87
+ "Which rate: the general (MFN, column 1) rate, a free trade agreement or preference rate (special), or column 2? Default: general, with any chapter 99 additional duties named separately.",
88
+ "Statutory rate or the rate actually collected? Default: statutory rates from this pack; the duty actually collected on imports (calculated duty by product and country) comes from census international trade."
89
+ ],
90
+ "formats": [
91
+ "json"
92
+ ],
93
+ "use_instead": [
94
+ {
95
+ "question": "Duties actually collected, import values and quantities by HS code and country",
96
+ "source": "census",
97
+ "terms": [
98
+ "tariff revenue"
99
+ ],
100
+ "why": "Census international trade reports import values and calculated duty; the HTS gives the statutory rates only."
101
+ },
102
+ {
103
+ "question": "Total customs duties received by the Treasury, monthly or by fiscal year",
104
+ "source": "treasury",
105
+ "terms": [
106
+ "customs"
107
+ ],
108
+ "why": "The Monthly Treasury Statement reports customs duty receipts."
109
+ }
110
+ ]
111
+ }