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.
- package/README.md +262 -262
- package/dist/report/method_audit.js +7 -1
- package/dist/report/method_audit.js.map +1 -1
- package/dist/report/scan_secrets.d.ts +4 -1
- package/dist/report/scan_secrets.js +36 -5
- package/dist/report/scan_secrets.js.map +1 -1
- package/dist/server.d.ts +1 -1
- package/dist/server.js +3 -2
- package/dist/server.js.map +1 -1
- package/guide/WORKFLOW.md +134 -134
- package/guide/assets/disclaimer.txt +1 -1
- package/guide/assets/download_data.ps1 +162 -162
- package/guide/assets/report_template.html +597 -597
- package/guide/references/routing.md +171 -171
- package/guide/references/style_guide.md +398 -398
- package/package.json +56 -56
- package/packs/acf/endpoints.json +114 -114
- package/packs/acf/policy.json +104 -104
- package/packs/actuaries/endpoints.json +82 -82
- package/packs/actuaries/policy.json +109 -109
- package/packs/bea/assets/download_bea.ps1 +182 -182
- package/packs/bea/docs/bea_api.md +461 -461
- package/packs/bea/docs/datasets.md +157 -157
- package/packs/bea/docs/report_patterns.md +112 -112
- package/packs/bea/policy.json +170 -170
- package/packs/bea/source.md +152 -152
- package/packs/bls/assets/download_bls.ps1 +152 -152
- package/packs/bls/docs/analysis_patterns.md +108 -108
- package/packs/bls/docs/bls_api.md +73 -73
- package/packs/bls/docs/series_ids.md +149 -149
- package/packs/bls/policy.json +238 -238
- package/packs/bts/endpoints.json +346 -346
- package/packs/bts/policy.json +94 -94
- package/packs/cdc/endpoints.json +197 -197
- package/packs/cdc/policy.json +83 -83
- package/packs/census/endpoints.json +99 -99
- package/packs/cfpb/endpoints.json +326 -326
- package/packs/cfpb/policy.json +119 -119
- package/packs/clinical-trials/endpoints.json +166 -166
- package/packs/clinical-trials/policy.json +84 -84
- package/packs/cms/endpoints.json +69 -69
- package/packs/cms/policy.json +96 -96
- package/packs/college-scorecard/endpoints.json +252 -252
- package/packs/college-scorecard/policy.json +106 -106
- package/packs/congress/endpoints.json +1701 -1701
- package/packs/congress/policy.json +117 -117
- package/packs/dhs-ohss/endpoints.json +66 -66
- package/packs/dhs-ohss/policy.json +107 -107
- package/packs/doj-news/endpoints.json +59 -59
- package/packs/doj-news/policy.json +96 -96
- package/packs/dol/endpoints.json +817 -817
- package/packs/dol/policy.json +135 -135
- package/packs/eia/endpoints.json +717 -717
- package/packs/eia/policy.json +112 -112
- package/packs/epa/endpoints.json +291 -291
- package/packs/epa/policy.json +99 -99
- package/packs/epa-aqs/endpoints.json +173 -173
- package/packs/epa-aqs/policy.json +96 -96
- package/packs/fbi/endpoints.json +1841 -1841
- package/packs/fbi/policy.json +118 -118
- package/packs/fda/endpoints.json +237 -237
- package/packs/fda/policy.json +121 -121
- package/packs/fdic/endpoints.json +416 -416
- package/packs/fdic/policy.json +83 -83
- package/packs/fec/endpoints.json +707 -707
- package/packs/fec/policy.json +93 -93
- package/packs/fed-board/endpoints.json +89 -89
- package/packs/fed-board/policy.json +136 -136
- package/packs/federal-register/endpoints.json +143 -143
- package/packs/federal-register/policy.json +86 -86
- package/packs/fema/endpoints.json +645 -645
- package/packs/fema/policy.json +103 -103
- package/packs/fhfa/endpoints.json +105 -105
- package/packs/fhfa/policy.json +109 -109
- package/packs/fred/assets/download_fred.ps1 +122 -122
- package/packs/fred/docs/analysis_patterns.md +124 -124
- package/packs/fred/docs/fred_api.md +94 -94
- package/packs/fred/docs/series.md +188 -188
- package/packs/fred/policy.json +253 -253
- package/packs/fsa/endpoints.json +150 -150
- package/packs/fsa/policy.json +99 -99
- package/packs/govinfo/endpoints.json +519 -519
- package/packs/gsa-calc/endpoints.json +93 -93
- package/packs/gsa-calc/policy.json +97 -97
- package/packs/hud/endpoints.json +146 -146
- package/packs/hud/policy.json +84 -84
- package/packs/ipums/docs/report_patterns.md +117 -117
- package/packs/irs-soi/endpoints.json +114 -114
- package/packs/irs-soi/policy.json +107 -107
- package/packs/medicaid/endpoints.json +412 -412
- package/packs/medicaid/policy.json +108 -108
- package/packs/naep/endpoints.json +217 -217
- package/packs/naep/policy.json +100 -100
- package/packs/nhtsa/endpoints.json +132 -132
- package/packs/nhtsa/policy.json +93 -93
- package/packs/nih/endpoints.json +452 -452
- package/packs/nih/policy.json +86 -86
- package/packs/noaa/endpoints.json +431 -431
- package/packs/noaa/policy.json +95 -95
- package/packs/nrel/endpoints.json +327 -327
- package/packs/nrel/policy.json +96 -96
- package/packs/nws/endpoints.json +271 -271
- package/packs/nws/policy.json +82 -82
- package/packs/nyfed/endpoints.json +80 -80
- package/packs/nyfed/policy.json +92 -92
- package/packs/omb/endpoints.json +460 -460
- package/packs/omb/policy.json +106 -106
- package/packs/open-payments/endpoints.json +297 -297
- package/packs/open-payments/policy.json +101 -101
- package/packs/opm/assets/download_opm.ps1 +125 -125
- package/packs/opm/docs/fields.md +184 -184
- package/packs/opm/docs/opm_api.md +71 -71
- package/packs/opm/docs/report_patterns.md +83 -83
- package/packs/opm/lib/data_dictionary.csv +73 -73
- package/packs/pbgc/endpoints.json +483 -483
- package/packs/pbgc/policy.json +94 -94
- package/packs/philfed/endpoints.json +85 -85
- package/packs/philfed/policy.json +94 -94
- package/packs/regulations/endpoints.json +287 -287
- package/packs/regulations/policy.json +86 -86
- package/packs/sec/endpoints.json +236 -236
- package/packs/sec/policy.json +86 -86
- package/packs/senate-lobbying/endpoints.json +553 -553
- package/packs/senate-lobbying/policy.json +99 -99
- package/packs/snapqc/endpoints.json +1426 -1426
- package/packs/snapqc/policy.json +92 -92
- package/packs/treasury/catalog.json +2267 -2267
- package/packs/treasury/docs/api_guide.md +245 -245
- package/packs/treasury/docs/datasets.md +56 -56
- package/packs/treasury/docs/report_patterns.md +126 -126
- package/packs/treasury/policy.json +159 -159
- package/packs/treasury/source.md +170 -165
- package/packs/treasury-yields/endpoints.json +226 -226
- package/packs/treasury-yields/policy.json +86 -86
- package/packs/usaspending/endpoints.json +1315 -1315
- package/packs/usaspending/policy.json +109 -109
- package/packs/usda-fna/policy.json +133 -133
- package/packs/usda-fooddata/endpoints.json +180 -180
- package/packs/usda-fooddata/policy.json +94 -94
- package/packs/usda-nass/endpoints.json +323 -323
- package/packs/usda-nass/policy.json +95 -95
- package/packs/usda-outlook/endpoints.json +86 -86
- package/packs/usda-outlook/policy.json +109 -109
- package/packs/usgs/endpoints.json +313 -313
- package/packs/usgs/policy.json +95 -95
- package/packs/usitc/endpoints.json +74 -74
- package/packs/usitc/policy.json +111 -111
- package/packs/uspto/endpoints.json +141 -141
- package/packs/uspto/policy.json +95 -95
- package/packs/va/endpoints.json +414 -414
- package/packs/va/policy.json +101 -101
- package/packs/world-bank/endpoints.json +122 -122
- package/packs/world-bank/policy.json +101 -101
package/packs/naep/policy.json
CHANGED
|
@@ -1,100 +1,100 @@
|
|
|
1
|
-
{
|
|
2
|
-
"id": "naep",
|
|
3
|
-
"title": "NAEP, The Nation's Report Card (NAEP Data Service)",
|
|
4
|
-
"agency": "National Center for Education Statistics (U.S. Department of Education), for the National Assessment Governing Board",
|
|
5
|
-
"depth": "standard",
|
|
6
|
-
"domains": [
|
|
7
|
-
"education",
|
|
8
|
-
"k-12",
|
|
9
|
-
"student achievement"
|
|
10
|
-
],
|
|
11
|
-
"keywords": [
|
|
12
|
-
"naep",
|
|
13
|
-
"nation's report card",
|
|
14
|
-
"test scores",
|
|
15
|
-
"reading scores",
|
|
16
|
-
"math scores",
|
|
17
|
-
"achievement",
|
|
18
|
-
"proficient",
|
|
19
|
-
"proficiency",
|
|
20
|
-
"achievement gap",
|
|
21
|
-
"4th grade",
|
|
22
|
-
"8th grade",
|
|
23
|
-
"12th grade",
|
|
24
|
-
"grade 4",
|
|
25
|
-
"grade 8",
|
|
26
|
-
"student performance",
|
|
27
|
-
"school",
|
|
28
|
-
"learning loss",
|
|
29
|
-
"science scores",
|
|
30
|
-
"civics",
|
|
31
|
-
"us history",
|
|
32
|
-
"tuda",
|
|
33
|
-
"urban district"
|
|
34
|
-
],
|
|
35
|
-
"questions": [
|
|
36
|
-
"4th grade reading scores by state",
|
|
37
|
-
"did math scores fall since 2019",
|
|
38
|
-
"percent of 8th graders proficient in math",
|
|
39
|
-
"achievement gap by race or school lunch eligibility",
|
|
40
|
-
"how a state compares with the national average",
|
|
41
|
-
"NAEP results for a large city district"
|
|
42
|
-
],
|
|
43
|
-
"homepage": "https://www.nationsreportcard.gov/",
|
|
44
|
-
"terms_url": "https://nces.ed.gov/help/copyright.asp",
|
|
45
|
-
"auth": {
|
|
46
|
-
"env": null,
|
|
47
|
-
"required": "none",
|
|
48
|
-
"placement": "none",
|
|
49
|
-
"signup_url": null,
|
|
50
|
-
"echoes_key": false
|
|
51
|
-
},
|
|
52
|
-
"limits": {
|
|
53
|
-
"rps": 2,
|
|
54
|
-
"burst": 4,
|
|
55
|
-
"max_rows": 50000
|
|
56
|
-
},
|
|
57
|
-
"routes": {
|
|
58
|
-
"api": {
|
|
59
|
-
"base": "https://www.nationsreportcard.gov",
|
|
60
|
-
"probe": "https://www.nationsreportcard.gov/Dataservice/GetAdhocData.aspx?type=data&subject=reading&grade=4&subscale=RRPCM&variable=TOTAL&jurisdiction=NP&stattype=MN:MN&Year=Current",
|
|
61
|
-
"hosts": [
|
|
62
|
-
"www.nationsreportcard.gov"
|
|
63
|
-
]
|
|
64
|
-
},
|
|
65
|
-
"manual": {
|
|
66
|
-
"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: the NAEP Data Explorer (https://www.nationsreportcard.gov/ndecore/landing) builds the same tables (choose subject, grade, jurisdictions, variables, statistics; Download > Excel); upload the export and say which table it is. The report cards at https://www.nationsreportcard.gov/ give the headline numbers with significance marks."
|
|
67
|
-
}
|
|
68
|
-
},
|
|
69
|
-
"cache": {
|
|
70
|
-
"mode": "run_only",
|
|
71
|
-
"ttl_hours": null,
|
|
72
|
-
"why": "Small queries; results change only when a new assessment is released (about every two years), but data/ is reused only within a run."
|
|
73
|
-
},
|
|
74
|
-
"redistribution": {
|
|
75
|
-
"mode": "allowed",
|
|
76
|
-
"why": "NAEP results are published by NCES, a U.S. government agency; its materials are in the public domain (17 U.S.C. 105) unless marked otherwise, and NCES asks that the source be cited."
|
|
77
|
-
},
|
|
78
|
-
"notices": [],
|
|
79
|
-
"retention": null,
|
|
80
|
-
"citation": "U.S. Department of Education, Institute of Education Sciences, National Center for Education Statistics, National Assessment of Educational Progress (NAEP), {dataset}, NAEP Data Service (nationsreportcard.gov), retrieved {retrieved_long}.",
|
|
81
|
-
"audit_hooks": [
|
|
82
|
-
{
|
|
83
|
-
"id": "naep_uncertainty",
|
|
84
|
-
"kind": "require_text",
|
|
85
|
-
"any": [
|
|
86
|
-
"standard error",
|
|
87
|
-
"significant"
|
|
88
|
-
],
|
|
89
|
-
"why": "NAEP scores are sample estimates with standard errors; a report must say whether differences are statistically significant (NAEP's own tests), not compare point estimates."
|
|
90
|
-
}
|
|
91
|
-
],
|
|
92
|
-
"clarify": [
|
|
93
|
-
"Which subject, grade(s) and year(s)? Default: reading and mathematics, grades 4 and 8, the latest year and 2019 (pre-pandemic).",
|
|
94
|
-
"Average scale score or achievement level (percent at or above Proficient)? They can move differently; default: report both.",
|
|
95
|
-
"Public schools only (NP, the comparison base for states) or all schools (NT)? Default NP when states are involved."
|
|
96
|
-
],
|
|
97
|
-
"formats": [
|
|
98
|
-
"json"
|
|
99
|
-
]
|
|
100
|
-
}
|
|
1
|
+
{
|
|
2
|
+
"id": "naep",
|
|
3
|
+
"title": "NAEP, The Nation's Report Card (NAEP Data Service)",
|
|
4
|
+
"agency": "National Center for Education Statistics (U.S. Department of Education), for the National Assessment Governing Board",
|
|
5
|
+
"depth": "standard",
|
|
6
|
+
"domains": [
|
|
7
|
+
"education",
|
|
8
|
+
"k-12",
|
|
9
|
+
"student achievement"
|
|
10
|
+
],
|
|
11
|
+
"keywords": [
|
|
12
|
+
"naep",
|
|
13
|
+
"nation's report card",
|
|
14
|
+
"test scores",
|
|
15
|
+
"reading scores",
|
|
16
|
+
"math scores",
|
|
17
|
+
"achievement",
|
|
18
|
+
"proficient",
|
|
19
|
+
"proficiency",
|
|
20
|
+
"achievement gap",
|
|
21
|
+
"4th grade",
|
|
22
|
+
"8th grade",
|
|
23
|
+
"12th grade",
|
|
24
|
+
"grade 4",
|
|
25
|
+
"grade 8",
|
|
26
|
+
"student performance",
|
|
27
|
+
"school",
|
|
28
|
+
"learning loss",
|
|
29
|
+
"science scores",
|
|
30
|
+
"civics",
|
|
31
|
+
"us history",
|
|
32
|
+
"tuda",
|
|
33
|
+
"urban district"
|
|
34
|
+
],
|
|
35
|
+
"questions": [
|
|
36
|
+
"4th grade reading scores by state",
|
|
37
|
+
"did math scores fall since 2019",
|
|
38
|
+
"percent of 8th graders proficient in math",
|
|
39
|
+
"achievement gap by race or school lunch eligibility",
|
|
40
|
+
"how a state compares with the national average",
|
|
41
|
+
"NAEP results for a large city district"
|
|
42
|
+
],
|
|
43
|
+
"homepage": "https://www.nationsreportcard.gov/",
|
|
44
|
+
"terms_url": "https://nces.ed.gov/help/copyright.asp",
|
|
45
|
+
"auth": {
|
|
46
|
+
"env": null,
|
|
47
|
+
"required": "none",
|
|
48
|
+
"placement": "none",
|
|
49
|
+
"signup_url": null,
|
|
50
|
+
"echoes_key": false
|
|
51
|
+
},
|
|
52
|
+
"limits": {
|
|
53
|
+
"rps": 2,
|
|
54
|
+
"burst": 4,
|
|
55
|
+
"max_rows": 50000
|
|
56
|
+
},
|
|
57
|
+
"routes": {
|
|
58
|
+
"api": {
|
|
59
|
+
"base": "https://www.nationsreportcard.gov",
|
|
60
|
+
"probe": "https://www.nationsreportcard.gov/Dataservice/GetAdhocData.aspx?type=data&subject=reading&grade=4&subscale=RRPCM&variable=TOTAL&jurisdiction=NP&stattype=MN:MN&Year=Current",
|
|
61
|
+
"hosts": [
|
|
62
|
+
"www.nationsreportcard.gov"
|
|
63
|
+
]
|
|
64
|
+
},
|
|
65
|
+
"manual": {
|
|
66
|
+
"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: the NAEP Data Explorer (https://www.nationsreportcard.gov/ndecore/landing) builds the same tables (choose subject, grade, jurisdictions, variables, statistics; Download > Excel); upload the export and say which table it is. The report cards at https://www.nationsreportcard.gov/ give the headline numbers with significance marks."
|
|
67
|
+
}
|
|
68
|
+
},
|
|
69
|
+
"cache": {
|
|
70
|
+
"mode": "run_only",
|
|
71
|
+
"ttl_hours": null,
|
|
72
|
+
"why": "Small queries; results change only when a new assessment is released (about every two years), but data/ is reused only within a run."
|
|
73
|
+
},
|
|
74
|
+
"redistribution": {
|
|
75
|
+
"mode": "allowed",
|
|
76
|
+
"why": "NAEP results are published by NCES, a U.S. government agency; its materials are in the public domain (17 U.S.C. 105) unless marked otherwise, and NCES asks that the source be cited."
|
|
77
|
+
},
|
|
78
|
+
"notices": [],
|
|
79
|
+
"retention": null,
|
|
80
|
+
"citation": "U.S. Department of Education, Institute of Education Sciences, National Center for Education Statistics, National Assessment of Educational Progress (NAEP), {dataset}, NAEP Data Service (nationsreportcard.gov), retrieved {retrieved_long}.",
|
|
81
|
+
"audit_hooks": [
|
|
82
|
+
{
|
|
83
|
+
"id": "naep_uncertainty",
|
|
84
|
+
"kind": "require_text",
|
|
85
|
+
"any": [
|
|
86
|
+
"standard error",
|
|
87
|
+
"significant"
|
|
88
|
+
],
|
|
89
|
+
"why": "NAEP scores are sample estimates with standard errors; a report must say whether differences are statistically significant (NAEP's own tests), not compare point estimates."
|
|
90
|
+
}
|
|
91
|
+
],
|
|
92
|
+
"clarify": [
|
|
93
|
+
"Which subject, grade(s) and year(s)? Default: reading and mathematics, grades 4 and 8, the latest year and 2019 (pre-pandemic).",
|
|
94
|
+
"Average scale score or achievement level (percent at or above Proficient)? They can move differently; default: report both.",
|
|
95
|
+
"Public schools only (NP, the comparison base for states) or all schools (NT)? Default NP when states are involved."
|
|
96
|
+
],
|
|
97
|
+
"formats": [
|
|
98
|
+
"json"
|
|
99
|
+
]
|
|
100
|
+
}
|
|
@@ -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
|
+
}
|