--- title: "Everything held for the model year a VIN decodes to, in one answer." method: GET path: "/v1/vin/{vin}/overview" tags: ["VIN"] --- # Everything held for the model year a VIN decodes to, in one answer. `GET /v1/vin/{vin}/overview` ## Request - Base URL: `https://open.wenmarpro.com` - URL: `https://open.wenmarpro.com/v1/vin/{vin}/overview` - Auth: none declared The VIN only names the model year: `recalls` counts the campaigns that may apply to it, and no public data says a recall applies to one VIN. A VIN that decodes to no vehicle in the catalog gets `vehicle: null`, every block `null` and the warning `no_catalog_vehicle`, not an error. ## Path parameters - `vin` string, required ## Query parameters - `year` integer ## Response `200` The overview, with `decode`. - Overview: Everything held for one model year, in one answer. A block this server has no data for is `null`: `specs`, `fuel`, `fluids`, `tires` and `labor` are `null` in every answer today, and each is filled when its data arrives. A client must accept an object there. - `attribution` string[], required: The credit lines the data's licences ask for. - `bulletins` OverviewBulletins: The bulletins of a model year, in brief, in an overview. - `as_of` string, nullable: The day the bulletins were current. - `by_type` BulletinCount[], required: Every type with at least one, as `counts.by_type` of `/v1/vehicles/{id}/bulletins`. - `count` integer, required - `id` string, required: What to pass as `type`, `component`, `code` or `topic`. - `name` string, required - `count` integer, required: Every manufacturer communication that lists the model year. - `newest` Bulletin[], required: The three newest, as `/v1/vehicles/{id}/bulletins` lists them. - `component` string, nullable: NHTSA's components, in its words, separated by `; `. - `date` string, nullable: The manufacturer's own date. - `date_added` string, required: The day NHTSA published it. Lists are ordered by it. - `document` BulletinDocument: Where NHTSA's copy of a bulletin's document is expected to be. - `alternate_url` string, required: The address to try when `url` answers "not found": NHTSA files documents under one of two endings, and the data does not say which. - `confirmed` boolean, required: Always `false`. The addresses are built from a rule that held for a sample of documents; this API has not asked NHTSA for this one. - `url` string, required: The likelier address of NHTSA's copy (a PDF). - `document_id` string, nullable: The manufacturer's own number for the document, which a dealer looks it up by. - `mfr_campaign` string, nullable: The manufacturer's campaign id or software version. - `nhtsa_id` integer, required: NHTSA's id number for the communication. - `summary` string, nullable: NHTSA's summary of the communication. The document itself is the manufacturer's and is not here. - `type` string, required: `service_bulletin`, `service_campaign`, `warranty_extension`, `over_the_air`, `emissions` or `other`. - `type_name` string, required: The type in words. - `url` string, required: The bulletin's page on this site. - `url` string, required: The model year's bulletin page on this site. - `complaints` OverviewComplaints: The complaints of a model year, in brief, in an overview. - `as_of` string, nullable - `complaints` integer, required - `crashes` integer, required - `fires` integer, required - `injuries` integer, required - `median_km` integer, nullable - `median_miles` integer, nullable - `top` ComponentComplaints[], required: The three most reported components. - `complaints` integer, required - `crashes` integer, required: Complaints that report a crash. - `fires` integer, required: Complaints that report a fire. - `id` string, required: A component id, such as `steering` or `brake-pad`. - `injuries` integer, required: Complaints that report at least one person injured. - `median_km` integer, nullable: The median of the mileages owners gave, in kilometres. `null` when fewer than five gave one. - `median_miles` integer, nullable: The same in miles, as NHTSA records it. - `name` string, required - `parent` string, nullable: The system a part belongs to. `null` for a system. - `url` string, required: The section of the model year's page on this site. - `verified` boolean, required: Always `false`, as in `VehicleComplaints`. - `decode` OverviewDecode: What the VIN of an overview decoded to. - `engine` string, nullable: The engine in short form, such as `2.0L`, when the VIN names one. - `engine_settled` boolean, required: Whether the VIN settles on one engine of the catalog. - `entry_id` string, nullable: The most specific catalog entry the VIN reaches. - `make` string, nullable - `model` string, nullable - `trim` string, nullable - `valid` boolean, required: Whether the check digit, position 9, is right. - `vin` string, required - `year` integer, nullable - `fluids` object, nullable - `fuel` object, nullable - `labor` object, nullable - `links` OverviewLinks, required: Where to read more. - `maker` MakeLinks: The maker's own pages, found by a person. An address that was not found is `null`. They lead off this service and can move. - `checked` string, required: The day every link was last opened by a person. - `customer_line` string, nullable: The maker's telephone line for customers. - `maintenance_url` string, nullable - `manual_url` string, nullable - `parts_url` string, nullable - `recall_lookup_url` string, nullable: Where an owner checks a VIN for open recalls. - `service_info_url` string, nullable: The maker's service information site, where it sells access. - `page` string, nullable: The model year's page on this site. `null` when the VIN reaches no model year of the catalog. - `recalls` OverviewRecalls: The recalls of a model year, in brief. - `as_of` RecallAsOf, required: The day each country's recall data was current. `null` for a country this server holds no recalls for. - `ca` string, nullable - `us` string, nullable - `count` RecallCount, required: How many recall campaigns list a model year, for each country. `null` for a country this server holds no recalls for; `0` when it holds them and none lists the model year. - `ca` integer, nullable - `us` integer, nullable - `do_not_drive` boolean, required: Whether any campaign carries NHTSA's advisory not to drive. - `lookup` RecallLookup, required: Where to check one vehicle for open recalls. Neither government publishes recalls by VIN as data, so no answer here can say a recall applies to a VIN: these lookups can. - `maker` string, nullable: The maker's own lookup by VIN, where one is on file. - `nhtsa` string, required: NHTSA's lookup by VIN, for the United States. - `tc` string, required: Transport Canada's recall search, for Canada. - `may_apply` boolean, required: Always `true`. A campaign lists a year, make and model; only the manufacturer can say whether one vehicle is in it. - `newest` Recall[], required: The three newest campaigns. The whole list is at `/v1/vehicles/{id}/recalls`. - `built_from` string, nullable: In an answer about one model year: the first and last build date the campaign gives. Compare them with the date on the door sticker. - `built_to` string, nullable - `campaign` string, required: The publisher's campaign number. - `component` string, nullable: The component, as the source words it. - `country` string, required: `us` or `ca`. - `date` string, nullable: The day the campaign was reported. - `do_not_drive` boolean, nullable: NHTSA's advisory not to drive the vehicle until it is repaired. `null` for a Canadian campaign: Transport Canada publishes no such field. - `manufacturer` string, nullable - `match` string, nullable: In an answer about one model year: how the campaign's vehicle text reached that model. `exact`, `base` (the campaign names a series or trim of it) or `curated`. `null` in a list that is not about one model year. - `mfr_campaign` string, nullable: The manufacturer's own campaign number, which a dealer looks a recall up by. - `models` string[], required: In an answer about one model year: the model names the campaign lists that reached it. - `notification` string, nullable: Transport Canada's notification type, such as `Safety Mfr`. - `park_outside` boolean, nullable: NHTSA's advisory to park outside, away from buildings. - `source` string, required: Who published it: `nhtsa` or `tc` (Transport Canada). - `summary` string, nullable: What is wrong, in the source's words. - `units` integer, nullable: Units potentially affected. - `url` string, required: The campaign's page on this site. - `park_outside` boolean, required: Whether any campaign carries NHTSA's advisory to park outside. - `url` string, required: The model year's recall page on this site. - `safety` VehicleSafety: NHTSA's crash test ratings for one model year. - `as_of` string, required: The day NHTSA's file was current. - `attribution` string[], required: The credit lines the data's licence asks for. NHTSA's asks for none. - `ratings` SafetyRating[], required: One entry for each vehicle of the model year NHTSA rated or lists, by NHTSA's model name, body style and drive. Empty when it lists none. - `body_style` string, nullable - `curb_weight_kg` integer, nullable: The weight of the vehicle NHTSA tested. NHTSA gives pounds; the kilograms are worked out from them and rounded. - `curb_weight_lb` integer, nullable - `description` string, required: The vehicle NHTSA rated, in NHTSA's words, on one line. - `drive` string, nullable - `features` SafetyFeatures, required: The safety features NHTSA lists with a rating. A feature is `standard`, `optional`, `both` (standard on some versions, optional on others) or `no`. An evaluation is `meets`, `does_not_meet`, `standard_only`, `upgrade_only` or `pending`. `null` where NHTSA's file does not say. For the four driver-assistance features (forward collision warning, lane departure warning, crash imminent braking, dynamic brake support) NHTSA's file means two things by its years. Through model year 2022, `standard`, `optional` and `both` say the feature is fitted and met NHTSA's performance criteria, `no` says it is not fitted or did not meet them, and there is no evaluation. From model year 2023 the value says only whether the feature is fitted, and the evaluation says what NHTSA's test found. - `backup_camera` string, nullable - `blind_spot_detection` string, nullable - `crash_imminent_braking` string, nullable: Automatic emergency braking: the vehicle brakes by itself. - `crash_imminent_braking_evaluation` string, nullable - `dynamic_brake_support` string, nullable: The vehicle adds to the driver's braking. - `dynamic_brake_support_evaluation` string, nullable - `esc` string, nullable: Electronic stability control. - `forward_collision_warning` string, nullable - `forward_collision_warning_evaluation` string, nullable - `head_side_airbag` string, nullable: Side air bags for the head, and for the torso. - `lane_departure_warning` string, nullable - `lane_departure_warning_evaluation` string, nullable - `torso_side_airbag` string, nullable - `match` string, required: How NHTSA's model name reached this model: `exact`, `base` (NHTSA names a body or a version of it) or `curated`. - `model` string, required: The model, body style, vehicle type and drive as NHTSA words them. - `notes` string[], required: NHTSA's safety concerns and footnotes: what happened in a test, and which vehicles the rating does not cover. - `release` integer, required: 1 for the first release of a model year; 2 or 3 for a later one that NHTSA rated again. - `rollover_risk_percent` number, double, nullable: The chance of a rollover in a single-vehicle crash, in percent. - `rollover_tip` boolean, nullable: Whether the vehicle tipped up in NHTSA's dynamic test. - `stars` SafetyStars, required: The stars of one rating, each from 1 to 5. `null` where NHTSA gave none: a test it did not run, or a rating older than the overall rating, which began with model year 2011. - `frontal` integer, nullable: The frontal crash test, overall. - `frontal_driver` integer, nullable - `frontal_passenger` integer, nullable - `overall` integer, nullable - `rollover` integer, nullable - `side` integer, nullable: The side crash tests, overall. - `side_barrier` integer, nullable - `side_driver` integer, nullable: The side barrier test: the driver, and the rear passenger. - `side_front_seat` integer, nullable: The front seat and the rear seat, over the barrier and pole tests. - `side_passenger` integer, nullable - `side_pole` integer, nullable - `side_rear_seat` integer, nullable - `vehicle_type` string, nullable - `source` string, required: Who rates the vehicles. - `source_url` string, required: NHTSA's own pages of ratings. - `vehicle` RecallVehicle, required: The model year an answer is about. - `id` string, required: The id of the year, make and model. - `make` string, required - `model` string, required - `year` integer, required - `specs` object, nullable - `tires` TireFitment[], nullable: The original-equipment tire fitments a person recorded, as the `fitments` of `/v1/vehicles/{id}/tires`: every one, never narrowed. `null` on a server that holds none. - `bolt_pattern` string, nullable - `checked` string, required - `lug_torque_lbft` integer, nullable - `lug_torque_nm` integer, nullable - `lug_torque_written_in` string, nullable: `nm` or `lbft`. - `market` string, nullable - `pressure_kpa` FrontRear: A figure for the front and for the rear. - `front` integer, nullable - `rear` integer, nullable - `pressure_psi` FrontRear: A figure for the front and for the rear. - `front` integer, nullable - `rear` integer, nullable - `pressure_written_in` string, nullable: The unit the document printed: `kpa`, `bar` or `psi`. The other figures were worked out from it. - `size` string, required: The size as printed. The front size when `size_rear` is given. - `size_rear` string, nullable: The rear size, only when it differs from the front. - `source` string, required - `trims` string[], required: The trims the document ties the size to, as it names them. Empty when it names none. - `vehicle` RecallVehicle: The model year an answer is about. - `id` string, required: The id of the year, make and model. - `make` string, required - `model` string, required - `year` integer, required - `warnings` Warning[], required - `code` string, required: `invalid_check_digit`, `model_year_unknown`, `no_patterns` or `model_unresolved`. More may be added. - `message` string, required - `suggestions` string[]: VINs the caller may have meant. ## Other responses - `400`: `invalid_vin`, or `validation_failed` for `year`. - `404`: `not_found`: no manufacturer is registered for the first three characters. --- [API](https://skmtc.dev/wenmarpro/apis/wenmar-open.md) · [All operations](https://skmtc.dev/wenmarpro/apis/wenmar-open/llms.txt) · [OpenAPI document](https://skmtc.dev/wenmarpro/apis/wenmar-open/revisions/1027b548b6f0?raw)