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,132 +1,132 @@
1
- {
2
- "base_url": "https://api.nhtsa.gov",
3
- "endpoints": {
4
- "recalls_by_vehicle": {
5
- "path": "/recalls/recallsByVehicle",
6
- "description": "Safety recall campaigns for one make + model + model year (all three required).",
7
- "params": {
8
- "make": {"required": true, "desc": "make, case-insensitive: honda, toyota, ford, tesla"},
9
- "model": {"required": true, "desc": "model as NHTSA spells it: civic, camry, f-150, model 3 (see products_models)"},
10
- "modelYear": {"required": true, "desc": "model year, e.g. 2019"},
11
- "variants": {"in": "spec", "desc": "pack option, not sent (default false): true also fetches the names products_models lists as this model plus only powertrain/body/cab/drive words (HYBRID, PHEV, EV, SEDAN, (CREW CAB), AWD), one campaign once; other names starting with the model are listed in a note, never merged"}
12
- },
13
- "records": "results", "total": "Count", "paging": {"type": "none"}, "max_rows": 5000
14
- },
15
- "recall_campaign": {
16
- "path": "/recalls/campaignNumber",
17
- "description": "One recall campaign by NHTSA campaign number (one row per make/model/year covered).",
18
- "params": {"campaignNumber": {"required": true, "desc": "campaign number, e.g. 23V838000 (YY + V/E/T/C + 3 digits + 000)"}},
19
- "records": "results", "total": "Count", "paging": {"type": "none"}, "max_rows": 5000
20
- },
21
- "complaints_by_vehicle": {
22
- "path": "/complaints/complaintsByVehicle",
23
- "description": "Consumer complaints (ODI) for one make + model + model year, all on one page.",
24
- "params": {
25
- "make": {"required": true, "desc": "make"},
26
- "model": {"required": true, "desc": "model"},
27
- "modelYear": {"required": true, "desc": "model year"},
28
- "variants": {"in": "spec", "desc": "pack option, not sent (default false): true also fetches the names products_models lists as this model plus only powertrain/body/cab/drive words (complaints use those exact names), one complaint once; other names are listed in a note, never merged"}
29
- },
30
- "records": "results", "total": "count", "paging": {"type": "none"}, "max_rows": 20000
31
- },
32
- "complaint_odi": {
33
- "path": "/complaints/odinumber",
34
- "description": "One complaint by ODI number.",
35
- "params": {"odinumber": {"required": true, "desc": "ODI number, e.g. 11675912"}},
36
- "records": "results", "paging": {"type": "none"}
37
- },
38
- "products_model_years": {
39
- "path": "/products/vehicle/modelYears",
40
- "description": "Model years that have recalls (issueType r) or complaints (c).",
41
- "params": {"issueType": {"required": true, "enum": ["r", "c"], "desc": "r = recalls, c = complaints"}},
42
- "defaults": {"max": 10000},
43
- "records": "results", "paging": {"type": "none"}
44
- },
45
- "products_makes": {
46
- "path": "/products/vehicle/makes",
47
- "description": "Makes for a model year that have recalls (r) or complaints (c).",
48
- "params": {"modelYear": {"required": true, "desc": "model year"},
49
- "issueType": {"required": true, "enum": ["r", "c"], "desc": "r or c"}},
50
- "records": "results", "paging": {"type": "none"}
51
- },
52
- "products_models": {
53
- "path": "/products/vehicle/models",
54
- "description": "Models of a make and year that have recalls (r) or complaints (c): the exact names to use (the full list: the pack sends a large max).",
55
- "params": {"modelYear": {"required": true, "desc": "model year"}, "make": {"required": true, "desc": "make"},
56
- "issueType": {"required": true, "enum": ["r", "c"], "desc": "r or c"}},
57
- "defaults": {"max": 10000},
58
- "records": "results", "paging": {"type": "none"}
59
- },
60
- "ratings_model_years": {
61
- "path": "/SafetyRatings",
62
- "description": "Model years with NCAP 5-Star Safety Ratings.",
63
- "params": {}, "records": "Results", "paging": {"type": "none"}
64
- },
65
- "ratings_makes": {
66
- "path": "/SafetyRatings/modelyear/{modelYear}",
67
- "description": "Makes with NCAP ratings for a model year.",
68
- "params": {"modelYear": {"in": "path", "required": true, "desc": "model year"}},
69
- "records": "Results", "paging": {"type": "none"}
70
- },
71
- "ratings_models": {
72
- "path": "/SafetyRatings/modelyear/{modelYear}/make/{make}",
73
- "description": "Models with NCAP ratings for a make and model year.",
74
- "params": {"modelYear": {"in": "path", "required": true, "desc": "model year"},
75
- "make": {"in": "path", "required": true, "desc": "make"}},
76
- "records": "Results", "paging": {"type": "none"}
77
- },
78
- "ratings_vehicles": {
79
- "path": "/SafetyRatings/modelyear/{modelYear}/make/{make}/model/{model}",
80
- "description": "Rated variants (VehicleId, description: body style, drive) of a make + model + year.",
81
- "params": {"modelYear": {"in": "path", "required": true, "desc": "model year"},
82
- "make": {"in": "path", "required": true, "desc": "make"},
83
- "model": {"in": "path", "required": true, "desc": "model"}},
84
- "records": "Results", "paging": {"type": "none"}
85
- },
86
- "ratings_detail": {
87
- "path": "/SafetyRatings/VehicleId/{vehicleId}",
88
- "description": "NCAP star ratings (overall, frontal, side, rollover), rollover probability, ADAS fitment, and complaint/recall/investigation counts for one VehicleId.",
89
- "params": {"vehicleId": {"in": "path", "required": true, "desc": "VehicleId from ratings_vehicles, e.g. 14009"}},
90
- "records": "Results", "paging": {"type": "none"}
91
- },
92
- "vin_decode": {
93
- "path": "https://vpic.nhtsa.dot.gov/api/vehicles/DecodeVinValues/{vin}",
94
- "description": "vPIC: decode a VIN (17 characters; partial VINs with * allowed) into about 150 flat fields.",
95
- "params": {"vin": {"in": "path", "required": true, "desc": "VIN, e.g. 1HGCM82633A123456"},
96
- "modelyear": {"desc": "optional model year, helps pre-1980 and partial VINs"}},
97
- "defaults": {"format": "json"},
98
- "records": "Results", "paging": {"type": "none"}
99
- },
100
- "vpic_models_for_make_year": {
101
- "path": "https://vpic.nhtsa.dot.gov/api/vehicles/GetModelsForMakeYear/make/{make}/modelyear/{modelYear}",
102
- "description": "vPIC: every model a make produced for a model year (Make_ID, Model_ID, Model_Name).",
103
- "params": {"make": {"in": "path", "required": true, "desc": "make"},
104
- "modelYear": {"in": "path", "required": true, "desc": "model year"}},
105
- "defaults": {"format": "json"}, "records": "Results", "paging": {"type": "none"}
106
- },
107
- "vpic_models_for_make": {
108
- "path": "https://vpic.nhtsa.dot.gov/api/vehicles/GetModelsForMake/{make}",
109
- "description": "vPIC: every model of a make, all years.",
110
- "params": {"make": {"in": "path", "required": true, "desc": "make"}},
111
- "defaults": {"format": "json"}, "records": "Results", "paging": {"type": "none"}
112
- },
113
- "vpic_all_makes": {
114
- "path": "https://vpic.nhtsa.dot.gov/api/vehicles/GetAllMakes",
115
- "description": "vPIC: every make registered with NHTSA (about 12,000 rows, includes trailers and motorcycles).",
116
- "params": {}, "defaults": {"format": "json"}, "records": "Results", "paging": {"type": "none"}, "max_rows": 50000
117
- },
118
- "car_seat_stations_state": {
119
- "path": "/CSSIStation/state/{state}",
120
- "description": "Child car seat inspection stations in a state (two-letter code); 100 a page, paged with offset.",
121
- "params": {"state": {"in": "path", "required": true, "desc": "two-letter state code, upper case: CA"}},
122
- "records": "Results", "paging": {"type": "offset", "offset_param": "offset", "size": 100}, "max_rows": 20000
123
- },
124
- "car_seat_stations_zip": {
125
- "path": "/CSSIStation/zip/{zip}",
126
- "description": "Child car seat inspection stations for a ZIP code.",
127
- "params": {"zip": {"in": "path", "required": true, "desc": "5-digit ZIP"}},
128
- "records": "Results", "paging": {"type": "offset", "offset_param": "offset", "size": 100}, "max_rows": 20000
129
- }
130
- },
131
- "catalog": {}
132
- }
1
+ {
2
+ "base_url": "https://api.nhtsa.gov",
3
+ "endpoints": {
4
+ "recalls_by_vehicle": {
5
+ "path": "/recalls/recallsByVehicle",
6
+ "description": "Safety recall campaigns for one make + model + model year (all three required).",
7
+ "params": {
8
+ "make": {"required": true, "desc": "make, case-insensitive: honda, toyota, ford, tesla"},
9
+ "model": {"required": true, "desc": "model as NHTSA spells it: civic, camry, f-150, model 3 (see products_models)"},
10
+ "modelYear": {"required": true, "desc": "model year, e.g. 2019"},
11
+ "variants": {"in": "spec", "desc": "pack option, not sent (default false): true also fetches the names products_models lists as this model plus only powertrain/body/cab/drive words (HYBRID, PHEV, EV, SEDAN, (CREW CAB), AWD), one campaign once; other names starting with the model are listed in a note, never merged"}
12
+ },
13
+ "records": "results", "total": "Count", "paging": {"type": "none"}, "max_rows": 5000
14
+ },
15
+ "recall_campaign": {
16
+ "path": "/recalls/campaignNumber",
17
+ "description": "One recall campaign by NHTSA campaign number (one row per make/model/year covered).",
18
+ "params": {"campaignNumber": {"required": true, "desc": "campaign number, e.g. 23V838000 (YY + V/E/T/C + 3 digits + 000)"}},
19
+ "records": "results", "total": "Count", "paging": {"type": "none"}, "max_rows": 5000
20
+ },
21
+ "complaints_by_vehicle": {
22
+ "path": "/complaints/complaintsByVehicle",
23
+ "description": "Consumer complaints (ODI) for one make + model + model year, all on one page.",
24
+ "params": {
25
+ "make": {"required": true, "desc": "make"},
26
+ "model": {"required": true, "desc": "model"},
27
+ "modelYear": {"required": true, "desc": "model year"},
28
+ "variants": {"in": "spec", "desc": "pack option, not sent (default false): true also fetches the names products_models lists as this model plus only powertrain/body/cab/drive words (complaints use those exact names), one complaint once; other names are listed in a note, never merged"}
29
+ },
30
+ "records": "results", "total": "count", "paging": {"type": "none"}, "max_rows": 20000
31
+ },
32
+ "complaint_odi": {
33
+ "path": "/complaints/odinumber",
34
+ "description": "One complaint by ODI number.",
35
+ "params": {"odinumber": {"required": true, "desc": "ODI number, e.g. 11675912"}},
36
+ "records": "results", "paging": {"type": "none"}
37
+ },
38
+ "products_model_years": {
39
+ "path": "/products/vehicle/modelYears",
40
+ "description": "Model years that have recalls (issueType r) or complaints (c).",
41
+ "params": {"issueType": {"required": true, "enum": ["r", "c"], "desc": "r = recalls, c = complaints"}},
42
+ "defaults": {"max": 10000},
43
+ "records": "results", "paging": {"type": "none"}
44
+ },
45
+ "products_makes": {
46
+ "path": "/products/vehicle/makes",
47
+ "description": "Makes for a model year that have recalls (r) or complaints (c).",
48
+ "params": {"modelYear": {"required": true, "desc": "model year"},
49
+ "issueType": {"required": true, "enum": ["r", "c"], "desc": "r or c"}},
50
+ "records": "results", "paging": {"type": "none"}
51
+ },
52
+ "products_models": {
53
+ "path": "/products/vehicle/models",
54
+ "description": "Models of a make and year that have recalls (r) or complaints (c): the exact names to use (the full list: the pack sends a large max).",
55
+ "params": {"modelYear": {"required": true, "desc": "model year"}, "make": {"required": true, "desc": "make"},
56
+ "issueType": {"required": true, "enum": ["r", "c"], "desc": "r or c"}},
57
+ "defaults": {"max": 10000},
58
+ "records": "results", "paging": {"type": "none"}
59
+ },
60
+ "ratings_model_years": {
61
+ "path": "/SafetyRatings",
62
+ "description": "Model years with NCAP 5-Star Safety Ratings.",
63
+ "params": {}, "records": "Results", "paging": {"type": "none"}
64
+ },
65
+ "ratings_makes": {
66
+ "path": "/SafetyRatings/modelyear/{modelYear}",
67
+ "description": "Makes with NCAP ratings for a model year.",
68
+ "params": {"modelYear": {"in": "path", "required": true, "desc": "model year"}},
69
+ "records": "Results", "paging": {"type": "none"}
70
+ },
71
+ "ratings_models": {
72
+ "path": "/SafetyRatings/modelyear/{modelYear}/make/{make}",
73
+ "description": "Models with NCAP ratings for a make and model year.",
74
+ "params": {"modelYear": {"in": "path", "required": true, "desc": "model year"},
75
+ "make": {"in": "path", "required": true, "desc": "make"}},
76
+ "records": "Results", "paging": {"type": "none"}
77
+ },
78
+ "ratings_vehicles": {
79
+ "path": "/SafetyRatings/modelyear/{modelYear}/make/{make}/model/{model}",
80
+ "description": "Rated variants (VehicleId, description: body style, drive) of a make + model + year.",
81
+ "params": {"modelYear": {"in": "path", "required": true, "desc": "model year"},
82
+ "make": {"in": "path", "required": true, "desc": "make"},
83
+ "model": {"in": "path", "required": true, "desc": "model"}},
84
+ "records": "Results", "paging": {"type": "none"}
85
+ },
86
+ "ratings_detail": {
87
+ "path": "/SafetyRatings/VehicleId/{vehicleId}",
88
+ "description": "NCAP star ratings (overall, frontal, side, rollover), rollover probability, ADAS fitment, and complaint/recall/investigation counts for one VehicleId.",
89
+ "params": {"vehicleId": {"in": "path", "required": true, "desc": "VehicleId from ratings_vehicles, e.g. 14009"}},
90
+ "records": "Results", "paging": {"type": "none"}
91
+ },
92
+ "vin_decode": {
93
+ "path": "https://vpic.nhtsa.dot.gov/api/vehicles/DecodeVinValues/{vin}",
94
+ "description": "vPIC: decode a VIN (17 characters; partial VINs with * allowed) into about 150 flat fields.",
95
+ "params": {"vin": {"in": "path", "required": true, "desc": "VIN, e.g. 1HGCM82633A123456"},
96
+ "modelyear": {"desc": "optional model year, helps pre-1980 and partial VINs"}},
97
+ "defaults": {"format": "json"},
98
+ "records": "Results", "paging": {"type": "none"}
99
+ },
100
+ "vpic_models_for_make_year": {
101
+ "path": "https://vpic.nhtsa.dot.gov/api/vehicles/GetModelsForMakeYear/make/{make}/modelyear/{modelYear}",
102
+ "description": "vPIC: every model a make produced for a model year (Make_ID, Model_ID, Model_Name).",
103
+ "params": {"make": {"in": "path", "required": true, "desc": "make"},
104
+ "modelYear": {"in": "path", "required": true, "desc": "model year"}},
105
+ "defaults": {"format": "json"}, "records": "Results", "paging": {"type": "none"}
106
+ },
107
+ "vpic_models_for_make": {
108
+ "path": "https://vpic.nhtsa.dot.gov/api/vehicles/GetModelsForMake/{make}",
109
+ "description": "vPIC: every model of a make, all years.",
110
+ "params": {"make": {"in": "path", "required": true, "desc": "make"}},
111
+ "defaults": {"format": "json"}, "records": "Results", "paging": {"type": "none"}
112
+ },
113
+ "vpic_all_makes": {
114
+ "path": "https://vpic.nhtsa.dot.gov/api/vehicles/GetAllMakes",
115
+ "description": "vPIC: every make registered with NHTSA (about 12,000 rows, includes trailers and motorcycles).",
116
+ "params": {}, "defaults": {"format": "json"}, "records": "Results", "paging": {"type": "none"}, "max_rows": 50000
117
+ },
118
+ "car_seat_stations_state": {
119
+ "path": "/CSSIStation/state/{state}",
120
+ "description": "Child car seat inspection stations in a state (two-letter code); 100 a page, paged with offset.",
121
+ "params": {"state": {"in": "path", "required": true, "desc": "two-letter state code, upper case: CA"}},
122
+ "records": "Results", "paging": {"type": "offset", "offset_param": "offset", "size": 100}, "max_rows": 20000
123
+ },
124
+ "car_seat_stations_zip": {
125
+ "path": "/CSSIStation/zip/{zip}",
126
+ "description": "Child car seat inspection stations for a ZIP code.",
127
+ "params": {"zip": {"in": "path", "required": true, "desc": "5-digit ZIP"}},
128
+ "records": "Results", "paging": {"type": "offset", "offset_param": "offset", "size": 100}, "max_rows": 20000
129
+ }
130
+ },
131
+ "catalog": {}
132
+ }
@@ -1,93 +1,93 @@
1
- {
2
- "id": "nhtsa",
3
- "title": "NHTSA Vehicle Safety APIs (recalls, complaints, NCAP ratings, vPIC)",
4
- "agency": "National Highway Traffic Safety Administration (U.S. Department of Transportation)",
5
- "depth": "standard",
6
- "domains": [
7
- "vehicle safety",
8
- "transportation",
9
- "consumer protection"
10
- ],
11
- "keywords": [
12
- "recall",
13
- "recalls",
14
- "vehicle recall",
15
- "complaint",
16
- "complaints",
17
- "odi",
18
- "nhtsa",
19
- "crash test",
20
- "safety rating",
21
- "ncap",
22
- "5-star",
23
- "star rating",
24
- "rollover",
25
- "vin",
26
- "decode vin",
27
- "vpic",
28
- "vehicle make",
29
- "model",
30
- "car seat",
31
- "car",
32
- "truck",
33
- "suv",
34
- "airbag",
35
- "tesla",
36
- "autopilot"
37
- ],
38
- "questions": [
39
- "recalls for a 2019 Honda Civic",
40
- "complaints about a vehicle model by component",
41
- "crash test star ratings for a car",
42
- "decode a VIN",
43
- "car seat inspection stations in a state",
44
- "which models of a make have recalls"
45
- ],
46
- "homepage": "https://www.nhtsa.gov/nhtsa-datasets-and-apis",
47
- "terms_url": "https://www.transportation.gov/policies",
48
- "auth": {
49
- "env": null,
50
- "required": "none",
51
- "placement": "none",
52
- "signup_url": null,
53
- "echoes_key": false
54
- },
55
- "limits": {
56
- "rps": 3,
57
- "burst": 6,
58
- "max_rows": 50000
59
- },
60
- "routes": {
61
- "api": {
62
- "base": "https://api.nhtsa.gov",
63
- "probe": "https://api.nhtsa.gov/SafetyRatings",
64
- "hosts": [
65
- "api.nhtsa.gov",
66
- "vpic.nhtsa.dot.gov"
67
- ]
68
- },
69
- "manual": {
70
- "how": "Open each link in manual_download/INSTRUCTIONS.md in a browser (each returns JSON; save it under the name shown) and upload the files. Without the links: recalls and complaints are searchable at https://www.nhtsa.gov/recalls (enter make, model, year), ratings at https://www.nhtsa.gov/ratings, VIN decoding at https://vpic.nhtsa.dot.gov/decoder/; bulk flat files of all recalls and complaints are at https://www.nhtsa.gov/nhtsa-datasets-and-apis (Flat files)."
71
- }
72
- },
73
- "cache": {
74
- "mode": "run_only",
75
- "ttl_hours": null,
76
- "why": "Small queries; recalls and complaints are added daily, so data/ is reused only within a run."
77
- },
78
- "redistribution": {
79
- "mode": "allowed",
80
- "why": "NHTSA data are U.S. government works in the public domain (17 U.S.C. 105); DOT asks for attribution and no implied endorsement."
81
- },
82
- "notices": [],
83
- "retention": null,
84
- "citation": "National Highway Traffic Safety Administration, {dataset}, api.nhtsa.gov / vpic.nhtsa.dot.gov, retrieved {retrieved_long}.",
85
- "audit_hooks": [],
86
- "clarify": [
87
- "Which exact model name and model years? Recalls and complaints are looked up per make + model + model year; a range needs one request per year.",
88
- "Complaints are unverified owner reports, not defect findings: count them as reports, and do not compare raw counts across models without sales or fleet size."
89
- ],
90
- "formats": [
91
- "json"
92
- ]
93
- }
1
+ {
2
+ "id": "nhtsa",
3
+ "title": "NHTSA Vehicle Safety APIs (recalls, complaints, NCAP ratings, vPIC)",
4
+ "agency": "National Highway Traffic Safety Administration (U.S. Department of Transportation)",
5
+ "depth": "standard",
6
+ "domains": [
7
+ "vehicle safety",
8
+ "transportation",
9
+ "consumer protection"
10
+ ],
11
+ "keywords": [
12
+ "recall",
13
+ "recalls",
14
+ "vehicle recall",
15
+ "complaint",
16
+ "complaints",
17
+ "odi",
18
+ "nhtsa",
19
+ "crash test",
20
+ "safety rating",
21
+ "ncap",
22
+ "5-star",
23
+ "star rating",
24
+ "rollover",
25
+ "vin",
26
+ "decode vin",
27
+ "vpic",
28
+ "vehicle make",
29
+ "model",
30
+ "car seat",
31
+ "car",
32
+ "truck",
33
+ "suv",
34
+ "airbag",
35
+ "tesla",
36
+ "autopilot"
37
+ ],
38
+ "questions": [
39
+ "recalls for a 2019 Honda Civic",
40
+ "complaints about a vehicle model by component",
41
+ "crash test star ratings for a car",
42
+ "decode a VIN",
43
+ "car seat inspection stations in a state",
44
+ "which models of a make have recalls"
45
+ ],
46
+ "homepage": "https://www.nhtsa.gov/nhtsa-datasets-and-apis",
47
+ "terms_url": "https://www.transportation.gov/policies",
48
+ "auth": {
49
+ "env": null,
50
+ "required": "none",
51
+ "placement": "none",
52
+ "signup_url": null,
53
+ "echoes_key": false
54
+ },
55
+ "limits": {
56
+ "rps": 3,
57
+ "burst": 6,
58
+ "max_rows": 50000
59
+ },
60
+ "routes": {
61
+ "api": {
62
+ "base": "https://api.nhtsa.gov",
63
+ "probe": "https://api.nhtsa.gov/SafetyRatings",
64
+ "hosts": [
65
+ "api.nhtsa.gov",
66
+ "vpic.nhtsa.dot.gov"
67
+ ]
68
+ },
69
+ "manual": {
70
+ "how": "Open each link in manual_download/INSTRUCTIONS.md in a browser (each returns JSON; save it under the name shown) and upload the files. Without the links: recalls and complaints are searchable at https://www.nhtsa.gov/recalls (enter make, model, year), ratings at https://www.nhtsa.gov/ratings, VIN decoding at https://vpic.nhtsa.dot.gov/decoder/; bulk flat files of all recalls and complaints are at https://www.nhtsa.gov/nhtsa-datasets-and-apis (Flat files)."
71
+ }
72
+ },
73
+ "cache": {
74
+ "mode": "run_only",
75
+ "ttl_hours": null,
76
+ "why": "Small queries; recalls and complaints are added daily, so data/ is reused only within a run."
77
+ },
78
+ "redistribution": {
79
+ "mode": "allowed",
80
+ "why": "NHTSA data are U.S. government works in the public domain (17 U.S.C. 105); DOT asks for attribution and no implied endorsement."
81
+ },
82
+ "notices": [],
83
+ "retention": null,
84
+ "citation": "National Highway Traffic Safety Administration, {dataset}, api.nhtsa.gov / vpic.nhtsa.dot.gov, retrieved {retrieved_long}.",
85
+ "audit_hooks": [],
86
+ "clarify": [
87
+ "Which exact model name and model years? Recalls and complaints are looked up per make + model + model year; a range needs one request per year.",
88
+ "Complaints are unverified owner reports, not defect findings: count them as reports, and do not compare raw counts across models without sales or fleet size."
89
+ ],
90
+ "formats": [
91
+ "json"
92
+ ]
93
+ }
@@ -6,7 +6,7 @@ Investigation (ODI), NCAP 5-Star crash ratings, VIN decoding (vPIC), and child c
6
6
  - Recalls of a make/model/model year or a campaign; complaints about a model (crashes, fires, injuries,
7
7
  components); crash-test star ratings and rollover risk; decoding a VIN; models a make built in a year.
8
8
  - Not here: crash fatality statistics (FARS/CRSS: not covered by this pack; say so), traffic volumes and
9
- transport statistics (bts or dot packs if present), product recalls outside vehicles (cpsc, fda).
9
+ transport statistics (bts, fhwa), product recalls outside vehicles (cpsc, fda).
10
10
  - Records are text and counts of reports. They are not defect rates: there is no fleet size or sales data.
11
11
 
12
12
  ## Endpoints and datasets