{"openapi":"3.0.0","info":{"title":"Auto.dev Vehicle Data API","version":"2.0.0","description":"Access comprehensive vehicle data including listings, specifications, and market intelligence from U.S. physical & online dealers.\n\n## Authentication\nSend your API key as `Authorization: Bearer YOUR_API_KEY`, or as the `apiKey` query parameter. Create keys at https://www.auto.dev/dashboard/api-keys. A call without a valid key gets a 401.\n\n## Plans and rate limits\n- Free: 5 requests per second, 1,000 API calls per month\n- Growth: 10 requests per second\n- Scale: 50 requests per second\n\nAn operation that needs a higher plan carries `x-required-plan` and answers 402 to a key below it. Over the rate limit, a call gets a 429 with a `Retry-After` header.\n\n## Errors\nEvery error is JSON with the HTTP `status`. The full catalog is at https://docs.auto.dev/v2/reference/errors. A 207 is a partial answer, not an error.","termsOfService":"https://www.auto.dev/terms","contact":{"name":"Auto.dev Support","url":"https://www.auto.dev","email":"support@auto.dev"},"license":{"name":"Auto.dev API Terms of Service","url":"https://www.auto.dev/terms"}},"servers":[{"url":"https://api.auto.dev","description":"Production server"}],"security":[{"bearerAuth":[]},{"queryString":[]}],"components":{"parameters":{"Ambiguity":{"name":"ambiguity","in":"query","required":false,"schema":{"type":"boolean","default":false},"description":"Whether to allow a best-guess answer for a VIN that matches several styles. By default (false) the answer does not guess: style is null, trim is null unless our sources settle it (on /specs, a 207 whose specs holds only the fields every style shares), and trims and styles list the possibilities. true allows a single best-guess pick. Also accepted as the X-Ambiguity header."}},"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Use your API key in the Authorization header: `Authorization: Bearer YOUR_API_KEY`"},"queryString":{"type":"apiKey","in":"query","name":"apiKey","description":"Use your API key as a query parameter: `?apiKey=YOUR_API_KEY`"}},"schemas":{"VehicleBasic":{"type":"object","properties":{"vin":{"type":"string","description":"Vehicle Identification Number"},"year":{"type":"number","description":"Model year"},"make":{"type":"string","description":"Vehicle manufacturer"},"model":{"type":"string","description":"Vehicle model name"},"manufacturer":{"type":"string","description":"Full manufacturer name"}},"required":["vin","year","make","model"]},"VehicleInfo":{"type":"object","properties":{"vin":{"type":"string","description":"Vehicle Identification Number"},"squishVin":{"type":"string","description":"10-character squish VIN (positions 1-8 + 10-11 of the full VIN). Drops the check digit at position 9 and the per-vehicle production sequence at positions 12-17."},"year":{"type":"number","description":"Model year"},"make":{"type":"string","description":"Vehicle manufacturer"},"model":{"type":"string","description":"Vehicle model name"},"trim":{"type":"string","description":"Trim level designation"},"drivetrain":{"type":"string","description":"Drivetrain configuration (4WD, AWD, FWD, RWD)"},"engine":{"type":"string","description":"Engine description and fuel type"},"fuel":{"type":"string","description":"Fuel type (Gasoline, Plug-In Hybrid, etc.)"},"transmission":{"type":"string","description":"Transmission type"},"confidence":{"type":"number","description":"Data accuracy confidence score (0.0 to 1.0)"},"doors":{"type":"number","description":"Number of doors"},"seats":{"type":"number","description":"Seating capacity"},"exteriorColor":{"type":"string","description":"Exterior color name"},"interiorColor":{"type":"string","description":"Interior color name"}}},"RetailListing":{"type":"object","properties":{"vdp":{"type":"string","description":"Vehicle detail page URL"},"price":{"type":"number","description":"Current asking price in USD"},"miles":{"type":"number","description":"Vehicle mileage/odometer reading"},"used":{"type":"boolean","description":"Whether this is a used vehicle listing"},"cpo":{"type":"boolean","description":"Certified Pre-Owned status"},"carfaxUrl":{"type":"string","description":"Vehicle history report link, when the listing has one"},"dealer":{"type":"string","description":"Dealership name"},"dealerId":{"type":"string","description":"Stable dealer ID for the rooftop. Pass it to the `dealerId` query parameter to retrieve all listings for that dealer."},"city":{"type":"string","description":"Dealership city"},"state":{"type":"string","description":"Dealership state abbreviation"},"zip":{"type":"string","description":"Dealership ZIP code"},"primaryImage":{"type":"string","description":"Primary vehicle photo URL"},"photoCount":{"type":"number","description":"Total number of photos available"}}},"WholesaleListing":{"type":"object","properties":{"auction":{"type":"string","description":"Auction identifier"},"miles":{"type":"number","description":"Vehicle mileage"},"buyNowPrice":{"type":"number","description":"Wholesale buy now price"},"state":{"type":"string","description":"State where vehicle is located"}}},"VehicleListing":{"type":"object","properties":{"@id":{"type":"string","description":"Unique identifier URL for the listing"},"vin":{"type":"string","description":"Vehicle Identification Number"},"location":{"type":"array","items":{"type":"number"},"description":"Geographic coordinates [longitude, latitude]"},"vehicle":{"$ref":"#/components/schemas/VehicleInfo"},"retailListing":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/RetailListing"}]},"wholesaleListing":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/WholesaleListing"}]},"history":{"type":"object","nullable":true,"description":"Vehicle history report links, when the listing has them. All fields nullable; absent when the listing has no associated history report.","properties":{"accidentCount":{"type":"string","description":"Number of accidents on the recorded vehicle history, as a string (\"0\", \"1\", \"2+\")."},"accidents":{"type":"boolean","description":"True when any accident is recorded on the vehicle history."},"ownerCount":{"type":"string","description":"Number of previous owners, as a string (\"1\", \"2\", etc.)."},"oneOwner":{"type":"boolean","description":"True when the vehicle has had only one previous owner."},"usageType":{"type":"string","description":"Recorded use classification (e.g. \"Personal\", \"Commercial\", \"Lease\", \"Rental\")."},"personalUse":{"type":"boolean","description":"True when the vehicle was used personally rather than commercially / fleet."}}}}},"ListingsResponse":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/VehicleListing"}}}},"SingleListingResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/VehicleListing"}}},"AmbiguousStyle":{"type":"object","description":"One of the styles an ambiguous VIN matches","properties":{"name":{"type":"string","description":"Style name"},"trim":{"type":"string","description":"The style's trim"},"confidence":{"type":"number","description":"Estimated share of this style among current listings of the model and year (0-1); absent when there are none"}},"required":["name"]},"VinDecodeResponse":{"type":"object","properties":{"vin":{"type":"string","description":"Vehicle Identification Number"},"vinValid":{"type":"boolean","description":"Whether the VIN is valid and properly formatted"},"wmi":{"type":"string","description":"World Manufacturer Identifier (first 3 characters)"},"origin":{"type":"string","description":"Country of manufacture"},"squishVin":{"type":"string","description":"10-character squish VIN (positions 1-8 + 10-11 of the full VIN). Drops the check digit at position 9 and the per-vehicle production sequence at positions 12-17."},"checkDigit":{"type":"string","description":"The 9th character used for VIN validation"},"checksum":{"type":"boolean","description":"Whether the VIN checksum is valid"},"type":{"type":"string","description":"Vehicle type classification"},"make":{"type":"string","description":"Vehicle manufacturer"},"model":{"type":"string","description":"Vehicle model name"},"trim":{"type":"string","nullable":true,"description":"Trim level designation; null when the VIN matches several styles that differ in trim (see trims)"},"style":{"type":"string","nullable":true,"description":"Body style and configuration; null when the VIN matches more than one style (see styles)"},"body":{"type":"string","description":"Vehicle body class"},"engine":{"type":"string","description":"Engine description"},"drive":{"type":"string","description":"Drivetrain configuration"},"transmission":{"type":"string","description":"Transmission type"},"doors":{"type":"number","description":"Number of passenger doors (a hatch or liftgate is not counted), as vehicle.doors in the Listings API. Absent when unknown."},"fuel":{"type":"string","enum":["Gasoline","Diesel","Electric","Hybrid","Plug-in Hybrid","Flex-fuel","Hydrogen","Natural Gas"],"description":"Fuel type, as vehicle.fuel in the Listings API. Absent when unknown."},"vehicle":{"$ref":"#/components/schemas/VehicleBasic"},"ambiguous":{"type":"boolean","description":"Whether the VIN corresponds to multiple possible vehicle trims or styles. When true, style is null, trim is null unless our sources settle it, and trims and styles list the possibilities"},"trims":{"type":"array","items":{"type":"string"},"description":"Present only when the VIN matches more than one style: every trim among them, most likely first"},"styles":{"type":"array","items":{"$ref":"#/components/schemas/AmbiguousStyle"},"description":"Present only when the VIN matches more than one style: each one, most likely first"}},"required":["vin","vinValid","wmi","origin","squishVin","checkDigit","checksum","type","make","model","vehicle"]},"VinDecodePartialResponse":{"type":"object","description":"The 207 Multi-Status partial answer: a VIN we hold no full record for, which decodes only in part, when a fact about the vehicle says why. Year, make and model would be a 200. Not an error, not billed, counts toward no quota. The decode fields of a 200 (make, model, wmi, squishVin, ...) are absent: branch on the status before reading them.","properties":{"vin":{"type":"string","description":"Vehicle Identification Number, upper-cased"},"vinValid":{"type":"boolean","enum":[true],"description":"Always true on a 207: the VIN is well formed and its check digit computes"},"vehicle":{"type":"object","description":"What a decoder said about this VIN, never a guessed make or model","properties":{"vin":{"type":"string","description":"Vehicle Identification Number"},"year":{"type":"number","description":"Model year, when the VIN or a decoder gives one; see `yearAmbiguous`"},"make":{"type":"string","description":"Make, only when a decoder named one; absent when only the manufacturer is known"},"model":{"type":"string","description":"Model, only when a decoder named one"},"manufacturer":{"type":"string","description":"The company that built the vehicle, as the decoder or the WMI registry names it"},"type":{"type":"string","description":"Vehicle class as the decoder names it (e.g., \"Utility Trailers\", \"Motorcycle\")"}},"required":["vin"]},"yearAmbiguous":{"type":"boolean","description":"Whether more than one model year fits the VIN. For a bus, trailer or incomplete vehicle the 7th character does not bind the 30-year cycle, so when the decoder accepts both readings `years` lists them and `year` is the newest"},"years":{"type":"array","description":"Every model year that fits the VIN, present only when `yearAmbiguous` is true","items":{"type":"number"}},"reason":{"type":"string","enum":["class_not_covered","market_not_covered"],"description":"Why the answer stops here, as a fact about the vehicle. `class_not_covered`: a motorcycle, trailer, bus, low-speed, incomplete or off-road vehicle, or a truck of GVWR class 6 to 8. `market_not_covered`: a VIN built outside North America"},"retryable":{"type":"boolean","enum":[false],"description":"Always false on /vin: asking again will not change the answer"}},"required":["vin","vinValid","vehicle","reason","retryable"]},"VehiclePhotosResponse":{"type":"object","properties":{"data":{"type":"object","properties":{"retail":{"type":"array","items":{"type":"string","format":"url"},"description":"Array of retail photo URLs from dealer listings"}},"required":["retail"]}},"required":["data"]},"VehicleSpecsResponse":{"type":"object","properties":{"vehicle":{"$ref":"#/components/schemas/VehicleBasic"},"ambiguous":{"type":"boolean","description":"Whether the VIN matches more than one style. When true, trims and styles list the possibilities, and the answer is a 207 whose specs holds only the fields every one of them shares (reason `ambiguous_style`); with `ambiguity=true`, a 200 with the single most likely style"},"trims":{"type":"array","items":{"type":"string"},"description":"Present only when the VIN matches more than one style: every trim among them, most likely first"},"styles":{"type":"array","items":{"$ref":"#/components/schemas/AmbiguousStyle"},"description":"Present only when the VIN matches more than one style: each one, most likely first"},"specs":{"type":"object","nullable":true,"description":"The vehicle's specifications. When the VIN matches more than one style, a 207 holds only the fields every one of them shares (see the 207)","properties":{"name":{"type":"string","description":"Complete trim and specification name"},"totalSeating":{"type":"number","description":"Total seating capacity"},"price":{"type":"object","properties":{"baseMsrp":{"type":"number","description":"Manufacturer Suggested Retail Price"},"baseInvoice":{"type":"number","description":"Dealer invoice price"}}},"color":{"type":"object","properties":{"exterior":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Color name"},"rgb":{"type":"string","description":"RGB color values"}}}},"interior":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Interior color name"},"rgb":{"type":"string","description":"RGB color values"}}}}}},"features":{"type":"object","description":"Detailed vehicle features organized by category","additionalProperties":true},"orderedFeatures":{"type":"array","items":{"type":"object","properties":{"category":{"type":"string","description":"Feature category name"},"categoryGroup":{"type":"string","description":"Parent category group"},"features":{"type":"object","description":"Category-specific features","additionalProperties":true}}}},"typeCategories":{"type":"object","description":"Vehicle type classifications","additionalProperties":{"type":"object","properties":{"id":{"type":"number"},"name":{"type":"string"}}}},"styleAttributes":{"type":"object","properties":{"electric":{"type":"boolean","description":"Whether vehicle is electric"},"pluginElectric":{"type":"boolean","description":"Whether vehicle is plug-in electric"},"truck":{"type":"boolean","description":"Whether vehicle is classified as a truck"}}}}}},"required":["vehicle","specs"]},"VehicleSpecsPartialResponse":{"type":"object","description":"The 207 Multi-Status partial answer: a vehicle we can name whose sources hold only some of the documented specs fields, or a VIN that matches more than one style (`ambiguous`), whose specs holds only the fields every one of those styles shares. A full answer is a 200. Not an error, not billed, counts toward no quota. The fields named in `missing` are null: branch on the status, or check `missing`, before reading `specs`.","properties":{"vehicle":{"$ref":"#/components/schemas/VehicleBasic"},"ambiguous":{"type":"boolean","description":"Present and true when the VIN matches more than one style: `specs` holds the fields every one of them shares, each other field is null and in `missing`, and trims and styles list the possibilities. No style is picked"},"trims":{"type":"array","items":{"type":"string"},"description":"Present only when the VIN matches more than one style: every trim among them, most likely first"},"styles":{"type":"array","items":{"$ref":"#/components/schemas/AmbiguousStyle"},"description":"Present only when the VIN matches more than one style: each one, most likely first"},"specs":{"type":"object","description":"Every documented top-level field is present: `name`, `price`, `totalSeating`, `color`, `typeCategories`, `styleAttributes`, `orderedFeatures` and `features`, each as on a 200 when the record on file has it, null otherwise (`name` also from the decode: below). For a VIN that matches more than one style, a field is as on a 200 when every style holds the same value in it, `name` included, and null otherwise","required":["name","price","totalSeating","color","typeCategories","styleAttributes","orderedFeatures","features"],"properties":{"name":{"type":"string","nullable":true,"description":"As on a 200 when a record on file names the vehicle. When none does, the year, make and model in `vehicle`, for a North American VIN or for one built elsewhere whose model our own decode gives (not one read by US VIN patterns); null otherwise, and for a class the catalogs do not cover. For a VIN that matches more than one style, the name they all share, else null"},"price":{"type":"object","nullable":true},"totalSeating":{"type":"number","nullable":true},"color":{"type":"object","nullable":true},"typeCategories":{"type":"object","nullable":true},"styleAttributes":{"type":"object","nullable":true},"orderedFeatures":{"type":"array","nullable":true,"items":{}},"features":{"type":"object","nullable":true}}},"missing":{"type":"array","description":"The documented `specs` fields that are null in this answer","items":{"type":"object","properties":{"field":{"type":"string","enum":["name","price","totalSeating","color","typeCategories","styleAttributes","orderedFeatures","features"],"description":"A documented `specs` field that is null in this answer"},"reason":{"type":"string","enum":["no_vin_record"],"description":"`no_vin_record`: no record on file has this field for this VIN (for a VIN that matches more than one style, its styles do not share one value for it)"}},"required":["field","reason"]}},"reason":{"type":"string","enum":["class_not_covered","market_not_covered","no_vin_record","ambiguous_style"],"description":"Why the specifications are partial. `class_not_covered`: a motorcycle, trailer, bus or other class the catalogs do not cover (an incomplete vehicle, a chassis cab, is covered). `market_not_covered`: a VIN built outside North America that is not decoded. `no_vin_record`: a covered vehicle with no full record on file (a 2026 Ford Mustang today, for one). `ambiguous_style`: the VIN matches more than one style (`ambiguous`), and the fields they do not share are null"},"retryable":{"type":"boolean","enum":[false],"description":"Always false on /specs: asking again will not change the answer"}},"required":["vehicle","specs","missing","reason","retryable"]},"VehicleRecallsResponse":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/RecallRecord"},"description":"Array of recall records for the specified vehicle"},"totalRecalls":{"type":"integer","description":"Number of records in `data`"},"internationalRecalls":{"type":"array","items":{"$ref":"#/components/schemas/InternationalRecallRecord"},"description":"Recalls issued outside the US for the vehicle's make and model; an empty array when the request has `international=false`. Each recall appears once per region, and the UK, Germany and Canada list only the recalls that can cover the vehicle's model year. Matched by make and model, not by VIN, so a listed recall may not apply to this vehicle."},"internationalRecallCount":{"type":"integer","description":"Number of records in `internationalRecalls` (a recall issued in two regions counts once in each); 0 when the request has `international=false`"}},"required":["data","totalRecalls","internationalRecalls","internationalRecallCount"]},"InternationalRecallRecord":{"type":"object","description":"A recall issued outside the US, in the fields every region shares","properties":{"region":{"type":"string","enum":["UK","NL","FR","EU","DE","CA"],"description":"Where the recall was issued: the UK, the Netherlands, France, the EU (product-safety alerts), Germany or Canada"},"recall_number":{"type":"string","description":"The recall's number in its region"},"launch_date":{"type":"string","nullable":true,"description":"When the recall was issued or published (YYYY-MM-DD)"},"make":{"type":"string","description":"The make as the region files it, e.g. under its importer"},"model":{"type":"string","description":"The model as the region names it"},"model_info":{"type":"string","description":"Further model detail, where the region gives it; otherwise the model again"},"concern":{"type":"string","description":"Short statement of the problem, or the system affected"},"defect":{"type":"string","description":"Description of the defect"},"remedy":{"type":"string","description":"What the manufacturer will do, or how owners are notified"},"vehicle_numbers":{"type":"string","description":"Number of vehicles affected in the region, where it is given; otherwise empty"}},"required":["region","recall_number","launch_date","make","model","model_info","concern","defect","remedy","vehicle_numbers"],"example":{"region":"UK","recall_number":"R/2021/315","launch_date":"2021-11-15","make":"TOYOTA (GB) PLC","model":"RAV4","model_info":"RAV4","concern":"THE EMERGENCY CALLING SYSTEM (eCall) MAY NOT FUNCTION WHEN REQUIRED","defect":"The emergency calling system (eCall) may not function when required.","remedy":"Inspect the emergency calling system and update DCM software. If the DCM is found to be damaged replace it with updated software.","vehicle_numbers":"26575"}},"RecallRecord":{"type":"object","properties":{"manufacturer":{"type":"string","description":"Vehicle manufacturer name (e.g., \"Porsche Cars North America, Inc.\")"},"nhtsaCampaignNumber":{"type":"string","description":"Official NHTSA recall campaign number"},"parkIt":{"type":"boolean","description":"Whether vehicle should not be driven until repaired"},"parkOutSide":{"type":"boolean","description":"Whether vehicle should be parked outside due to fire risk"},"overTheAirUpdate":{"type":"boolean","description":"Whether recall can be resolved via software update"},"reportReceivedDate":{"type":"string","description":"Date NHTSA received the manufacturer's defect report for the campaign (YYYY-MM-DD)."},"component":{"type":"string","description":"Vehicle component affected by the recall"},"summary":{"type":"string","description":"Brief description of the recall issue"},"consequence":{"type":"string","description":"Potential consequences if issue is not addressed"},"remedy":{"type":"string","description":"Detailed remediation steps and dealer instructions"},"notes":{"type":"string","description":"Additional notes and contact information"},"modelYear":{"type":"string","description":"Model year of affected vehicle"},"make":{"type":"string","description":"Vehicle make (manufacturer)"},"model":{"type":"string","description":"Vehicle model name"}},"required":["manufacturer","nhtsaCampaignNumber","parkIt","parkOutSide","overTheAirUpdate","reportReceivedDate","component","summary","consequence","remedy","notes","modelYear","make","model"]},"TotalCostOwnershipResponse":{"type":"object","properties":{"vehicle":{"$ref":"#/components/schemas/VehicleBasic"},"zip":{"type":"string","description":"ZIP code used for location-based calculations"},"tco":{"$ref":"#/components/schemas/TcoAnalysis"}},"required":["vehicle","zip","tco"]},"TcoAnalysis":{"type":"object","properties":{"total":{"$ref":"#/components/schemas/TcoTotalCosts"},"years":{"type":"object","properties":{"1":{"$ref":"#/components/schemas/TcoYearlyCosts"},"2":{"$ref":"#/components/schemas/TcoYearlyCosts"},"3":{"$ref":"#/components/schemas/TcoYearlyCosts"},"4":{"$ref":"#/components/schemas/TcoYearlyCosts"},"5":{"$ref":"#/components/schemas/TcoYearlyCosts"}},"required":["1","2","3","4","5"]}},"required":["total","years"]},"TcoTotalCosts":{"type":"object","properties":{"federalTaxCredit":{"type":"number","description":"Federal tax credits (EV incentives, etc.)"},"insurance":{"type":"number","description":"Total insurance costs over 5 years"},"maintenance":{"type":"number","description":"Total scheduled maintenance costs"},"repairs":{"type":"number","description":"Total expected repair costs"},"taxesAndFees":{"type":"number","description":"Total taxes and registration fees"},"financeInterest":{"type":"number","description":"Total loan interest payments"},"depreciation":{"type":"number","description":"Total vehicle depreciation"},"fuel":{"type":"number","description":"Total fuel costs"},"tcoPrice":{"type":"number","description":"Total cost of ownership"},"averageCostPerMile":{"type":"number","format":"float","description":"Average cost per mile over 5 years"}},"required":["federalTaxCredit","insurance","maintenance","repairs","taxesAndFees","financeInterest","depreciation","fuel","tcoPrice","averageCostPerMile"]},"TcoYearlyCosts":{"type":"object","properties":{"insurance":{"type":"number","description":"Annual insurance cost"},"maintenance":{"type":"number","description":"Annual maintenance cost"},"repairs":{"type":"number","description":"Annual repair cost"},"taxesAndFees":{"type":"number","description":"Annual taxes and fees"},"financeInterest":{"type":"number","description":"Annual finance interest"},"depreciation":{"type":"number","description":"Annual depreciation"},"fuel":{"type":"number","description":"Annual fuel cost"},"tcoPrice":{"type":"number","description":"Total annual cost"},"averageCostPerMile":{"type":"number","format":"float","description":"Average cost per mile for the year"}},"required":["insurance","maintenance","repairs","taxesAndFees","financeInterest","depreciation","fuel","tcoPrice","averageCostPerMile"]},"VehiclePaymentsResponse":{"type":"object","properties":{"vehicle":{"$ref":"#/components/schemas/VehicleBasic"},"criteria":{"type":"object","properties":{"price":{"type":"string","description":"Vehicle sales price"},"zip":{"type":"string","description":"ZIP code for calculations"},"docFee":{"type":"number","description":"Dealer documentation fee"},"tradeIn":{"type":"string","description":"Trade-in value"}},"required":["price","zip"]},"paymentsData":{"$ref":"#/components/schemas/PaymentsData"},"apr":{"type":"object","properties":{"36":{"type":"number","description":"36-month loan APR percentage"},"48":{"type":"number","description":"48-month loan APR percentage"},"60":{"type":"number","description":"60-month loan APR percentage"},"72":{"type":"number","description":"72-month loan APR percentage"},"84":{"type":"number","description":"84-month loan APR percentage"}}},"totalTaxesAndFees":{"type":"number","description":"Total taxes and fees amount"},"taxes":{"$ref":"#/components/schemas/TaxesBreakdown"},"fees":{"$ref":"#/components/schemas/FeesBreakdown"}},"required":["vehicle","criteria","paymentsData"]},"PaymentsData":{"type":"object","properties":{"loanAmount":{"type":"number","format":"float","description":"Total loan amount"},"loanMonthlyPayment":{"type":"number","format":"float","description":"Monthly loan payment before taxes"},"loanMonthlyPaymentWithTaxes":{"type":"number","format":"float","description":"Monthly loan payment including taxes"},"totalTaxesAndFees":{"type":"number","format":"float","description":"Total taxes and fees"},"taxes":{"$ref":"#/components/schemas/TaxesBreakdown"},"fees":{"$ref":"#/components/schemas/FeesBreakdown"},"calculationCriteria":{"type":"object","properties":{"numberOfMonths":{"type":"number","description":"Loan term in months"},"financeRate":{"type":"number","format":"float","description":"Finance rate percentage"},"downPayment":{"type":"number","description":"Down payment amount"},"tradeIn":{"type":"number","description":"Trade-in value"},"tradeInOwedAmount":{"type":"number","description":"Amount owed on trade-in"},"salesPrice":{"type":"number","description":"Vehicle sales price"},"conditionalIncentiveAmount":{"type":"number","description":"Conditional incentive amount"},"primaryIncentiveAmount":{"type":"number","description":"Primary incentive amount"},"docFee":{"type":"number","description":"Documentation fee"},"zipCode":{"type":"string","description":"ZIP code for calculations"},"marketValue":{"type":"number","description":"Market value"},"withConcreteTaxesAndFees":{"type":"boolean","description":"Whether concrete taxes and fees are included"},"applyLimits":{"type":"boolean","description":"Whether limits are applied"},"msrp":{"type":"number","description":"Manufacturer's Suggested Retail Price"},"lowerLimit":{"type":"boolean","description":"Whether lower limit is applied"}}}}},"TaxesBreakdown":{"type":"object","properties":{"combinedSalesTax":{"type":"number","description":"Combined sales tax amount"},"stateSalesTax":{"type":"number","description":"State sales tax amount"},"gasGuzzlerTax":{"type":"number","description":"Gas guzzler tax amount"}}},"FeesBreakdown":{"type":"object","properties":{"titleFee":{"type":"number","format":"float","description":"Title fee"},"registrationFee":{"type":"number","format":"float","description":"Registration fee"},"dmvFee":{"type":"number","format":"float","description":"DMV fee"},"combinedFees":{"type":"number","format":"float","description":"Combined fees amount"},"docFee":{"type":"number","description":"Documentation fee"},"dmvFees":{"type":"object","description":"Detailed DMV fees breakdown","additionalProperties":{"type":"number"}}}},"InterestRatesResponse":{"type":"object","properties":{"vehicle":{"type":"object","properties":{"vin":{"type":"string","description":"Vehicle Identification Number"},"year":{"type":"number","description":"Model year"},"make":{"type":"string","description":"Vehicle manufacturer"},"model":{"type":"string","description":"Vehicle model name"}},"required":["vin","year","make","model"]},"zip":{"type":"string","description":"ZIP code used for rate calculations"},"creditScore":{"type":"string","description":"Credit score used for calculations"},"vehicleAge":{"type":"number","description":"Age of the vehicle in years"},"vehicleMileage":{"type":"string","description":"Current vehicle mileage"},"apr":{"type":"object","properties":{"36":{"type":"number","format":"float","description":"36-month loan APR percentage"},"48":{"type":"number","format":"float","description":"48-month loan APR percentage"},"60":{"type":"number","format":"float","description":"60-month loan APR percentage"},"72":{"type":"number","format":"float","description":"72-month loan APR percentage"},"84":{"type":"number","format":"float","description":"84-month loan APR percentage"}},"required":["36","48","60","72","84"]}},"required":["vehicle","zip","creditScore","apr"]},"OemBuildDataResponse":{"type":"object","properties":{"build":{"type":"object","properties":{"vin":{"type":"string","description":"Vehicle Identification Number"},"year":{"type":"number","description":"Model year; `0` when nothing on file for this VIN names one"},"make":{"type":"string","description":"Vehicle manufacturer"},"model":{"type":"string","description":"Vehicle model name"},"trim":{"type":"string","description":"Complete trim designation"},"series":{"type":"string","description":"Vehicle series or sub-model"},"style":{"type":"string","description":"Body style designation (e.g., \"4D Crossover\")"},"bodyType":{"type":"string","description":"Body type (e.g., \"Pickup\", \"SUV\")"},"drivetrain":{"type":"string","description":"Drivetrain configuration (e.g., \"RWD\", \"AWD\")"},"engine":{"type":"string","description":"Complete engine specification with displacement, configuration, and horsepower"},"transmission":{"type":"string","description":"Transmission type and configuration"},"confidence":{"type":"number","format":"float","minimum":0,"maximum":1,"description":"Data accuracy confidence score (0-1)"},"interiorColor":{"oneOf":[{"$ref":"#/components/schemas/OemBuildColor"},{"type":"array","items":{"$ref":"#/components/schemas/OemBuildColorLine"}}],"description":"The interior color: its name mapped to a hex swatch, `''` when no swatch is known. With `?array`, a list of `{ name, colorCode, code }`."},"exteriorColor":{"oneOf":[{"$ref":"#/components/schemas/OemBuildColor"},{"type":"array","items":{"$ref":"#/components/schemas/OemBuildColorLine"}}],"description":"The exterior color: its name mapped to a hex swatch, `''` when no swatch is known. With `?array`, a list of `{ name, colorCode, code }`."},"interiorColorCode":{"type":"string","description":"The manufacturer's code for the interior color, where the record of this VIN carries one"},"exteriorColorCode":{"type":"string","description":"The manufacturer's code for the exterior color (paint code), where the record of this VIN carries one"},"packageCode":{"type":"string","description":"The equipment group or package code (e.g. `302A`), where the record of this VIN carries one"},"options":{"oneOf":[{"type":"object","additionalProperties":{"type":"string"}},{"type":"array","items":{"$ref":"#/components/schemas/OemBuildOptionLine"}}],"description":"The installed options, one line per key, each mapped to its description. A line is keyed by the manufacturer's option code where one is known, and by its name where none is (e.g. `\"DETROIT 2 TRACKING\": \"DETROIT 2 TRACKING\"`), so a key is not always a code. With `?array`, a list of `{ id, name }`, with no `id` on a line whose code is not known. `{}` or absent when the record lists no option; `missing` says when that is a gap."},"standardEquipment":{"type":"object","nullable":true,"description":"Only with `includeStandard=true` (or `1`): what the vehicle ships with as standard, each line with its `code` where one is known. null when nothing on file can say. Never adds a cost.","properties":{"basis":{"type":"string","enum":["window_sticker","vin_record","exact_trim","style"],"description":"How far to believe the list for this VIN. `window_sticker`: the standard lines of this VIN's own window sticker. `vin_record`: equipment recorded for this VIN; can include what an option added. `exact_trim`: standard at the trim the VIN decodes to exactly. `style`: standard at the one style the VIN decodes to, with nothing on this VIN confirming the trim."},"equipment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"What the line is. A code with no description on file is named by the code itself."},"category":{"type":"string","description":"Equipment category, where the record gives one"},"code":{"type":"string","description":"The manufacturer's code for the line, where one is known: for a Buick, Cadillac, Chevrolet or GMC, every RPO code on file for the vehicle that is not an ordered option, color or package code. GET /rpo/{code} says what one code means."}},"required":["name"]}}},"required":["basis","equipment"]},"baseMsrp":{"type":"number","minimum":0,"description":"The trim's base MSRP in USD, where known"},"optionsMsrp":{"type":"number","format":"float","minimum":0,"description":"Total MSRP value of factory options in USD"},"sticker":{"type":"object","description":"Toyota only, where this VIN's window sticker was read: its totals. Each number in USD, absent when the sticker does not print it.","properties":{"source":{"type":"string","enum":["toyota-monroney"],"description":"Always `toyota-monroney`: the VIN's window sticker"},"baseMsrp":{"type":"number","description":"Base MSRP as printed"},"totalMsrp":{"type":"number","description":"Total MSRP as printed"},"deliveryFee":{"type":"number","description":"Destination and delivery charge as printed"}},"required":["source"]},"headUpDisplay":{"type":"boolean","description":"Whether the vehicle has a head-up display, detected from the factory equipment list. Returned where the manufacturer provides a full equipment list; false means the feature is not in the returned list."},"rainSensingWipers":{"type":"boolean","description":"Whether the vehicle has rain-sensing wipers, detected from the factory equipment list. Returned where the manufacturer provides a full equipment list; false means the feature is not in the returned list."}},"required":["vin","year","make","model"]},"missing":{"type":"array","description":"Present only when the build lacks `interiorColor`, `exteriorColor` or `options` (the key is absent or empty); `build` is unchanged. A base vehicle's empty `options` is the record's answer, not a gap, so only its colors are listed. A build with missing fields bills as a full build.","items":{"type":"object","properties":{"field":{"type":"string","enum":["interiorColor","exteriorColor","options"],"description":"The build key no record held"},"reason":{"type":"string","enum":["no_vin_record","not_yet_available","source_unavailable"],"description":"`no_vin_record`: no record holds this field for this VIN. `not_yet_available`: the model year is ahead of the catalogs; ask again later in the model year. `source_unavailable` (`options` only): the manufacturer's own source did not answer this time; asking again can fill it."}},"required":["field","reason"]}}},"required":["build"]},"OemBuildColor":{"type":"object","description":"A color's name mapped to its hex swatch, `''` when no swatch is known","additionalProperties":{"type":"string"}},"OemBuildColorLine":{"type":"object","description":"A color, with `?array`","properties":{"name":{"type":"string","description":"Color name"},"colorCode":{"type":"string","description":"Hex swatch, absent when none is known"},"code":{"type":"string","description":"The manufacturer's color code, where the record of this VIN carries one (as in `interiorColorCode` and `exteriorColorCode`)"}},"required":["name"]},"OemBuildOptionLine":{"type":"object","description":"An installed option, with `?array`","properties":{"id":{"type":"string","description":"The manufacturer's option code; absent when none is known"},"name":{"type":"string","description":"Option description"}},"required":["name"]},"OemBuildMissResponse":{"type":"object","description":"A /build answer with no build: a 400, a 404 or the 503 for a source that did not answer. `reason` and `retryable` sit top-level and inside `error` (none on `INVALID_VIN_FORMAT`). `build` is present only on a 404 for a VIN we decoded, and is then the object `{ error, vin }`, not a build, so read the status before `build`.","properties":{"build":{"type":"object","description":"Only on a 404 for a decoded VIN: not a build, but this object","properties":{"error":{"type":"string","enum":["No build data available"],"description":"Always `No build data available`"},"vin":{"type":"string","description":"The VIN asked"}},"required":["error","vin"]},"reason":{"type":"string","enum":["not_yet_available","no_build_record","market_not_covered","class_not_covered","invalid_vin","source_unavailable"],"description":"Why there is no build, as `error.reason`. Absent on `INVALID_VIN_FORMAT`."},"retryable":{"type":"boolean","description":"Whether asking again later can change the answer: true for `not_yet_available` and `source_unavailable`. Absent on `INVALID_VIN_FORMAT`."},"error":{"$ref":"#/components/schemas/ErrorResponse"},"discover":{"type":"object","description":"Only on a 404 for a decoded VIN whose make /specs answers: where to read the VIN's specifications instead","properties":{"specs":{"type":"string","format":"uri","description":"The VIN's /specs URL on the host asked: https://api.auto.dev/specs/{vin}, or https://specs.vin/{vin} on build.vin"}},"required":["specs"]}},"required":["error"]},"OemBuildPartialResponse":{"type":"object","description":"The 207 Multi-Status partial answer: a car we can name but no record builds. `build` holds what is certain for the VIN and `missing` the rest, so one call gives what we know of it. Not an error, not billed, counts toward no quota. Most HTTP clients treat a 207 as ok, so branch on the status before reading the body: `build` is the vehicle's build record only on a 200; on a 207 it is the certain part of the build, or null; on a 404 it is the object `{ error, vin }`.","properties":{"vehicle":{"type":"object","description":"What a decoder said about this VIN. No options, no colors, never a fabricated build.","properties":{"vin":{"type":"string","description":"Vehicle Identification Number"},"year":{"type":"number","description":"Model year"},"make":{"type":"string","description":"Vehicle manufacturer"},"model":{"type":"string","description":"Vehicle model name"},"trim":{"type":"string","description":"The build's trim, when certain for this VIN (`build.trim`): a source pins it for the VIN, or every style the VIN can be shares it. Absent otherwise."},"body":{"type":"string","description":"Body style, when known (e.g., \"Suv 4D\")"},"msrp":{"type":"number","description":"Base MSRP in USD, only when `catalog.styles` holds one style"}},"required":["vin","year","make","model"]},"build":{"type":"object","nullable":true,"description":"What is certain for this VIN, in a 200's keys and words, and nothing else: a value a source pinned for the VIN (a decode or a public register's record of it), one every style the VIN can be shares, or the one a fact of the VIN admits (an Australian Ford's registered power fits one engine). What a style only offers stays in `catalog`. Every build field it does not hold is in `missing`. null when nothing beyond the car is certain. Not billed: a 207 is never the vehicle's build record.","properties":{"vin":{"type":"string","description":"Vehicle Identification Number"},"year":{"type":"number","description":"Model year; `0` when nothing on file for this VIN names one"},"make":{"type":"string","description":"Vehicle manufacturer"},"model":{"type":"string","description":"Vehicle model name"},"trim":{"type":"string","description":"Complete trim designation"},"style":{"type":"string","description":"Body style designation (e.g., \"4D Crossover\")"},"bodyType":{"type":"string","description":"Body type (e.g., \"Pickup\", \"SUV\")"},"drivetrain":{"type":"string","description":"Drivetrain configuration (e.g., \"RWD\", \"AWD\")"},"engine":{"type":"string","description":"Complete engine specification with displacement, configuration, and horsepower"},"transmission":{"type":"string","description":"Transmission type and configuration"},"options":{"oneOf":[{"type":"object","additionalProperties":{"type":"string"}},{"type":"array","items":{"$ref":"#/components/schemas/OemBuildOptionLine"}}],"description":"Only the manufacturer's codes certain for this VIN, keyed by code as a 200 keys its options, each mapped to its name (the catalog's for the same code), e.g. an Australian Ford's engine and gearbox: `{ \"YN2S\": \"2.0L I4 twin-turbo diesel engine, 207 hp\", \"10R80\": \"10-speed shiftable automatic transmission\" }`. With `?array`, a list of `{ id, name }`. Never the VIN's whole options list: `missing` names `options` with reason `partial`."},"standardEquipment":{"type":"object","nullable":true,"description":"Only with `includeStandard=true` (or `1`): as on a 200, what the vehicle ships with where a source this VIN holds can say (a VIN record, or the one style the VIN decodes to); null when none can. Never adds a cost.","properties":{"basis":{"type":"string","enum":["window_sticker","vin_record","exact_trim","style"],"description":"How far to believe the list for this VIN. `window_sticker`: the standard lines of this VIN's own window sticker. `vin_record`: equipment recorded for this VIN; can include what an option added. `exact_trim`: standard at the trim the VIN decodes to exactly. `style`: standard at the one style the VIN decodes to, with nothing on this VIN confirming the trim."},"equipment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"What the line is. A code with no description on file is named by the code itself."},"category":{"type":"string","description":"Equipment category, where the record gives one"},"code":{"type":"string","description":"The manufacturer's code for the line, where one is known: for a Buick, Cadillac, Chevrolet or GMC, every RPO code on file for the vehicle that is not an ordered option, color or package code. GET /rpo/{code} says what one code means."}},"required":["name"]}}},"required":["basis","equipment"]}},"required":["vin","year","make","model"]},"missing":{"type":"array","description":"Only beside a `build`: every build field it does not hold, each with why. `options` is always listed: no 207 holds the VIN's options list. When `build.options` holds the codes certain for the VIN, its reason is `partial`.","items":{"type":"object","properties":{"field":{"type":"string","enum":["trim","style","bodyType","drivetrain","engine","transmission","interiorColor","exteriorColor","options"],"description":"The build key this VIN has no certain value for"},"reason":{"type":"string","enum":["no_vin_record","not_yet_available","partial"],"description":"`no_vin_record`: no record holds it for this VIN, and the styles it can be differ on it (a drive left between 4WD and 2WD) or no source states it. `not_yet_available`: the model year is ahead of the catalogs (the 207's own reason); ask again later in the model year. `partial` (`options` only): `build.options` holds the codes certain for this VIN, and no record lists the rest."}},"required":["field","reason"]}},"catalog":{"type":"object","nullable":true,"description":"What the matched style ships with. The style's, not this VIN's. Null when no style is known for the VIN, or when the reason is `market_not_covered` or `class_not_covered`.","properties":{"vinSpecific":{"type":"boolean","enum":[false],"description":"Always false: the catalog describes the style, not what was installed on this VIN"},"styles":{"type":"array","description":"The styles the VIN matches, most likely first. One entry when the VIN pins one style; several when it matches a ladder. For a European VIN, every style its public-register neighbours are (vehicles of its VIN pattern built close to it, or sharing its first 10 characters: the 207 names the registers).","items":{"type":"object","properties":{"name":{"type":"string","description":"Style name"},"trim":{"type":"string","description":"Trim name"},"confidence":{"type":"number","description":"Estimate from current listings that this is the VIN's style; absent when there are none. For a European VIN, the share of its register neighbours that are this style (its count over theirs plus one)."},"msrp":{"type":"number","description":"Base MSRP in USD"}},"required":["name"]}},"standardEquipment":{"type":"array","description":"Feature names the style lists as standard. For a European VIN, only what every register neighbour states alike (the engine; the gearbox when every one states the same).","items":{"type":"string"}},"availableOptions":{"type":"array","description":"Options and packages the style offers. `code` is the manufacturer's option code when it is known, else null; `name` is always set. Key on `name`. `[]` when the catalog lists none: the European registers never list options. For an Australian Ford, the engines and gearboxes the style's type approval allows, each with Ford's code.","items":{"type":"object","properties":{"code":{"type":"string","nullable":true,"description":"Manufacturer option code when known; null otherwise"},"name":{"type":"string","description":"Option or package name"}},"required":["code","name"]}},"exteriorColors":{"type":"array","description":"Exterior colors the style offers. `colorCode` is a hex value, absent when unknown. `[]` when the catalog lists none: the European and Australian registers never list colors.","items":{"type":"object","properties":{"name":{"type":"string"},"colorCode":{"type":"string"}},"required":["name"]}},"interiorColors":{"type":"array","description":"Interior colors the style offers, in the same shape; `[]` when the catalog lists none","items":{"type":"object","properties":{"name":{"type":"string"},"colorCode":{"type":"string"}},"required":["name"]}}},"required":["vinSpecific","styles","standardEquipment","availableOptions","exteriorColors","interiorColors"]},"reason":{"type":"string","enum":["not_yet_available","no_build_record","market_not_covered","class_not_covered"],"description":"Why there is no build for this VIN. `not_yet_available`: model year ahead of the catalogs, or the maker says the build of a current or next model year VIN is not released yet. `no_build_record`: no record builds this VIN. `market_not_covered`: non-North-American VIN. `class_not_covered`: motorcycle, trailer or heavy truck. The same codes ride a 404 when no decoder names the year, make and model, and a caller below the Growth plan gets `market_not_covered` as a 404 only when the decode does not name the car (see the 404)."},"retryable":{"type":"boolean","description":"Whether asking again later can change the answer; on a 207, true only for `not_yet_available`"}},"required":["vehicle","build","catalog","reason","retryable"]},"OpenRecallsResponse":{"type":"object","properties":{"vehicle":{"type":"object","description":"Decoded vehicle the recalls pertain to","properties":{"year":{"type":"number"},"make":{"type":"string"},"model":{"type":"string"},"vin":{"type":"string"}}},"status":{"type":"string","description":"Human-readable summary of the open NHTSA recall count, e.g. \"2 Open Recalls\" or \"No Open Recalls\". Counts entries in `data` only — manufacturer campaigns are not included in this total."},"openRecalls":{"type":"integer","description":"Number of open NHTSA safety recalls for this VIN. Always equals `data.length`. Manufacturer voluntary campaigns are NOT counted here (see `manufacturerCampaigns`)."},"totalRecalls":{"type":"integer","description":"Total recall campaigns on record for the vehicle's make/model/year, including campaigns already remedied for this specific VIN. Provided for context; use `openRecalls` for the count that still needs action. Present when the make/model/year catalog is available."},"data":{"type":"array","items":{"$ref":"#/components/schemas/OpenRecallRecord"},"description":"Open NHTSA safety recalls for this VIN — the recalls NHTSA itself would report as open. Each record can carry the 9-character `nhtsaCampaignNumber` and the campaign fields (`component`, `consequence`, `remedy`, `parkIt`, `parkOutSide`, etc.), and the manufacturer notice fields when the manufacturer gives them. This is the complete open-recall list for the VIN."},"manufacturerCampaigns":{"type":"array","items":{"$ref":"#/components/schemas/ManufacturerCampaignRecord"},"description":"Open manufacturer voluntary campaigns — customer-satisfaction programs, warranty extensions, and other OEM actions the manufacturer reports but has NOT filed with NHTSA as safety recalls. Included so nothing the OEM flags is hidden, but deliberately kept out of `data` and never counted in `openRecalls`, because they are not what NHTSA would report as an open recall. Present only when the VIN has such campaigns. These carry no NHTSA campaign number and lack the NHTSA-catalog-only fields (`component`, `parkIt`, `parkOutSide`)."},"manufacturerCampaignCount":{"type":"integer","description":"Number of entries in `manufacturerCampaigns`. Present only when there is at least one."},"recalls":{"type":"array","items":{"$ref":"#/components/schemas/OpenRecallRecord"},"description":"Full make/model/year recall catalog (open + closed), one record per campaign, plus any of the VIN's open recalls whose campaign the catalog does not list. Catalog records use the field names of the records in data but carry only what the catalog supplies (no mfrCampaignNumber, remedyAvailable, mfrNotes or isSafetyRecall); an open recall added from data appears as it does there. Present only when the request includes ?recalls=true; when no catalog is available it holds only the VIN's open recalls, and is an empty array if there are none."},"retrievedAt":{"type":"string","nullable":true,"description":"ISO 8601 timestamp of when the returned recall data was last refreshed. Recall data refreshes on a daily cycle, so this is how you tell how current the answer is. `null` when the answer carries no refresh time."}},"required":["vehicle","data","status","openRecalls","totalRecalls","retrievedAt"]},"OpenRecallRecord":{"type":"object","properties":{"manufacturer":{"type":"string","description":"Vehicle manufacturer who issued the recall"},"nhtsaCampaignNumber":{"type":"string","description":"Unique NHTSA recall campaign identifier, zero-padded to 9 characters (e.g. \"25V239000\"). Join on this to match the NHTSA recall catalog."},"mfrCampaignNumber":{"type":"string","description":"Manufacturer's own internal recall identifier (e.g. Toyota's \"25TB08\"). Many OEMs index their dealer-facing remedy instructions by this number rather than the NHTSA campaign number. Present when the manufacturer supplied it."},"remedyAvailable":{"type":"boolean","description":"Whether the dealer can perform the remedy now: false when the manufacturer is still preparing the fix or parts have not reached dealers, true when the remedy is in market. Present when known."},"parkIt":{"type":"boolean","description":"Critical safety flag - vehicle should not be driven until repaired"},"parkOutSide":{"type":"boolean","description":"Critical safety flag - vehicle should be parked away from structures"},"overTheAirUpdate":{"type":"boolean","description":"Whether recall can be resolved via software update without dealer visit"},"reportReceivedDate":{"type":"string","description":"The recall's date (YYYY-MM-DD) as NHTSA's VIN lookup shows it: the manufacturer's recall date for this VIN where the VIN's own record has one, else the date NHTSA received the defect report. campaignReportReceivedDate is always the latter."},"component":{"type":"string","description":"Vehicle component or system affected by the recall"},"summary":{"type":"string","description":"Description of the recall, as NHTSA's VIN lookup shows it: the VIN's own record where there is one, else NHTSA's campaign text (campaignSummary)."},"consequence":{"type":"string","description":"The safety risk, as NHTSA's VIN lookup shows it: the VIN's own record where there is one, else NHTSA's campaign text (campaignConsequence)."},"remedy":{"type":"string","description":"The remedy, as NHTSA's VIN lookup shows it: the VIN's own record where there is one (it can be newer than the campaign's, e.g. an interim remedy the dealer can perform today), else NHTSA's campaign text (campaignRemedy)."},"notes":{"type":"string","description":"Additional notes and contact information for vehicle owners, or null when the record has none","nullable":true},"mfrNotes":{"type":"string","description":"Manufacturer notes, when the record has them"},"campaignSummary":{"type":"string","description":"NHTSA's campaign-level description of the recall, the same for every vehicle in the campaign."},"campaignConsequence":{"type":"string","description":"NHTSA's campaign-level safety-risk text."},"campaignRemedy":{"type":"string","description":"NHTSA's campaign-level remedy text."},"campaignReportReceivedDate":{"type":"string","description":"Date NHTSA received the manufacturer's defect report for the campaign (YYYY-MM-DD)."},"isSafetyRecall":{"type":"boolean","description":"Whether the record is a safety recall. A brand-new recall the manufacturer reports before NHTSA assigns a campaign number counts toward openRecalls when this is true."},"nhtsaActionNumber":{"type":"string","description":"NHTSA action number for the recall, where NHTSA has assigned one"},"modelYear":{"type":"string","description":"Vehicle model year"},"make":{"type":"string","description":"Vehicle make (manufacturer)"},"model":{"type":"string","description":"Vehicle model name"}},"description":"A single recall record. Only the identifier is always present. A record can carry the manufacturer's notice fields (recallDescription, defectSummary, correctiveAction, mfrNotes, status, pdf, source) and the campaign fields (manufacturer, component, consequence, remedy, parkIt, remedyAvailable, …); which of them are set varies by recall.","required":["nhtsaCampaignNumber"]},"ManufacturerCampaignRecord":{"type":"object","description":"An open manufacturer voluntary campaign (warranty extension, customer-satisfaction program, or other OEM action) that is not a NHTSA safety recall. Appears only inside `manufacturerCampaigns`, never in `data`, and is never counted in `openRecalls`. Because these are not in NHTSA's recall catalog they have no `nhtsaCampaignNumber` and none of the catalog-only fields (`component`, `parkIt`, `parkOutSide`, `overTheAirUpdate`). All fields are optional and reflect whatever the manufacturer supplied.","properties":{"mfrCampaignNumber":{"type":"string","description":"Manufacturer's own identifier for the campaign (e.g. \"R21B3\", \"PM674\"). Use it when referencing the campaign with the dealer or OEM."},"summary":{"type":"string","description":"Manufacturer's description of the campaign and the vehicles it affects."},"consequence":{"type":"string","description":"What the manufacturer says can happen if the campaign is not addressed. Often absent for non-safety campaigns."},"remedy":{"type":"string","description":"Manufacturer's instructions for resolving the campaign."},"remedyAvailable":{"type":"boolean","description":"Whether the dealer can perform the remedy now."},"reportReceivedDate":{"type":"string","description":"Date the manufacturer opened the campaign."},"mfrNotes":{"type":"string","description":"Any additional notes the manufacturer provided."}}},"PlateToVinResponse":{"type":"object","properties":{"vin":{"type":"string","description":"Complete 17-character Vehicle Identification Number"},"year":{"type":"number","description":"Model year, as the VIN decodes"},"make":{"type":"string","description":"Vehicle manufacturer, as the VIN decodes"},"model":{"type":"string","nullable":true,"description":"Model name, as the VIN decodes (the name /vin gives). Null in the rare answer whose VIN does not decode and whose plate record named only a body style."},"trim":{"type":"string","description":"Trim level"},"drivetrain":{"type":"string","description":"Drivetrain, e.g. FWD, RWD, AWD, 4WD"},"engine":{"type":"string","description":"Engine specification"},"transmission":{"type":"string","description":"Transmission type"},"fuel":{"type":"string","description":"Fuel type, when the engine names one (e.g. Gasoline, Diesel, Hybrid, Electric)"},"normalizedPlate":{"type":"string","description":"Only for a Florida plate with the letter O: Florida issues no O, so it is looked up as a 0, and this is the plate that was looked up"}},"required":["vin","year","make","model"]},"TaxesFeesResponse":{"type":"object","properties":{"vehicle":{"type":"object","properties":{"vin":{"type":"string","description":"Vehicle Identification Number"},"year":{"type":"number","description":"Model year"},"make":{"type":"string","description":"Vehicle manufacturer"},"model":{"type":"string","description":"Vehicle model name"}},"required":["vin","year","make","model"]},"criteria":{"type":"object","properties":{"price":{"type":"string","description":"Vehicle sale price used for calculations"},"zip":{"type":"string","description":"ZIP code for tax jurisdiction lookup"},"docFee":{"type":"number","description":"Documentation fee included in calculation"},"tradeIn":{"type":"number","description":"Trade-in value deducted from taxable amount"},"taxDocFee":{"type":"boolean","description":"Whether the documentation fee was taxed (the state law, unless the request set taxDocFee)"}}},"totalTaxesAndFees":{"type":"number","format":"float","description":"Total amount of all taxes and fees combined"},"jurisdiction":{"type":"object","description":"The taxing jurisdiction the ZIP code resolved to","properties":{"zip":{"type":"string"},"state":{"type":"string"},"county":{"type":"string"},"city":{"type":"string"},"ambiguous":{"type":"boolean","description":"The ZIP code spans more than one tax jurisdiction"}}},"lines":{"type":"array","description":"Every tax and fee that makes up the totals, with its basis and rate","items":{"type":"object","properties":{"component":{"type":"string","enum":["state","county","city","district","title","registration","dmv","gasGuzzler"]},"name":{"type":"string"},"amount":{"type":"number","format":"float"},"basis":{"type":"number","format":"float"},"rate":{"type":"number","format":"float","description":"As a fraction: 0.1025 is 10.25%"},"source":{"type":"string","description":"The public rate file, fee schedule or statute the line comes from"}}}},"warnings":{"type":"array","items":{"type":"string"},"description":"What the calculation assumed or left out"},"effectiveDate":{"type":"string","format":"date","description":"The date whose rates and fees were applied"},"taxes":{"type":"object","properties":{"stateSalesTax":{"type":"number","format":"float","description":"State-level sales tax amount"},"countySalesTax":{"type":"number","format":"float","description":"County-level sales tax amount"},"citySalesTax":{"type":"number","format":"float","description":"City-level sales tax amount"},"districtSalesTax":{"type":"number","format":"float","description":"Special district sales tax amount"},"combinedSalesTax":{"type":"number","format":"float","description":"Total of all sales taxes"},"gasGuzzlerTax":{"type":"number","format":"float","description":"Federal gas guzzler tax (if applicable)"}}},"fees":{"type":"object","properties":{"titleFee":{"type":"number","format":"float","description":"Vehicle title processing fee"},"registrationFee":{"type":"number","format":"float","description":"Vehicle registration fee"},"dmvFee":{"type":"number","format":"float","description":"Standard DMV processing fee"},"docFee":{"type":"number","format":"float","description":"Dealer documentation fee"},"combinedFees":{"type":"number","format":"float","description":"Total of all government fees"},"dmvFees":{"type":"object","additionalProperties":{"type":"number","format":"float"},"description":"Detailed breakdown of DMV-specific fees"}}}},"required":["vehicle","totalTaxesAndFees"]},"ErrorResponse":{"type":"object","properties":{"status":{"type":"number","description":"HTTP status code"},"error":{"type":"string","description":"Error message"},"code":{"type":"string","description":"Error code"},"path":{"type":"string","description":"API path that generated the error"},"requestId":{"type":"string","description":"Unique request identifier"},"suggestion":{"type":"string","description":"Where to ask instead, when there is a better place (e.g. a VIN sent to /rpo/{code})"},"reason":{"type":"string","enum":["not_yet_available","no_build_record","market_not_covered","class_not_covered","invalid_vin","source_unavailable"],"description":"On a /build miss: why there is no build for this VIN (also top-level on the body). The same codes ride a 207 partial answer when a decoder names the car. `source_unavailable` rides the 503 when a source did not answer."},"retryable":{"type":"boolean","description":"On a /build miss: whether asking again later can change the answer; true only for `not_yet_available` and `source_unavailable`"},"detectedMarket":{"type":"object","description":"On a /build VIN_NOT_IN_COVERAGE miss: the market the VIN belongs to","properties":{"country":{"type":"string"},"region":{"type":"string"}}},"detectedClass":{"type":"object","description":"On a /build VIN_NOT_IN_COVERAGE miss: the vehicle class outside coverage","properties":{"vehicleType":{"type":"string"},"gvwr":{"type":"string","description":"On a heavy truck: its gross vehicle weight rating class"}}}},"required":["status","error","code","path","requestId"]},"UnauthorizedResponse":{"type":"object","description":"A 401: `error` is an object here, not a string","properties":{"status":{"type":"number","enum":[401],"description":"HTTP status code"},"error":{"type":"object","properties":{"code":{"type":"string","enum":["API_KEY_REQUIRED","API_KEY_NOT_RECOGNISED"],"description":"`API_KEY_REQUIRED`: no API key was sent. `API_KEY_NOT_RECOGNISED`: the key sent is not known (it may have been regenerated or revoked)."},"message":{"type":"string","description":"What to do"}},"required":["code","message"]}},"required":["status","error"]},"RefusalResponse":{"type":"object","description":"A request refused before it was looked up: a 402, a 429, or a 503 when the key or plan could not be checked","properties":{"status":{"type":"number","description":"HTTP status code"},"error":{"type":"string","description":"Error message"},"code":{"type":"string","description":"Error code"},"message":{"type":"string","description":"What happened and what to do"},"path":{"type":"string","description":"API path that generated the error"},"requestId":{"type":"string","description":"Unique request identifier"},"currentPlan":{"type":"string","description":"`FEATURE_NOT_AVAILABLE`: the plan the caller is on"},"requiredPlan":{"type":"string","description":"`FEATURE_NOT_AVAILABLE`: the plan this operation needs"},"upgradeUrl":{"type":"string","description":"`FEATURE_NOT_AVAILABLE`: where to change plan"},"upgradeLink":{"type":"string","description":"Where to change plan"},"docsUrl":{"type":"string","description":"`FEATURE_NOT_AVAILABLE`: the pricing page"},"plans":{"type":"object","description":"The paid plans: price, rate limit and the endpoints each adds","additionalProperties":{"type":"object","properties":{"price":{"type":"string"},"rateLimit":{"type":"string"},"features":{"type":"string"}}}},"link":{"type":"string","description":"`ACCOUNT_PAST_DUE`: the invoice to pay"},"invoiceUrl":{"type":"string","description":"`TRIAL_CAP_EXCEEDED`: the invoice to pay, when there is one"},"limitType":{"type":"string","enum":["burst","quota"],"description":"`RATE_LIMIT_EXCEEDED`: which limit. `burst`: the plan's requests per 10 seconds. `quota`: the 1,000 calls a month of a key on the free allowance."}},"required":["status","error","code"]},"ErrorEnvelope":{"type":"object","description":"An error answer. The `error` object says what went wrong; the `api` and `user` blocks every answer carries are omitted here.","properties":{"error":{"$ref":"#/components/schemas/ErrorResponse"},"vin":{"type":"string","description":"On a malformed VIN: the VIN as sent"},"vinValid":{"type":"boolean","description":"On a malformed VIN: false"}},"required":["error"]},"PriceResponse":{"type":"object","properties":{"vehicle":{"type":"object","properties":{"vin":{"type":"string","description":"Vehicle Identification Number"},"year":{"type":"number","description":"Model year"},"make":{"type":"string","description":"Vehicle manufacturer"},"model":{"type":"string","description":"Vehicle model name"}},"required":["vin","year","make","model"]},"ambiguous":{"type":"boolean","description":"Present (true) when the VIN matches several styles; see styles"},"yearAmbiguous":{"type":"boolean","description":"Present (true) when more than one model year fits the VIN; see years"},"years":{"type":"array","items":{"type":"number"},"description":"Every model year that fits the VIN; present when ambiguous or yearAmbiguous"},"prices":{"allOf":[{"$ref":"#/components/schemas/PriceValues"}],"nullable":true,"description":"Current values in USD. Null when the VIN matches several styles (each is listed in styles with its own values), unless ambiguity=true, which gives the most likely style's values here."},"trims":{"type":"array","items":{"type":"string"},"description":"Present only when the VIN matches more than one style: every trim among them, most likely first"},"styles":{"type":"array","items":{"$ref":"#/components/schemas/PriceStyle"},"description":"Present only when the VIN matches more than one style: each one with its own values, most likely first"}},"required":["vehicle","prices"]},"PriceValues":{"type":"object","description":"Values in USD, nationally. A value that is not known is absent, never 0. The two with options are at the mileage /price prices at (the mileage sent, else the newest listing's, else the typical mileage); the three base values are at typical mileage.","properties":{"retailOptions":{"type":"number","description":"Dealer retail value, with the style's typical options, at the mileage priced at"},"privatePartyOptions":{"type":"number","description":"Private-party value, with the style's typical options, at the mileage priced at"},"retailBase":{"type":"number","description":"Dealer retail value of the base style, at typical mileage"},"privatePartyBase":{"type":"number","description":"Private-party value of the base style, at typical mileage"},"auctionBase":{"type":"number","description":"Auction (wholesale) value of the base style, at typical mileage"}}},"PriceStyle":{"type":"object","description":"One of the styles an ambiguous VIN matches, with its values","properties":{"name":{"type":"string","description":"Style name"},"trim":{"type":"string","description":"The style's trim"},"confidence":{"type":"number","description":"Estimated share of this style among current listings of the model and year (0-1); absent when there are none"},"prices":{"$ref":"#/components/schemas/PriceValues"}},"required":["name","prices"]},"IncentivesResponse":{"type":"object","properties":{"vehicle":{"allOf":[{"$ref":"#/components/schemas/VehicleBasic"}],"description":"The decoded vehicle; present when a VIN was asked for"},"zip":{"type":"string","description":"The ZIP code the offers apply in"},"data":{"type":"array","items":{"$ref":"#/components/schemas/Incentive"},"description":"Current offers; never empty"}},"required":["zip","data"]},"Incentive":{"type":"object","description":"One manufacturer offer. Fields an offer does not have are absent.","properties":{"year":{"type":"string","description":"Model year the offer is for; on a make or make and model request"},"make":{"type":"string","description":"Make the offer is for; on a make or make and model request"},"model":{"type":"string","description":"Model the offer is for; on a make or make and model request"},"title":{"type":"string","description":"The offer's name"},"type":{"type":"string","description":"Offer type, e.g. LOW_APR, CASH_REBATE, DEALER_CASH, MISCELLANEOUS"},"category":{"type":"string","description":"Offer category, e.g. FINANCING, REBATES, DEALER, OTHER"},"subcategory":{"type":"string","description":"Offer subcategory, e.g. ALL, CUSTOMERCASH, DEALER"},"totalCash":{"type":"number","description":"Cash amount of a rebate, in USD"},"cashDescription":{"type":"string","description":"Present when the cash is paid to the dealer rather than the buyer"},"apr":{"type":"number","description":"Special APR, in percent"},"term":{"type":"number","description":"Term of a financing or lease offer, in months"},"creditTier":{"type":"string","description":"The credit tier a special APR is offered to"},"creditScoreMin":{"type":"number","description":"Lowest credit score of the tier"},"creditScoreMax":{"type":"number","description":"Highest credit score of the tier"},"financing":{"type":"boolean","description":"Whether the offer applies to financing"},"leasing":{"type":"boolean","description":"Whether the offer applies to leasing"},"condition":{"type":"string","description":"The inventory the offer applies to, e.g. new"},"description":{"type":"string","description":"The offer's terms"},"disclaimer":{"type":"string","description":"The offer's restrictions"},"startDate":{"type":"string","format":"date-time","description":"When the offer starts"},"endDate":{"type":"string","format":"date-time","description":"When the offer ends"}}},"YmmResponse":{"type":"object","properties":{"vin":{"type":"string","description":"The VIN as decoded"},"vinValid":{"type":"boolean","description":"Whether the VIN is well-formed"},"wmi":{"type":"string","description":"World Manufacturer Identifier (first 3 characters)"},"origin":{"type":"string","description":"Country of manufacture"},"squishVin":{"type":"string","description":"The VIN without its check digit and serial number"},"checkDigit":{"type":"string","description":"The 9th character, used to validate the VIN"},"checksum":{"type":"boolean","description":"Whether the check digit computes"},"type":{"type":"string","description":"Vehicle type, e.g. Automobiles, MPV, Truck"},"years":{"type":"array","items":{"type":"number"},"description":"Every model year that fits the VIN"},"year":{"type":"number","description":"Model year"},"yearAmbiguous":{"type":"boolean","description":"Present (true) when more than one model year fits the VIN; see years"},"ambiguous":{"type":"boolean","description":"Whether the VIN matches more than one style or trim"},"make":{"type":"string","description":"Vehicle manufacturer"},"model":{"type":"string","description":"Vehicle model name"},"trim":{"type":"string","description":"Trim level"},"style":{"type":"string","description":"Style"},"body":{"type":"string","description":"Body style"},"engine":{"type":"string","description":"Engine"},"drive":{"type":"string","description":"Drivetrain"},"transmission":{"type":"string","description":"Transmission type"},"vehicle":{"$ref":"#/components/schemas/VehicleBasic"}},"required":["vin","vinValid"]},"DealerSearchResponse":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/DealerSearchResult"}},"total":{"type":"number","description":"Number of dealers that match"},"limit":{"type":"number","description":"Results per page"},"offset":{"type":"number","description":"Results skipped"}},"required":["data","total","limit","offset"]},"DealerSearchResult":{"type":"object","description":"One dealer. A field with nothing on file is null.","properties":{"id":{"type":"string","description":"Dealer id. An id that starts with d_ can be read with /dealers/{id}"},"name":{"type":"string","nullable":true,"description":"Dealer name"},"phone":{"type":"string","nullable":true,"description":"Phone number, E.164"},"website":{"type":"string","nullable":true,"description":"Website domain"},"domain":{"type":"string","nullable":true,"description":"The same as website; kept for earlier callers"},"street":{"type":"string","nullable":true},"city":{"type":"string","nullable":true},"state":{"type":"string","nullable":true,"description":"Two-letter state code"},"zip":{"type":"string","nullable":true},"country":{"type":"string","nullable":true,"description":"Two-letter country code"},"lat":{"type":"number","nullable":true},"lon":{"type":"number","nullable":true},"lastSeen":{"type":"string","description":"When the dealer was last seen in a listing, UTC"},"listings":{"type":"string","nullable":true,"description":"URL of the dealer's listings (/listings?dealerId=); null when it has no active listing"}},"required":["id","lastSeen"]},"DealerResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Dealer"}},"required":["data"]},"Dealer":{"type":"object","description":"One dealer. A field with nothing on file is null.","properties":{"id":{"type":"string","description":"Dealer id"},"name":{"type":"string","nullable":true,"description":"Dealer name"},"dealerGroupName":{"type":"string","nullable":true,"description":"The dealer group it belongs to"},"phone":{"type":"string","nullable":true,"description":"Phone number, E.164"},"website":{"type":"string","nullable":true,"description":"Website domain"},"email":{"type":"string","nullable":true},"street":{"type":"string","nullable":true},"city":{"type":"string","nullable":true},"state":{"type":"string","nullable":true,"description":"Two-letter state code"},"zip":{"type":"string","nullable":true},"country":{"type":"string","nullable":true,"description":"Two-letter country code"},"lat":{"type":"number","nullable":true},"lon":{"type":"number","nullable":true},"metro":{"type":"string","nullable":true,"description":"Metropolitan area code"},"totalInventory":{"type":"number","nullable":true,"description":"Active listings"},"newInventory":{"type":"number","nullable":true,"description":"Active listings of new vehicles"},"usedInventory":{"type":"number","nullable":true,"description":"Active listings of used vehicles"},"avgNewPrice":{"type":"number","nullable":true,"description":"Average price of its new vehicles, USD"},"avgUsedPrice":{"type":"number","nullable":true,"description":"Average price of its used vehicles, USD"},"avgDom":{"type":"number","nullable":true,"description":"Average days on market"},"avgDomNew":{"type":"number","nullable":true,"description":"Average days on market of its new vehicles"},"avgDomUsed":{"type":"number","nullable":true,"description":"Average days on market of its used vehicles"},"avgUsedMileage":{"type":"number","nullable":true,"description":"Average mileage of its used vehicles"}},"required":["id"]},"ExampleVinsResponse":{"type":"object","properties":{"data":{"type":"array","maxItems":10,"items":{"type":"string","format":"uri"},"description":"Up to 10 VINs, each as a link to its decode: the VIN is the last path segment"}},"required":["data"]}},"responses":{"Unauthorized":{"description":"The API key is missing or not valid.","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number","description":"HTTP status code"},"error":{"type":"object","properties":{"message":{"type":"string","description":"What to do"}}}}},"example":{"status":401,"error":{"message":"Authentication required. Get your API key at https://auto.dev/dashboard/api-keys"}}}}},"PlanRequired":{"description":"The plan of the API key does not include this operation. The body and the X-Required-Plan and X-Current-Plan headers name the plan that does.","headers":{"X-Required-Plan":{"description":"Plan needed for this operation","schema":{"type":"string"}},"X-Current-Plan":{"description":"Plan the caller is on","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"status":402,"error":"Payment Required","code":"FEATURE_NOT_AVAILABLE","message":"This feature requires the Scale plan. You are currently on the Free plan.","currentPlan":"Free","requiredPlan":"Scale","upgradeUrl":"https://auto.dev/pricing?tier=Scale","upgradeLink":"https://auto.dev/pricing?tier=Scale","docsUrl":"https://auto.dev/pricing","plans":{"Growth":{"price":"$299/mo","rateLimit":"10 req/s","features":"apr, build, dealers, incentives, payments, price, recalls, specs, tco, ymm"},"Scale":{"price":"$599/mo","rateLimit":"50 req/s","features":"All Growth + openrecalls, plate, taxes"}},"path":"/openrecalls/1HGCM82633A123456","requestId":"f6g7h8i9j0k1l2m3"}}}},"RateLimited":{"description":"More requests per second than the plan allows. Wait for the seconds in Retry-After, then retry.","headers":{"Retry-After":{"description":"Seconds until the caller may retry","schema":{"type":"integer"}},"X-RateLimit-Limit":{"description":"Request budget for the window","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Always 0 on a 429","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Unix timestamp (seconds) when the window resets","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"status":429,"error":"Rate limit exceeded for your Free plan. Upgrade to Growth ($299/mo, 10 req/s) at https://auto.dev/pricing for higher limits.","code":"RATE_LIMIT_EXCEEDED","path":"/vin/1HGCM82633A123456","requestId":"l2m3n4o5p6q7r8s9","upgradeLink":"https://auto.dev/pricing","plans":{"Growth":{"price":"$299/mo","rateLimit":"10 req/s","features":"apr, build, dealers, incentives, payments, price, recalls, specs, tco, ymm"},"Scale":{"price":"$599/mo","rateLimit":"50 req/s","features":"All Growth + openrecalls, plate, taxes"}}}}}}}},"tags":[{"name":"Vehicle Information","description":"Retrieve comprehensive vehicle data including VIN decoding, specifications, photos, and OEM build information"},{"name":"Vehicle Listings","description":"Search and retrieve vehicle listings from dealers across the United States"},{"name":"Safety & Recalls","description":"Access vehicle safety information including recall history and active recall alerts"},{"name":"Financial Calculations","description":"Calculate vehicle-related costs including payments, interest rates, taxes, fees, and total cost of ownership"},{"name":"Vehicle Lookup","description":"Convert license plates to VIN numbers and perform reverse vehicle lookups"},{"name":"Pricing & Incentives","description":"A vehicle's current market values, and the manufacturer incentives offered on new vehicles"},{"name":"Dealers","description":"Find dealers, and read their contact details and inventory statistics"}],"paths":{"/ymm/{vin}":{"get":{"tags":["Vehicle Information"],"summary":"Decode Year, Make and Model","description":"The year, make, model, trim, style, body, engine, drive and transmission a VIN decodes to, with its validation details.","operationId":"decodeYmm","parameters":[{"name":"vin","in":"path","required":true,"schema":{"type":"string","pattern":"^[A-HJ-NPR-Z0-9]{17}$"},"description":"17-character Vehicle Identification Number"}],"responses":{"200":{"description":"The decoded vehicle","content":{"application/json":{"schema":{"$ref":"#/components/schemas/YmmResponse"},"example":{"vin":"1FMCU0G60LUA05025","vinValid":true,"wmi":"1FM","origin":"United States","squishVin":"1FMCU0G6LU","checkDigit":"0","checksum":true,"type":"MPV","years":[2020],"year":2020,"ambiguous":false,"make":"Ford","model":"Escape","trim":"SE FWD","style":"1.5, 3 Cylinder Engine","body":"4dr SUV","engine":"1.5, 3 Cylinder Engine","drive":"Front Wheel Drive","transmission":"Automatic","vehicle":{"vin":"1FMCU0G60LUA05025","year":2020,"make":"Ford","model":"Escape","manufacturer":"Ford Motor Company"}}}}},"400":{"description":"Not a VIN (INVALID_VIN_FORMAT), or a 17-character VIN that is no vehicle: its check digit does not compute, or it is a test pattern (INVALID_VIN)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"},"examples":{"format":{"summary":"Not a VIN (INVALID_VIN_FORMAT)","value":{"vinValid":false,"error":{"status":400,"error":"VIN must be exactly 17 characters containing only letters and numbers (excluding I, O, Q)","code":"INVALID_VIN_FORMAT","path":"/ymm/12345","requestId":"a5986c13d8fd3f0e","reason":"invalid_vin","retryable":false}}},"invalidVin":{"summary":"A check digit that does not compute (INVALID_VIN)","value":{"vinValid":false,"error":{"status":400,"error":"This VIN is not a vehicle: its check digit does not compute, or it is a test pattern.","code":"INVALID_VIN","path":"/ymm/1T9P61528VP394134","requestId":"a59d3b0c1e7f4a21","reason":"invalid_vin","retryable":false}}}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"402":{"$ref":"#/components/responses/PlanRequired"},"404":{"description":"A well-formed VIN with no year, make and model on file (VIN_NOT_FOUND)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"},"example":{"vin":"1T9P61527VP394134","error":{"status":404,"error":"Unable to decode VIN: 1T9P61527VP394134","code":"VIN_NOT_FOUND","path":"/ymm/1T9P61527VP394134","requestId":"a59d3b0a7c2e9f15"}}}}},"429":{"$ref":"#/components/responses/RateLimited"}},"x-required-plan":"Growth"}},"/photos/{vin}":{"get":{"tags":["Vehicle Information"],"summary":"Get Vehicle Photos","description":"Retrieve a collection of high-quality retail images for a specific vehicle based on its VIN. Get comprehensive photo collections including exterior, interior, and detail shots from dealer listings.","operationId":"getVehiclePhotos","parameters":[{"name":"vin","in":"path","required":true,"schema":{"type":"string","pattern":"^[A-HJ-NPR-Z0-9]{17}$"},"description":"17-character Vehicle Identification Number"}],"responses":{"200":{"description":"Successfully retrieved vehicle photos","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VehiclePhotosResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"description":"Vehicle not found or no photos available","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"status":404,"error":"This vehicle does not have any photos available. Please try a different VIN.","code":"RESOURCE_NOT_FOUND","path":"/photos/123Invalid","requestId":"966d92f81daff05e"}}}},"429":{"$ref":"#/components/responses/RateLimited"}}}},"/vin/{vin}":{"get":{"tags":["Vehicle Information"],"summary":"Decode VIN","description":"Decode a 17-character Vehicle Identification Number (VIN) to retrieve comprehensive vehicle information including make, model, year, and validation details.","operationId":"decodeVin","parameters":[{"name":"vin","in":"path","required":true,"schema":{"type":"string","pattern":"^[A-HJ-NPR-Z0-9]{17}$"},"description":"17-character Vehicle Identification Number"},{"$ref":"#/components/parameters/Ambiguity"}],"responses":{"200":{"description":"Successfully decoded VIN with vehicle information","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VinDecodeResponse"},"example":{"vin":"3GCUDHEL3NG668790","vinValid":true,"wmi":"3GC","origin":"Mexico","squishVin":"3GCUDHELNG","checkDigit":"3","checksum":true,"type":"Active","make":"Chevrolet","model":"Silverado 1500","trim":"ZR2","style":"4x4 4dr Crew Cab 5.8 ft. SB","body":"Truck","engine":"5.3L V8 OHV 16V FFV","drive":"4WD","transmission":"Automatic","doors":4,"fuel":"Flex-fuel","vehicle":{"vin":"3GCUDHEL3NG668790","year":2022,"make":"Chevrolet","model":"Silverado 1500","manufacturer":"General Motors de Mexico"},"ambiguous":false}}}},"207":{"description":"Partial answer: the VIN decodes to less than the year, make and model, and the vehicle's class or market says why. `vehicle` holds what was said (manufacturer, type, year; make and model when named); the decode fields of a 200 are absent. Not an error, not billed. Branch on the status before reading the body as a 200.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VinDecodePartialResponse"},"example":{"vin":"1T9P61527VP394134","vinValid":true,"vehicle":{"vin":"1T9P61527VP394134","year":2027,"manufacturer":"The Metal Shop","type":"Utility Trailers"},"yearAmbiguous":true,"years":[2027,1997],"reason":"class_not_covered","retryable":false}}}},"400":{"description":"Invalid VIN format","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"status":400,"error":"VIN must be exactly 17 characters containing only letters and numbers (excluding I, O, Q)","code":"INVALID_VIN_FORMAT","path":"/vin/123Invalid","requestId":"a1b2c3d4e5f6g7h8"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"description":"VIN not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"status":404,"error":"No vehicle data found for the provided VIN","code":"VIN_NOT_FOUND","path":"/vin/3GCUDHEL3NG668790","requestId":"b2c3d4e5f6g7h8i9"}}}},"429":{"$ref":"#/components/responses/RateLimited"}}}},"/vin/bulk":{"post":{"summary":"Decode VINs in Bulk","description":"Look up many VINs in one call. The answer holds one item per VIN, in the order sent: exactly what `GET /vin/{vin}` answers for that VIN, plus `vin` and `statusCode`. The call itself is 200 whenever it ran; a VIN that could not be answered is an item with its own error status, and is listed in `bulk.retry` when sending it again may help. There is no limit on how many VINs. A large list takes longer, about as fast as your plan's requests per second allow, and the connection stays open until every VIN is answered. Each VIN answered with a 2xx counts as one `GET /vin/{vin}` call, once per VIN per day; the bulk call itself is not counted. A 207 (a partial decode) is not counted, as on `GET /vin/{vin}`. On the Free plan the call answers no more VINs than the month's free calls left; each VIN past them is a 429 item with `limitType: quota`, as its single call would be.","operationId":"bulkDecodeVin","tags":["Vehicle Information"],"parameters":[{"$ref":"#/components/parameters/Ambiguity"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["vins"],"properties":{"vins":{"description":"The VINs to look up: a list, or one string with the VINs separated by commas, spaces or new lines. Each VIN is answered once, in the order sent. There is no limit on how many.","oneOf":[{"type":"array","items":{"type":"string"}},{"type":"string"}]}}},"example":{"vins":["3GCUDHEL3NG668790","1FMUK7DHXSGA27346"]}}}},"responses":{"200":{"description":"Every VIN answered","content":{"application/json":{"schema":{"type":"object","properties":{"bulk":{"type":"object","description":"Counts for the whole call.","properties":{"id":{"type":"string","description":"This call, as each VIN's usage row names it (`bulk=` in its query)"},"endpoint":{"type":"string","enum":["recalls","openrecalls","vin","specs","build"]},"requested":{"type":"number","description":"VINs asked, each once"},"answered":{"type":"number","description":"VINs answered with a 2xx: the VINs billed"},"failed":{"type":"number","description":"VINs answered with an error"},"byStatus":{"type":"object","additionalProperties":{"type":"number"},"description":"VINs per status"},"retry":{"type":"array","items":{"type":"string"},"description":"The VINs worth sending again: those answered 429 (but a monthly quota's) or 5xx"},"ms":{"type":"number","description":"Time taken, in milliseconds"}}},"results":{"type":"array","items":{"description":"One VIN: the answer the single-VIN endpoint gives for it (its `api`, `links`, `user` and `examples` blocks left out), with `vin` and `statusCode`, the status that call would have had. An error item carries `error`, and `retryAfter` (seconds) where that call would have sent a Retry-After header.","allOf":[{"type":"object","required":["vin","statusCode"],"properties":{"vin":{"type":"string"},"statusCode":{"type":"number","description":"The status the single-VIN call would have answered"},"retryAfter":{"type":"number","description":"Seconds to wait before asking this VIN again"}}},{"anyOf":[{"$ref":"#/components/schemas/VinDecodeResponse"},{"$ref":"#/components/schemas/VinDecodePartialResponse"},{"$ref":"#/components/schemas/ErrorEnvelope"}]}]}}}},"example":{"bulk":{"id":"6f1c0d52-3a4e-4a8e-9a43-0c4b0d1f2e3a","endpoint":"vin","requested":2,"answered":1,"failed":1,"byStatus":{"200":1,"404":1},"retry":[],"ms":412},"results":[{"vin":"3GCUDHEL3NG668790","statusCode":200,"vinValid":true,"wmi":"3GC","origin":"Mexico","squishVin":"3GCUDHELNG","checkDigit":"3","checksum":true,"type":"Active","make":"Chevrolet","model":"Silverado 1500","trim":"ZR2","style":"4x4 4dr Crew Cab 5.8 ft. SB","body":"Truck","engine":"5.3L V8 OHV 16V FFV","drive":"4WD","transmission":"Automatic","doors":4,"fuel":"Flex-fuel","vehicle":{"vin":"3GCUDHEL3NG668790","year":2022,"make":"Chevrolet","model":"Silverado 1500","manufacturer":"General Motors de Mexico"},"ambiguous":false},{"vin":"1FMUK7DHXSGA27346","statusCode":404,"vinValid":false,"error":{"status":404,"error":"Failed to decode VIN: 1FMUK7DHXSGA27346","code":"VIN_NOT_FOUND","path":"/vin/1FMUK7DHXSGA27346","requestId":"a1b2c3d4e5f6g7h8"}}]}}}},"400":{"description":"The body names no VIN","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"},"example":{"error":{"status":400,"error":"Send {\"vins\": [\"VIN1\", \"VIN2\", ...]}.","code":"BULK_BODY_INVALID","path":"/openrecalls/bulk","requestId":"a1b2c3d4e5f6g7h8"}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"429":{"$ref":"#/components/responses/RateLimited"}}}},"/specs/bulk":{"post":{"summary":"Get Vehicle Specifications in Bulk","description":"Look up many VINs in one call. The answer holds one item per VIN, in the order sent: exactly what `GET /specs/{vin}` answers for that VIN, plus `vin` and `statusCode`. The call itself is 200 whenever it ran; a VIN that could not be answered is an item with its own error status, and is listed in `bulk.retry` when sending it again may help. There is no limit on how many VINs. A large list takes longer, about as fast as the Growth plan's requests per second allow, and the connection stays open until every VIN is answered. Each VIN answered with a 2xx counts as one `GET /specs/{vin}` call, once per VIN per day; the bulk call itself is not counted. A 207 (partial specifications) is not counted, as on `GET /specs/{vin}`.","operationId":"bulkVehicleSpecifications","tags":["Vehicle Information"],"parameters":[{"$ref":"#/components/parameters/Ambiguity"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["vins"],"properties":{"vins":{"description":"The VINs to look up: a list, or one string with the VINs separated by commas, spaces or new lines. Each VIN is answered once, in the order sent. There is no limit on how many.","oneOf":[{"type":"array","items":{"type":"string"}},{"type":"string"}]}}},"example":{"vins":["1FMUK7DHXSGA27345","5YJ3E1EA7KF317000"]}}}},"responses":{"200":{"description":"Every VIN answered","content":{"application/json":{"schema":{"type":"object","properties":{"bulk":{"type":"object","description":"Counts for the whole call.","properties":{"id":{"type":"string","description":"This call, as each VIN's usage row names it (`bulk=` in its query)"},"endpoint":{"type":"string","enum":["recalls","openrecalls","vin","specs","build"]},"requested":{"type":"number","description":"VINs asked, each once"},"answered":{"type":"number","description":"VINs answered with a 2xx: the VINs billed"},"failed":{"type":"number","description":"VINs answered with an error"},"byStatus":{"type":"object","additionalProperties":{"type":"number"},"description":"VINs per status"},"retry":{"type":"array","items":{"type":"string"},"description":"The VINs worth sending again: those answered 429 (but a monthly quota's) or 5xx"},"ms":{"type":"number","description":"Time taken, in milliseconds"}}},"results":{"type":"array","items":{"description":"One VIN: the answer the single-VIN endpoint gives for it (its `api`, `links`, `user` and `examples` blocks left out), with `vin` and `statusCode`, the status that call would have had. An error item carries `error`, and `retryAfter` (seconds) where that call would have sent a Retry-After header.","allOf":[{"type":"object","required":["vin","statusCode"],"properties":{"vin":{"type":"string"},"statusCode":{"type":"number","description":"The status the single-VIN call would have answered"},"retryAfter":{"type":"number","description":"Seconds to wait before asking this VIN again"}}},{"anyOf":[{"$ref":"#/components/schemas/VehicleSpecsResponse"},{"$ref":"#/components/schemas/VehicleSpecsPartialResponse"},{"$ref":"#/components/schemas/ErrorEnvelope"}]}]}}}},"example":{"bulk":{"id":"6f1c0d52-3a4e-4a8e-9a43-0c4b0d1f2e3a","endpoint":"specs","requested":2,"answered":1,"failed":1,"byStatus":{"200":1,"400":1},"retry":[],"ms":1412},"results":[{"vin":"1FMUK7DHXSGA27345","statusCode":200,"vehicle":{"vin":"1FMUK7DHXSGA27345","year":2025,"make":"Ford","model":"Explorer"},"specs":{"name":"2025 Ford Explorer Active 4dr SUV (2.3L 4cyl Turbo 10A)"}},{"vin":"1FMUK7DHXSGA2734","statusCode":400,"error":{"status":400,"error":"Invalid VIN format: 1FMUK7DHXSGA2734","code":"INVALID_VIN_FORMAT","path":"/specs/1FMUK7DHXSGA2734","requestId":"a1b2c3d4e5f6g7h8"}}]}}}},"400":{"description":"The body names no VIN","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"},"example":{"error":{"status":400,"error":"Send {\"vins\": [\"VIN1\", \"VIN2\", ...]}.","code":"BULK_BODY_INVALID","path":"/openrecalls/bulk","requestId":"a1b2c3d4e5f6g7h8"}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"402":{"$ref":"#/components/responses/PlanRequired"},"429":{"$ref":"#/components/responses/RateLimited"}},"x-required-plan":"Growth"}},"/listings":{"get":{"tags":["Vehicle Listings"],"summary":"Search Vehicle Listings","description":"Get comprehensive vehicle listings from U.S. physical & online dealers. Returns an array of listings with detailed vehicle information, dealership data, specifications, and market pricing. By default the listings are cars and light trucks (pickups, vans, and the chassis cabs and cutaways of the light-vehicle lines); RVs, trailers, motorcycles, heavy trucks and equipment are returned when `vehicle.type` names them, when `vehicle.make` names their maker, or for a VIN.","operationId":"searchVehicleListings","parameters":[{"name":"page","in":"query","description":"Page number to retrieve (starting from 1)","schema":{"type":"integer","default":1},"example":1},{"name":"limit","in":"query","description":"Number of listings to return per page. Maximum 500. Per-plan caps (Free/Starter: 20, Growth: 100, Scale: 500) will be enforced in a future release; callers will be emailed before the change ships.","schema":{"type":"integer","minimum":1,"maximum":500,"default":100},"example":20},{"name":"cursor","in":"query","description":"Opaque pagination token. Issued by the API in links.next at page 50+. Conflicts with ?page= — pick one mode. Follow the emitted cursor URL rather than constructing manually.","schema":{"type":"string"}},{"name":"sort","in":"query","description":"Sort field with optional direction. Format: <field> or <field>.<direction>. Supported fields: createdAt, updatedAt, price, miles, mileage, year. Direction: asc or desc (default asc). Default when omitted: updatedAt.desc. Single field only; multi-column sort, random, and distance are not supported.","schema":{"type":"string","enum":["createdAt","createdAt.asc","createdAt.desc","updatedAt","updatedAt.asc","updatedAt.desc","price","price.asc","price.desc","miles","miles.asc","miles.desc","mileage","mileage.asc","mileage.desc","year","year.asc","year.desc"],"default":"updatedAt.desc"}},{"name":"vehicle.year","in":"query","description":"The year of the vehicle. Use specific year (2018) or range (2018-2020)","schema":{"type":"string","default":""}},{"name":"vehicle.make","in":"query","description":"Vehicle manufacturer. Use comma for multiple: Ford,Chevrolet","schema":{"type":"string","default":""}},{"name":"vehicle.model","in":"query","description":"Vehicle model. Use comma for multiple: F-150,Silverado","schema":{"type":"string","default":""}},{"name":"vehicle.trim","in":"query","description":"Trim level. Use comma for multiple: XLT,LT","schema":{"type":"string","default":""}},{"name":"vehicle.bodyStyle","in":"query","description":"Body style. Use comma for multiple: sedan,coupe","schema":{"type":"string","default":""}},{"name":"vehicle.type","in":"query","description":"Vehicle category, as the `vehicleType` facet lists it (Crossover, Truck, Sedan, ...). Use comma for multiple. Listings are cars and light trucks unless this names a class the default leaves out: `RV` (motorhomes, travel trailers, fifth wheels, campers), `Trailer` (utility, cargo, car-hauler, dump and equipment trailers), `Motorcycle` (motorcycles, ATVs, UTVs, snowmobiles, scooters, golf carts and low-speed vehicles), `Heavy Truck` (medium- and heavy-duty trucks and buses), `Equipment`, or `Other`. A class name may stand beside a category: `Truck,RV`. Pagination and facet links keep the classes named.","schema":{"type":"string","default":""},"example":"RV"},{"name":"vehicle.engine","in":"query","description":"Engine size. Use comma for multiple: 2.0L,3.5L","schema":{"type":"string","default":""}},{"name":"vehicle.transmission","in":"query","description":"Transmission type. Use comma for multiple: automatic,manual","schema":{"type":"string","default":""}},{"name":"vehicle.interiorColor","in":"query","description":"Exterior color. Use comma for multiple: white,black","schema":{"type":"string","default":""}},{"name":"vehicle.exteriorColor","in":"query","description":"Exterior color. Use comma for multiple: white,black","schema":{"type":"string","default":""}},{"name":"vehicle.doors","in":"query","description":"Number of doors (2, 4, 5)","schema":{"type":"integer","default":0}},{"name":"retailListing.price","in":"query","description":"Vehicle price. Use range: 10000-20000","schema":{"type":"string","default":""}},{"name":"retailListing.state","in":"query","description":"State where vehicle is located (e.g., CA)","schema":{"type":"string","default":""}},{"name":"retailListing.miles","in":"query","description":"Vehicle mileage. Use range: 10000-20000","schema":{"type":"string","default":""}},{"name":"retailListing.used","in":"query","description":"Used vs new. `true` for used vehicles, `false` for new.","schema":{"type":"boolean"}},{"name":"retailListing.cpo","in":"query","description":"Certified Pre-Owned flag. `true` filters to CPO listings.","schema":{"type":"boolean"}},{"name":"vehicle.fuel","in":"query","description":"Fuel type. Use comma for multiple: Gasoline,Hybrid,Electric,Plug-In Hybrid,Diesel.","schema":{"type":"string","default":""}},{"name":"zip","in":"query","description":"5-digit ZIP code to center the search around. Pair with `distance` for radius search.","schema":{"type":"string","default":""}},{"name":"distance","in":"query","description":"Radius in miles from the `zip` ZIP code to include in results.","schema":{"type":"integer","default":50}},{"name":"dealerId","in":"query","description":"Dealer ID as returned in `retailListing.dealerId`. Filter by it to return all listings for that dealer. Use comma for multiple.","schema":{"type":"string","default":""}},{"name":"dealerZip","in":"query","description":"ZIP code(s) the dealer is located in. Distinct from the top-level `zip` (buyer-center for radius search). Use comma for multiple.","schema":{"type":"string","default":""}},{"name":"includeUnpriced","in":"query","description":"Opt in to listings with `retailListing.price = null`. Off by default; zero/null-price rows are filtered out unless set to `true`.","schema":{"type":"boolean","default":false}},{"name":"includes","in":"query","description":"Opt-in response extensions. `total` adds `\"total\": <number>` (matching rows ignoring pagination). `facets` adds a `\"facets\": {...}` object with bucketed counts and drill-down URLs per filterable dimension. Pass either or both as a comma-separated list; order is not significant (`?includes=total,facets` and `?includes=facets,total` are equivalent).","style":"form","explode":false,"schema":{"type":"array","items":{"type":"string","enum":["total","facets"]},"uniqueItems":true}},{"name":"select","in":"query","description":"Comma-separated list of field paths to project, e.g. `vehicle.vin,vehicle.year,retailListing.price`. Nested fields require dot notation (`vehicle.vin`, not `vin`); top-level fields without a nested equivalent (`createdAt`, `updatedAt`, `location`) use their bare name. When set, `data[]` rows come back with flat dot-keyed properties (e.g. `\"vehicle.year\": 2025`) rather than the nested objects of the default response. Omit to receive the full default response.","schema":{"type":"string"}},{"name":"vin","in":"query","description":"17-character VIN to filter on as a query parameter. Equivalent to the `/listings/{vin}` path form but returns an array wrapper instead of a single-listing wrapper.","schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response containing vehicle listings","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListingsResponse"},"example":{"data":[{"@id":"https://api.auto.dev/listings/10ARJYBS7RC154562","vin":"10ARJYBS7RC154562","location":[-77.0334,40.2476],"vehicle":{"vin":"10ARJYBS7RC154562","squishVin":"10ARJYBSRC","year":2024,"make":"Jeep","model":"Grand Cherokee","trim":"4xe","drivetrain":"4WD","engine":"Plug-In Hybrid","fuel":"Plug-In Hybrid","transmission":"Automatic","confidence":0.005,"doors":4,"seats":5},"wholesaleListing":null,"retailListing":{"vdp":"https://bergeyschevyplymouthmeeting.com/used/Jeep/2021-Jeep-Grand-Cherokee-7000cb6cac1822f5a3c0cac9ebdee975.htm","price":0,"used":false,"cpo":false,"carfaxUrl":"https://www.carfax.com/VehicleHistory/p/Report.cfx?vin=10ARJYBS7RC154562","dealer":"Faulkner Dodge Ram Mechanicsburg New","city":"Mechanicsburg","state":"PA","zip":"17050","primaryImage":"https://retail.photos.vin/10ARJYBS7RC154562-1.jpg","photoCount":1},"history":null}]}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"429":{"$ref":"#/components/responses/RateLimited"}}}},"/listings/{vin}":{"get":{"tags":["Vehicle Listings"],"summary":"Get Vehicle Listing by VIN","description":"Get a single vehicle listing by VIN. Returns detailed vehicle information, dealership data, specifications, and market pricing for the specified vehicle.","operationId":"getVehicleListingByVin","parameters":[{"name":"vin","in":"path","required":true,"description":"17-character Vehicle Identification Number","schema":{"type":"string","pattern":"^[A-HJ-NPR-Z0-9]{17}$"}}],"responses":{"200":{"description":"Successful response containing single vehicle listing","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SingleListingResponse"},"example":{"data":{"@id":"https://api.auto.dev/listings/10ARJYBS7RC154562","vin":"10ARJYBS7RC154562","location":[-77.0334,40.2476],"vehicle":{"vin":"10ARJYBS7RC154562","squishVin":"10ARJYBSRC","year":2024,"make":"Jeep","model":"Grand Cherokee","trim":"4xe","drivetrain":"4WD","engine":"Plug-In Hybrid","fuel":"Plug-In Hybrid","transmission":"Automatic","confidence":0.005,"doors":4,"seats":5},"wholesaleListing":null,"retailListing":{"vdp":"https://bergeyschevyplymouthmeeting.com/used/Jeep/2021-Jeep-Grand-Cherokee-7000cb6cac1822f5a3c0cac9ebdee975.htm","price":0,"used":false,"cpo":false,"carfaxUrl":"https://www.carfax.com/VehicleHistory/p/Report.cfx?vin=10ARJYBS7RC154562","dealer":"Faulkner Dodge Ram Mechanicsburg New","city":"Mechanicsburg","state":"PA","zip":"17050","primaryImage":"https://retail.photos.vin/10ARJYBS7RC154562-1.jpg","photoCount":1},"history":null}}}}},"400":{"description":"Invalid VIN format","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":{"status":400,"error":"VIN must be exactly 17 characters containing only letters and numbers (excluding I, O, Q)","code":"INVALID_VIN_FORMAT","path":"/listings/137ZA90311E1908","requestId":"979dc9ef5ff3c3a9"}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"description":"VIN not found in listings","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":{"status":404,"error":"Resource \"1FTFW3LDXRFB40317\" not found","code":"RESOURCE_NOT_FOUND","path":"/listings/1FTFW3LDXRFB40317","requestId":"966716ac29ed8147"}}}}},"429":{"$ref":"#/components/responses/RateLimited"}}}},"/example":{"get":{"tags":["Vehicle Listings"],"summary":"Get Example VINs","description":"Up to 10 VINs of real vehicles, sampled from every listing, to use with any VIN-based API. Takes the Vehicle Listings filters (vehicle.year, vehicle.make, vehicle.model, vehicle.trim and the rest); each call starts at a random place among the matching listings. A configuration no listing has answers an empty data.","operationId":"getExampleVins","parameters":[{"name":"vehicle.year","in":"query","required":false,"schema":{"type":"integer"},"description":"Model year, e.g. 2020"},{"name":"vehicle.make","in":"query","required":false,"schema":{"type":"string"},"description":"Make, e.g. Ford"},{"name":"vehicle.model","in":"query","required":false,"schema":{"type":"string"},"description":"Model, e.g. Escape"},{"name":"vehicle.trim","in":"query","required":false,"schema":{"type":"string"},"description":"Trim, e.g. SE"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","default":10,"maximum":10},"description":"Number of VINs, at most 10"}],"responses":{"200":{"description":"Sample VINs","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExampleVinsResponse"},"example":{"data":["https://data.vin/1FMCU0BZ0LUC39490","https://data.vin/1FMCU0BZ6LUC49389","https://data.vin/1FMCU0BZ7LUB44411","https://data.vin/1FMCU0BZ8LUB13510","https://data.vin/1FMCU0DZ0LUB77361","https://data.vin/1FMCU0DZ0LUC51880","https://data.vin/1FMCU0DZ0LUC53032","https://data.vin/1FMCU0DZ3LUC39707","https://data.vin/1FMCU0DZ8LUB66818","https://data.vin/1FMCU0DZ8LUC25222"]}}}},"400":{"description":"A parameter that is not a listings filter (INVALID_PARAMETER)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"},"example":{"error":{"status":400,"error":"Invalid parameter provided: notacolumn. This parameter does not exist in this endpoint.","code":"INVALID_PARAMETER","path":"/example","requestId":"a5986d089dad8c26"}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"429":{"$ref":"#/components/responses/RateLimited"}}}},"/example/new":{"get":{"tags":["Vehicle Listings"],"summary":"Get Example VINs of New Vehicles","description":"Up to 10 VINs of real vehicles, sampled from new vehicles' listings, to use with any VIN-based API. Takes the Vehicle Listings filters (vehicle.year, vehicle.make, vehicle.model, vehicle.trim and the rest); each call starts at a random place among the matching listings. A configuration no listing has answers an empty data.","operationId":"getExampleNewVins","parameters":[{"name":"vehicle.year","in":"query","required":false,"schema":{"type":"integer"},"description":"Model year, e.g. 2020"},{"name":"vehicle.make","in":"query","required":false,"schema":{"type":"string"},"description":"Make, e.g. Ford"},{"name":"vehicle.model","in":"query","required":false,"schema":{"type":"string"},"description":"Model, e.g. Escape"},{"name":"vehicle.trim","in":"query","required":false,"schema":{"type":"string"},"description":"Trim, e.g. SE"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","default":10,"maximum":10},"description":"Number of VINs, at most 10"}],"responses":{"200":{"description":"Sample VINs","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExampleVinsResponse"},"example":{"data":["https://data.vin/2T16CRAV0TC08F856","https://data.vin/2T36CRAV0TC022999","https://data.vin/2T36CRAV0TC054464"]}}}},"400":{"description":"A parameter that is not a listings filter (INVALID_PARAMETER)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"},"example":{"error":{"status":400,"error":"Invalid parameter provided: notacolumn. This parameter does not exist in this endpoint.","code":"INVALID_PARAMETER","path":"/example","requestId":"a5986d089dad8c26"}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"429":{"$ref":"#/components/responses/RateLimited"}}}},"/example/used":{"get":{"tags":["Vehicle Listings"],"summary":"Get Example VINs of Used Vehicles","description":"Up to 10 VINs of real vehicles, sampled from used vehicles' listings, to use with any VIN-based API. Takes the Vehicle Listings filters (vehicle.year, vehicle.make, vehicle.model, vehicle.trim and the rest); each call starts at a random place among the matching listings. A configuration no listing has answers an empty data.","operationId":"getExampleUsedVins","parameters":[{"name":"vehicle.year","in":"query","required":false,"schema":{"type":"integer"},"description":"Model year, e.g. 2020"},{"name":"vehicle.make","in":"query","required":false,"schema":{"type":"string"},"description":"Make, e.g. Ford"},{"name":"vehicle.model","in":"query","required":false,"schema":{"type":"string"},"description":"Model, e.g. Escape"},{"name":"vehicle.trim","in":"query","required":false,"schema":{"type":"string"},"description":"Trim, e.g. SE"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","default":10,"maximum":10},"description":"Number of VINs, at most 10"}],"responses":{"200":{"description":"Sample VINs","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExampleVinsResponse"}}}},"400":{"description":"A parameter that is not a listings filter (INVALID_PARAMETER)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"},"example":{"error":{"status":400,"error":"Invalid parameter provided: notacolumn. This parameter does not exist in this endpoint.","code":"INVALID_PARAMETER","path":"/example","requestId":"a5986d089dad8c26"}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"429":{"$ref":"#/components/responses/RateLimited"}}}},"/example/photos":{"get":{"tags":["Vehicle Listings"],"summary":"Get Example VINs with Photos","description":"Up to 10 VINs of real vehicles, sampled from listings that have photos, to use with any VIN-based API. Takes the Vehicle Listings filters (vehicle.year, vehicle.make, vehicle.model, vehicle.trim and the rest); each call starts at a random place among the matching listings. A configuration no listing has answers an empty data.","operationId":"getExamplePhotoVins","parameters":[{"name":"vehicle.year","in":"query","required":false,"schema":{"type":"integer"},"description":"Model year, e.g. 2020"},{"name":"vehicle.make","in":"query","required":false,"schema":{"type":"string"},"description":"Make, e.g. Ford"},{"name":"vehicle.model","in":"query","required":false,"schema":{"type":"string"},"description":"Model, e.g. Escape"},{"name":"vehicle.trim","in":"query","required":false,"schema":{"type":"string"},"description":"Trim, e.g. SE"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","default":10,"maximum":10},"description":"Number of VINs, at most 10"}],"responses":{"200":{"description":"Sample VINs","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExampleVinsResponse"}}}},"400":{"description":"A parameter that is not a listings filter (INVALID_PARAMETER)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"},"example":{"error":{"status":400,"error":"Invalid parameter provided: notacolumn. This parameter does not exist in this endpoint.","code":"INVALID_PARAMETER","path":"/example","requestId":"a5986d089dad8c26"}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"429":{"$ref":"#/components/responses/RateLimited"}}}},"/incentives/{vin}":{"get":{"tags":["Pricing & Incentives"],"summary":"Get Incentives for a VIN","description":"Current manufacturer incentives on a vehicle's new model in a ZIP code: cash rebates, dealer cash, special APR financing and other offers. For a make, or a make and model, use `GET /incentives?make=…&model=…`.","operationId":"getVehicleIncentives","parameters":[{"name":"vin","in":"path","required":true,"schema":{"type":"string"},"description":"A 17-character VIN, e.g. 3C4NJDCN8RT152187"},{"name":"zip","in":"query","required":false,"schema":{"type":"string"},"description":"US ZIP code the offers apply in; `zipcode` is also accepted. Defaults to the ZIP code of the location the request comes from."}],"responses":{"200":{"description":"Current offers","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IncentivesResponse"},"example":{"vehicle":{"vin":"3C4NJDCN8RT152187","year":2024,"make":"Jeep","model":"Compass","manufacturer":"FCA Mexico S.A. de C.V."},"zip":"90210","data":[{"title":"Other Offers - Employee Pricing","type":"MISCELLANEOUS","category":"OTHER","subcategory":"OTHER","financing":false,"leasing":false,"condition":"new","disclaimer":"Friends of Stellantis employees may be eligible for special pricing.","startDate":"2024-01-03T08:00:00.000Z","endDate":"2027-01-01T07:59:59.999Z"},{"title":"Customer Cash - Adaptive Equipment Allowance","type":"CASH_REBATE","category":"REBATES","subcategory":"CUSTOMERCASH","totalCash":1000,"financing":false,"leasing":false,"condition":"new","disclaimer":"The FCA US Driveability / Automobility Program offers eligible physically challenged (physically disabled) U.S. retail consumers a cash allowance applied to the retail purchase (Type 1 sale), Lease (Type Sale L), or business (Type B or Type E) or 2nd Stage Manufacturer (Type Sale 8) of adaptive driving or passenger equipment installed on a new eligible vehicle. Authorized FCA US LLC dealerships are eligible to apply the cash reimbursement on lowered floor conversions only (a maximum of up to $1,000) to the complete purchase or lease of an eligible adapted vehicle transaction; qualifying the dealer for direct cash allowance reimbursement under this program. Refer to the Authorized Dealer Section of the rules for further definitions, eligibilities and details. Restrictions apply.","startDate":"2024-01-03T08:00:00.000Z","endDate":"2027-01-01T07:59:59.999Z"}]}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"402":{"$ref":"#/components/responses/PlanRequired"},"404":{"description":"No current offers in the ZIP code (RESOURCE_NOT_FOUND)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"},"example":{"error":{"status":404,"error":"No current incentives found in ZIP 90210","code":"RESOURCE_NOT_FOUND","path":"/incentives/1FMCU0G60LUA05025","requestId":"a59869698b0b1d5f"}}}}},"429":{"$ref":"#/components/responses/RateLimited"},"503":{"description":"Incentives cannot be reached right now (SOURCE_ERROR). Retry later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-required-plan":"Growth"}},"/incentives":{"get":{"tags":["Pricing & Incentives"],"summary":"Search Incentives by Make and Model","description":"Current manufacturer incentives on new vehicles of a make, or of a make and model, in a ZIP code: cash rebates, dealer cash, special APR financing and other offers, each labelled with its year, make and model. Without `model`, the offers on every model of the make on sale.","operationId":"searchIncentives","parameters":[{"name":"make","in":"query","required":true,"schema":{"type":"string"},"description":"Make, e.g. Toyota"},{"name":"model","in":"query","required":false,"schema":{"type":"string"},"description":"Model, e.g. RAV4. Without it, every model of the make."},{"name":"zip","in":"query","required":false,"schema":{"type":"string"},"description":"US ZIP code the offers apply in; `zipcode` is also accepted. Defaults to the ZIP code of the location the request comes from."},{"name":"year","in":"query","required":false,"schema":{"type":"integer"},"description":"Model year. Without it, offers cover last year, this year and next year."}],"responses":{"200":{"description":"Current offers","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IncentivesResponse"},"example":{"zip":"90210","data":[{"year":"2026","make":"Toyota","model":"RAV4","title":"Customer APR - Special APR","type":"LOW_APR","category":"FINANCING","subcategory":"ALL","apr":4.99,"term":24,"creditTier":"Tier 1","creditScoreMin":720,"creditScoreMax":899,"financing":true,"leasing":false,"condition":"new","description":"4.99% APR financing for 24 months at $43.87 per month, per $1,000 financed. 4.99% APR financing for 36 months at $29.97 per month, per $1,000 financed. 4.99% APR financing for 48 months at $23.03 per month, per $1,000 financed. 5.99% APR financing for 60 months at $19.33 per month, per $1,000 financed. 6.99% APR financing for 72 months at $17.05 per month, per $1,000 financed.","disclaimer":"Program eligibility based on credit approval. Not all customers will qualify. Offer requires financing with TFS.","startDate":"2026-11-03T08:00:00.000Z","endDate":"2026-12-01T07:59:59.999Z"},{"year":"2026","make":"Toyota","model":"RAV4","title":"Customer APR - Special APR","type":"LOW_APR","category":"FINANCING","subcategory":"ALL","apr":4.99,"term":36,"creditTier":"Tier 1","creditScoreMin":720,"creditScoreMax":899,"financing":true,"leasing":false,"condition":"new","description":"4.99% APR financing for 24 months at $43.87 per month, per $1,000 financed. 4.99% APR financing for 36 months at $29.97 per month, per $1,000 financed. 4.99% APR financing for 48 months at $23.03 per month, per $1,000 financed. 5.99% APR financing for 60 months at $19.33 per month, per $1,000 financed. 6.99% APR financing for 72 months at $17.05 per month, per $1,000 financed.","disclaimer":"Program eligibility based on credit approval. Not all customers will qualify. Offer requires financing with TFS.","startDate":"2026-11-03T08:00:00.000Z","endDate":"2026-12-01T07:59:59.999Z"}]}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"402":{"$ref":"#/components/responses/PlanRequired"},"404":{"description":"No current offers for the make, or make and model, in the ZIP code (RESOURCE_NOT_FOUND)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"},"example":{"error":{"status":404,"error":"No current incentives found for Toyota NotAModel in ZIP 90210","code":"RESOURCE_NOT_FOUND","path":"/incentives","requestId":"a5987798988e7a92"}}}}},"429":{"$ref":"#/components/responses/RateLimited"},"503":{"description":"Incentives cannot be reached right now (SOURCE_ERROR). Retry later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-required-plan":"Growth"}},"/dealers/search":{"get":{"tags":["Dealers"],"summary":"Search Dealers","description":"Dealers that match the filters, most recently seen first, from the dealers seen in vehicle listings. At least one of name, domain, zip, state or make is required.","operationId":"searchDealers","parameters":[{"name":"name","in":"query","required":false,"schema":{"type":"string"},"description":"Dealer name, or part of it; case-insensitive"},{"name":"domain","in":"query","required":false,"schema":{"type":"string"},"description":"Dealer website domain, e.g. austinsubaru.com"},{"name":"zip","in":"query","required":false,"schema":{"type":"string"},"description":"US ZIP code"},{"name":"radius","in":"query","required":false,"schema":{"type":"number"},"description":"Miles around `zip`; needs `zip`"},{"name":"state","in":"query","required":false,"schema":{"type":"string"},"description":"Two-letter state code"},{"name":"make","in":"query","required":false,"schema":{"type":"string"},"description":"Dealers with at least one current listing of this make"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","default":50,"maximum":200},"description":"Results per page"},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","default":0},"description":"Results to skip"}],"responses":{"200":{"description":"Matching dealers","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DealerSearchResponse"},"example":{"data":[{"id":"d_0050e3915c8f3cdf","name":"Austin Subaru","phone":"+15123232837","website":"austinsubaru.com","domain":"austinsubaru.com","street":"8100 Burnet Rd","city":"Austin","state":"TX","zip":"78757","country":"US","lat":30.36,"lon":-97.731,"lastSeen":"2026-11-12 21:00:41.815","listings":"https://api.auto.dev/listings?dealerId=d_0050e3915c8f3cdf"},{"id":"d_919fb2028afae889","name":"Austin Subaru","phone":"+15129579938","website":null,"domain":null,"street":null,"city":"Austin","state":"TX","zip":null,"country":null,"lat":null,"lon":null,"lastSeen":"2026-11-12 06:23:58.915","listings":null}],"total":10,"limit":50,"offset":0}}}},"400":{"description":"No filter given (MISSING_FILTER), `radius` without `zip` (MISSING_ZIP), a ZIP code with no location on file (UNKNOWN_ZIP), or a parameter that is not a filter (INVALID_PARAMETER)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"},"example":{"error":{"status":400,"error":"At least one of name, domain, zip, state, make is required.","code":"MISSING_FILTER","path":"/dealers/search","requestId":"a5986bdc6d74b33c"}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"402":{"$ref":"#/components/responses/PlanRequired"},"429":{"$ref":"#/components/responses/RateLimited"},"503":{"description":"Dealer search cannot be reached right now (SOURCE_ERROR). Retry later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-required-plan":"Growth"}},"/dealers/{id}":{"get":{"tags":["Dealers"],"summary":"Get Dealer","description":"One dealer: contact details, location, and inventory, price and days-on-market statistics from its active listings. An id that was retired (merged into another dealer) redirects to the dealer's current id.","operationId":"getDealer","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"},"description":"Dealer id, e.g. d_0050e3915c8f3cdf, from /dealers/search"}],"responses":{"200":{"description":"The dealer","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DealerResponse"},"example":{"data":{"id":"d_0050e3915c8f3cdf","name":"Austin Subaru","dealerGroupName":null,"phone":"+15123232837","website":"austinsubaru.com","email":null,"street":"8100 Burnet Rd","city":"Austin","state":"TX","zip":"78757","country":"US","lat":30.36,"lon":-97.731,"metro":"640","totalInventory":609,"newInventory":445,"usedInventory":164,"avgNewPrice":39643,"avgUsedPrice":26172,"avgDom":22.03,"avgDomNew":21.54,"avgDomUsed":23.37,"avgUsedMileage":51443}}}}},"308":{"description":"A retired dealer id. Location is the same request with the id that replaced it.","headers":{"Location":{"description":"The URL with the current dealer id","schema":{"type":"string"}},"X-Dealer-Id-Retired":{"description":"The retired id","schema":{"type":"string"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"402":{"$ref":"#/components/responses/PlanRequired"},"404":{"description":"No dealer with this id (RESOURCE_NOT_FOUND)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"},"example":{"error":{"status":404,"error":"Resource \"d_0000000000000000\" not found","code":"RESOURCE_NOT_FOUND","path":"/dealers/d_0000000000000000","requestId":"a5986bd59d0945a4"}}}}},"429":{"$ref":"#/components/responses/RateLimited"}},"x-required-plan":"Growth"}},"/specs/{vin}":{"get":{"summary":"Get Vehicle Specifications","description":"Get detailed vehicle specifications including engine details, features, measurements, colors, options, and complete technical data for any vehicle by VIN.","parameters":[{"name":"vin","in":"path","required":true,"schema":{"type":"string","pattern":"^[A-HJ-NPR-Z0-9]{17}$"},"description":"17-character Vehicle Identification Number"},{"$ref":"#/components/parameters/Ambiguity"}],"responses":{"200":{"description":"Successfully retrieved vehicle specifications","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VehicleSpecsResponse"},"example":{"vehicle":{"vin":"1FTFW3LDXRFB40317","year":2019,"make":"Porsche","model":"911","manufacturer":"Dr Ing HCF Porsch Ag"},"specs":{"name":"GT3 RS 2dr Coupe (4.0L 6cyl 7AM)","price":{"baseMsrp":187500,"baseInvoice":168750},"totalSeating":2,"color":{"exterior":[{"name":"Lizard Green","rgb":"87,178,44"},{"name":"Miami Blue","rgb":"3,161,192"},{"name":"Racing Yellow","rgb":"229,200,38"},{"name":"Guards Red","rgb":"175,26,28"}],"interior":[{"name":"Black, leather/sueded microfiber","rgb":"0,0,0"},{"name":"Black/Lizard Green, leather/sueded microfiber","rgb":"0,0,0"}]},"features":{"engine":{"torque":"346 lb-ft @ 6000 rpm","baseEngineSize":"4.0 L","horsepower":"520 hp @ 8250 rpm","valves":"24","baseEngineType":"gas","directInjection":true,"valveTiming":"Variable","cylinders":"flat 6","camType":"Double overhead cam (DOHC)"},"fuel":{"epaCombinedMpg":"16 MPG","epaCity/highwayMpg":"15/19 MPG","rangeInMiles (city/hwy)":"253.5/321.1 mi.","fuelTankCapacity":"16.9 gal.","fuelType":"premium unleaded (required)"},"measurements":{"maximumCargoCapacity":"4.4 cu.ft.","countryOfFinalAssembly":"Germany","wheelbase":"96.6 in.","curbWeight":"3153 lbs.","grossWeight":"3953 lbs.","cargoCapacity,AllSeatsInPlace":"4.4 cu.ft.","maximumPayload":"800 lbs.","overallWidthWithMirrors":"77.9 in.","length":"179.4 in.","manufacturer060MphAccelerationTime":"3.0 seconds","turningCircle":"36.4 ft.","height":"51.1 in.","overallWidthWithoutMirrors":"74.0 in."},"driveTrain":{"driveType":"rear wheel drive","rearLockingDifferential":true,"rearLimitedSlipDifferential":true,"transmission":"7-speed automated manual"},"warranty":{"basic":"4 yr./ 50000 mi.","drivetrain":"4 yr./ 50000 mi.","freeMaintenance":"1 yr./ 10000 mi.","rust":"12 yr./ unlimited mi.","roadsideAssistance":"4 yr./ 50000 mi."},"safety":{"4WheelAbs":true,"daytimeRunningLights":true,"engineImmobilizer":true,"postCollisionSafetySystem":true,"frontHeadAirbags":true,"dualFrontSideMountedAirbags":true,"passengerAirbagOccupantSensingDeactivation":true,"stabilityControl":true,"tirePressureMonitoring":true,"tractionControl":true},"frontseats":{"heightAdjustablePassengerSeat":true,"heightAdjustableDriverSeat":true,"sportFrontSeats":true,"2WayPowerPassengerSeat":true,"leather/suededMicrofiber":true,"2WayPowerDriverSeat":true}},"orderedFeatures":[{"category":"Fuel","categoryGroup":"Mechanical","features":{"fuelType":"Premium unleaded (required)","epaCity/highwayMpg":"15/19 MPG","epaCombinedMpg":"16 MPG","rangeInMiles (city/hwy)":"253.5/321.1 mi.","fuelTankCapacity":"16.9 gal."}},{"category":"Engine","categoryGroup":"Mechanical","features":{"baseEngineSize":"4.0 L","cylinders":"Flat 6","baseEngineType":"Gas","horsepower":"520 hp @ 8250 rpm","torque":"346 lb-ft @ 6000 rpm","valves":"24","camType":"Double overhead cam (DOHC)","valveTiming":"Variable","directInjection":true}}],"typeCategories":{"performancesports":{"id":10,"name":"Performance/Sports"},"coupe":{"id":2,"name":"Coupe"},"luxury":{"id":8,"name":"Luxury"}},"styleAttributes":{"electric":false,"pluginElectric":false,"truck":false}}}}}},"207":{"description":"Partial answer: the vehicle is named but the sources hold only some of the documented `specs` fields. The held fields are as on a 200, every other one is null and listed in `missing`; `reason` says why. A VIN that matches more than one style is a 207 too (`ambiguous`, reason `ambiguous_style`): `specs` holds each field every one of its styles shares, and trims and styles list them. Not an error, not billed. Branch on the status, or check `missing`, before reading `specs`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VehicleSpecsPartialResponse"},"examples":{"partial":{"summary":"A motorcycle: the fields a source holds (class_not_covered)","value":{"vehicle":{"vin":"1HD1BWV10GB016330","year":2016,"make":"HARLEY-DAVIDSON","model":"FLSTC103 / Heritage Softail Classic","manufacturer":"Harley-Davidson Motor Co"},"specs":{"name":"2016 HARLEY-DAVIDSON Heritage Softail Classic FLSTC103","price":null,"totalSeating":null,"color":null,"typeCategories":null,"styleAttributes":null,"orderedFeatures":null,"features":{"engine":{"torque":"","baseEngineSize":"1.69L","horsepower":"","valves":"","baseEngineType":"Gasoline","directInjection":false,"valveTiming":"","cylinders":"2","camType":""},"fuel":{"epaCombinedMpg":"","epaCityHighwayMpg":"","rangeInMilesCityHwy":"","fuelTankCapacity":"","fuelType":"Gasoline"},"driveTrain":{"driveType":"","centerLimitedSlipDifferential":false,"transmission":""},"measurements":{"maximumCargoCapacity":"","countryOfFinalAssembly":"UNITED STATES (USA)","wheelbase":"","curbWeight":"","grossWeight":"Class 1A: 3,000 lb or less (1,360 kg or less)","cargoCapacityAllSeatsInPlace":"","maximumPayload":"","length":"","maximumTowingCapacity":"","turningCircle":"","height":"","overallWidthWithoutMirrors":""},"frontseats":{"frontHeadRoom":"","premiumCloth":false,"bucketFrontSeats":false,"the4WayManualPassengerSeatAdjustment":false,"heightAdjustableDriverSeat":false,"frontShoulderRoom":"","driverSeatWithPowerAdjustableLumbarSupport":false,"the8WayPowerDriverSeat":false,"frontLegRoom":"","frontHipRoom":""},"rearseats":{},"warranty":{"basic":"","drivetrain":"","freeMaintenance":"","rust":"","roadsideAssistance":""},"suspension":{},"tiresAndWheels":{},"powerFeature":{},"mechanicalOptions":{},"comfortConvenience":{},"exteriorOptions":{},"interiorOptions":{},"instrumentation":{"clock":false,"compass":false,"externalTemperatureDisplay":false,"tripComputer":false,"tachometer":false},"inCarEntertainment":{},"packages":{},"telematics":{},"safety":{}}},"missing":[{"field":"price","reason":"no_vin_record"},{"field":"totalSeating","reason":"no_vin_record"},{"field":"color","reason":"no_vin_record"},{"field":"typeCategories","reason":"no_vin_record"},{"field":"styleAttributes","reason":"no_vin_record"},{"field":"orderedFeatures","reason":"no_vin_record"}],"reason":"class_not_covered","retryable":false}},"ambiguous":{"summary":"A VIN that matches two styles: the fields both share (ambiguous_style), recorded 2026-11-18","value":{"vehicle":{"vin":"KMHL64JA4PA269788","year":2023,"make":"Hyundai","model":"Sonata","manufacturer":"Hyundai Motor Co"},"ambiguous":true,"specs":{"name":null,"price":null,"totalSeating":5,"color":{"exterior":[{"name":"Carbon Blue","rgb":"7,38,85"},{"name":"Portofino Gray","rgb":"89,97,100"},{"name":"Hampton Gray","rgb":"70,76,78"}],"interior":[{"name":"Black, cloth","rgb":"44,45,49"},{"name":"Dark Gray, cloth","rgb":"142,144,148"}]},"typeCategories":{"sedan":{"id":11,"name":"Sedan"}},"styleAttributes":null,"orderedFeatures":[{"category":"Fuel","categoryGroup":"Mechanical","features":{"fuelType":"Regular unleaded","epaCity/highwayMpg":"27/37 MPG","epaCombinedMpg":"31 MPG","rangeInMiles (city/hwy)":"429.3/588.3 mi.","fuelTankCapacity":"15.9 gal."}}],"features":{"measurements":{"length":"192.9 in.","wheelbase":"111.8 in.","curbWeight":"3192 lbs.","grossWeight":"4354 lbs.","cargoCapacity,AllSeatsInPlace":"16.0 cu.ft.","turningCircle":"35.9 ft.","groundClearance":"5.3 in.","height":"56.9 in.","epaInteriorVolume":"120.4 cu.ft.","maximumPayload":"1162 lbs.","overallWidthWithoutMirrors":"73.2 in."},"driveTrain":{"driveType":"front wheel drive","transmission":"8-speed shiftable automatic"},"engine":{"torque":"181 lb-ft @ 4000 rpm","baseEngineSize":"2.5 L","horsepower":"191 hp @ 6100 rpm","valves":"16","dualFuelInjection":true,"baseEngineType":"gas","valveTiming":"Variable","cylinders":"inline 4","camType":"Double overhead cam (DOHC)"}}},"missing":[{"field":"name","reason":"no_vin_record"},{"field":"price","reason":"no_vin_record"},{"field":"styleAttributes","reason":"no_vin_record"}],"trims":["SEL"],"styles":[{"name":"SEL 4dr Sedan (2.5L 4cyl 8A)","trim":"SEL","confidence":0.5},{"name":"SEL 4dr Sedan w/Prod. End 11/22 (2.5L 4cyl 8A)","trim":"SEL","confidence":0.5}],"reason":"ambiguous_style","retryable":false}}}}}},"400":{"description":"Invalid VIN format","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"status":400,"error":"VIN must be 17 characters long","code":"INVALID_VIN_FORMAT","path":"/specs/123Invalid","requestId":"966d9900bef4356c-IAD"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"402":{"$ref":"#/components/responses/PlanRequired"},"404":{"description":"Vehicle not found or no specifications available","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"status":404,"error":"No vehicle data found for the provided VIN","code":"VIN_NOT_FOUND","path":"/specs/1FTFW3LDXRFB40317","requestId":"f8g7h6i5j4k3l2m1"}}}},"429":{"$ref":"#/components/responses/RateLimited"}},"tags":["Vehicle Information"],"operationId":"getVehicleSpecifications","x-required-plan":"Growth"}},"/recalls/{vin}":{"get":{"summary":"Get Vehicle Recalls","description":"Get comprehensive vehicle recall information for a VIN. Access detailed recall notices, safety information, remediation steps, and compliance data for any vehicle. `internationalRecalls` also lists the recalls issued for the vehicle's make and model in the UK, the Netherlands, France, the EU, Germany and Canada, unless the request has `international=false`.","parameters":[{"name":"vin","in":"path","required":true,"schema":{"type":"string","pattern":"^[A-HJ-NPR-Z0-9]{17}$"},"description":"17-character Vehicle Identification Number"},{"name":"international","in":"query","required":false,"schema":{"type":"string","enum":["true","false"],"default":"true"},"description":"Whether `internationalRecalls` lists the recalls issued in the UK, the Netherlands, France, the EU, Germany and Canada for the vehicle's make and model. On by default. With `false` (`0` and `no` also work, in any case), `internationalRecalls` is an empty array, `internationalRecallCount` is 0 and no overseas catalog is asked. The list has each recall once per region, at most 100 per region. The UK, Germany and Canada say which years a recall covers, so their lists hold only the recalls that can cover the vehicle's model year; the Netherlands, France and the EU do not, so theirs cover the model in any year. They are matched by make and model, not by VIN, so a listed recall may not apply to this vehicle."}],"responses":{"200":{"description":"Successfully retrieved vehicle recalls (may be empty array if no recalls)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VehicleRecallsResponse"},"example":{"data":[{"manufacturer":"Porsche Cars North America, Inc.","nhtsaCampaignNumber":"21V201000","parkIt":false,"parkOutSide":false,"overTheAirUpdate":false,"reportReceivedDate":"24/03/2021","component":"SUSPENSION:REAR","summary":"Porsche Cars North America, Inc. (Porsche) is recalling certain 2019 Porsche 911 Speedster, 2020 Porsche 911 Carrera S Coupe, Carrera 4S Coupe, and Carrera S Cabriolet vehicles. The screw connection on the rear axle upper control arm may be loose.","consequence":"A loose connection may fail, causing driving instability and increasing the risk of a crash.","remedy":"Porsche will notify owners, and dealers will rework and tighten the screw connection on the rear axle upper control arm, free of charge. Owner notification letters were mailed May 21, 2021. Owners may contact Porsche customer service at 1-800-767-7243. Porsche's number for this recall is AMA6.","notes":"Owners may also contact the National Highway Traffic Safety Administration Vehicle Safety Hotline at 1-888-327-4236 (TTY 1-800-424-9153), or go to www.safercar.gov.","modelYear":"2019","make":"PORSCHE","model":"911"}],"totalRecalls":1,"internationalRecalls":[{"region":"UK","recall_number":"R/2021/126","launch_date":"2021-03-24","make":"PORSCHE","model":"911 CARRERA","model_info":"911 CARRERA","concern":"THE THREADED CONNECTIONS OF THE UPPER CONTROL ARMS AT THE REAR AXLE WERE NOT TIGHTENED WITH THE SPECIFIC TIGTENING TORQUE","defect":"Threaded connections of the upper control arms at the rear axle may not be tightened with the specified tightening torque.","remedy":"The chassis bolts will be replaced and tightened with the specified tightening torque.","vehicle_numbers":"2"}],"internationalRecallCount":1}}}},"400":{"description":"Invalid VIN format","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"status":400,"error":"VIN must be exactly 17 characters containing only letters and numbers (excluding I, O, Q)","code":"INVALID_VIN_FORMAT","path":"/recalls/1GYKPD","requestId":"a1b2c3d4e5f6g7h8"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"402":{"$ref":"#/components/responses/PlanRequired"},"429":{"$ref":"#/components/responses/RateLimited"}},"tags":["Safety & Recalls"],"operationId":"getVehicleRecalls","x-required-plan":"Growth"}},"/recalls/bulk":{"post":{"summary":"Get Vehicle Recalls in Bulk","description":"Look up many VINs in one call. The answer holds one item per VIN, in the order sent: exactly what `GET /recalls/{vin}` answers for that VIN, plus `vin` and `statusCode`. The call itself is 200 whenever it ran; a VIN that could not be answered is an item with its own error status, and is listed in `bulk.retry` when sending it again may help. There is no limit on how many VINs. A large list takes longer, about as fast as the Growth plan's requests per second allow, and the connection stays open until every VIN is answered. Each VIN answered with a 2xx counts as one `GET /recalls/{vin}` call, once per VIN per day; the bulk call itself is not counted.","operationId":"bulkVehicleRecalls","tags":["Safety & Recalls"],"parameters":[{"name":"international","in":"query","required":false,"schema":{"type":"string","enum":["true","false"],"default":"true"},"description":"As on `GET /recalls/{vin}`, for every VIN."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["vins"],"properties":{"vins":{"description":"The VINs to look up: a list, or one string with the VINs separated by commas, spaces or new lines. Each VIN is answered once, in the order sent. There is no limit on how many.","oneOf":[{"type":"array","items":{"type":"string"}},{"type":"string"}]}}},"example":{"vins":["1FMUK7DHXSGA27345","5YJ3E1EA7KF317000"]}}}},"responses":{"200":{"description":"Every VIN answered","content":{"application/json":{"schema":{"type":"object","properties":{"bulk":{"type":"object","description":"Counts for the whole call.","properties":{"id":{"type":"string","description":"This call, as each VIN's usage row names it (`bulk=` in its query)"},"endpoint":{"type":"string","enum":["recalls","openrecalls","vin","specs","build"]},"requested":{"type":"number","description":"VINs asked, each once"},"answered":{"type":"number","description":"VINs answered with a 2xx: the VINs billed"},"failed":{"type":"number","description":"VINs answered with an error"},"byStatus":{"type":"object","additionalProperties":{"type":"number"},"description":"VINs per status"},"retry":{"type":"array","items":{"type":"string"},"description":"The VINs worth sending again: those answered 429 (but a monthly quota's) or 5xx"},"ms":{"type":"number","description":"Time taken, in milliseconds"}}},"results":{"type":"array","items":{"description":"One VIN: the answer the single-VIN endpoint gives for it (its `api`, `links`, `user` and `examples` blocks left out), with `vin` and `statusCode`, the status that call would have had. An error item carries `error`, and `retryAfter` (seconds) where that call would have sent a Retry-After header.","allOf":[{"type":"object","required":["vin","statusCode"],"properties":{"vin":{"type":"string"},"statusCode":{"type":"number","description":"The status the single-VIN call would have answered"},"retryAfter":{"type":"number","description":"Seconds to wait before asking this VIN again"}}},{"anyOf":[{"$ref":"#/components/schemas/VehicleRecallsResponse"},{"$ref":"#/components/schemas/ErrorEnvelope"}]}]}}}},"example":{"bulk":{"id":"6f1c0d52-3a4e-4a8e-9a43-0c4b0d1f2e3a","endpoint":"recalls","requested":2,"answered":1,"failed":1,"byStatus":{"200":1,"400":1},"retry":[],"ms":812},"results":[{"vin":"1FMUK7DHXSGA27345","statusCode":200,"data":[],"totalRecalls":0,"internationalRecalls":[],"internationalRecallCount":0},{"vin":"1FMUK7DHXSGA2734","statusCode":400,"error":{"status":400,"error":"VIN must be exactly 17 characters containing only letters and numbers (excluding I, O, Q)","code":"INVALID_VIN_FORMAT","path":"/recalls/1FMUK7DHXSGA2734","requestId":"a1b2c3d4e5f6g7h8"}}]}}}},"400":{"description":"The body names no VIN","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"},"example":{"error":{"status":400,"error":"Send {\"vins\": [\"VIN1\", \"VIN2\", ...]}.","code":"BULK_BODY_INVALID","path":"/openrecalls/bulk","requestId":"a1b2c3d4e5f6g7h8"}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"402":{"$ref":"#/components/responses/PlanRequired"},"429":{"$ref":"#/components/responses/RateLimited"}},"x-required-plan":"Growth"}},"/openrecalls/bulk":{"post":{"summary":"Get Open Recalls in Bulk","description":"Look up many VINs in one call. The answer holds one item per VIN, in the order sent: exactly what `GET /openrecalls/{vin}` answers for that VIN, plus `vin` and `statusCode`. The call itself is 200 whenever it ran; a VIN that could not be answered is an item with its own error status, and is listed in `bulk.retry` when sending it again may help. There is no limit on how many VINs. A large list takes longer, about as fast as the Scale plan's requests per second allow, and the connection stays open until every VIN is answered. Each VIN answered with a 2xx counts as one `GET /openrecalls/{vin}` call, once per VIN per day; the bulk call itself is not counted.","operationId":"bulkOpenRecalls","tags":["Safety & Recalls"],"parameters":[{"name":"recalls","in":"query","required":false,"schema":{"type":"string","enum":["true","false"]},"description":"As on `GET /openrecalls/{vin}`, for every VIN."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["vins"],"properties":{"vins":{"description":"The VINs to look up: a list, or one string with the VINs separated by commas, spaces or new lines. Each VIN is answered once, in the order sent. There is no limit on how many.","oneOf":[{"type":"array","items":{"type":"string"}},{"type":"string"}]}}},"example":{"vins":["1FMUK7DHXSGA27345","5YJ3E1EA7KF317000"]}}}},"responses":{"200":{"description":"Every VIN answered","content":{"application/json":{"schema":{"type":"object","properties":{"bulk":{"type":"object","description":"Counts for the whole call.","properties":{"id":{"type":"string","description":"This call, as each VIN's usage row names it (`bulk=` in its query)"},"endpoint":{"type":"string","enum":["recalls","openrecalls","vin","specs","build"]},"requested":{"type":"number","description":"VINs asked, each once"},"answered":{"type":"number","description":"VINs answered with a 2xx: the VINs billed"},"failed":{"type":"number","description":"VINs answered with an error"},"byStatus":{"type":"object","additionalProperties":{"type":"number"},"description":"VINs per status"},"retry":{"type":"array","items":{"type":"string"},"description":"The VINs worth sending again: those answered 429 (but a monthly quota's) or 5xx"},"ms":{"type":"number","description":"Time taken, in milliseconds"}}},"results":{"type":"array","items":{"description":"One VIN: the answer the single-VIN endpoint gives for it (its `api`, `links`, `user` and `examples` blocks left out), with `vin` and `statusCode`, the status that call would have had. An error item carries `error`, and `retryAfter` (seconds) where that call would have sent a Retry-After header.","allOf":[{"type":"object","required":["vin","statusCode"],"properties":{"vin":{"type":"string"},"statusCode":{"type":"number","description":"The status the single-VIN call would have answered"},"retryAfter":{"type":"number","description":"Seconds to wait before asking this VIN again"}}},{"anyOf":[{"$ref":"#/components/schemas/OpenRecallsResponse"},{"$ref":"#/components/schemas/ErrorEnvelope"}]}]}}}},"example":{"bulk":{"id":"6f1c0d52-3a4e-4a8e-9a43-0c4b0d1f2e3a","endpoint":"openrecalls","requested":2,"answered":1,"failed":1,"byStatus":{"200":1,"503":1},"retry":["5YJ3E1EA7KF317000"],"ms":21480},"results":[{"vin":"1FMUK7DHXSGA27345","statusCode":200,"vehicle":{"year":2025,"make":"Ford","model":"Explorer","vin":"1FMUK7DHXSGA27345"},"retrievedAt":"2026-11-18T19:00:00.000Z","status":"No Open Recalls","openRecalls":0,"totalRecalls":3,"data":[]},{"vin":"5YJ3E1EA7KF317000","statusCode":503,"error":{"status":503,"error":"Recall information is temporarily unavailable. Please retry shortly.","code":"RECALLS_UNAVAILABLE","path":"/openrecalls/5YJ3E1EA7KF317000","requestId":"a1b2c3d4e5f6g7h8"},"retryAfter":30}]}}}},"400":{"description":"The body names no VIN","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"},"example":{"error":{"status":400,"error":"Send {\"vins\": [\"VIN1\", \"VIN2\", ...]}.","code":"BULK_BODY_INVALID","path":"/openrecalls/bulk","requestId":"a1b2c3d4e5f6g7h8"}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"402":{"$ref":"#/components/responses/PlanRequired"},"429":{"$ref":"#/components/responses/RateLimited"}},"x-required-plan":"Scale"}},"/tco/{vin}":{"get":{"summary":"Get Total Cost of Ownership","description":"Calculate comprehensive Total Cost of Ownership (TCO) for any vehicle over a 5-year period. Get detailed breakdowns of all ownership costs including depreciation, fuel, maintenance, repairs, insurance, taxes, and financing.","parameters":[{"name":"vin","in":"path","required":true,"schema":{"type":"string","pattern":"^[A-HJ-NPR-Z0-9]{17}$"},"description":"17-character Vehicle Identification Number"},{"name":"zip","in":"query","required":false,"schema":{"type":"string","pattern":"^[0-9]{5}(-[0-9]{4})?$"},"description":"5-digit ZIP code for location-based calculations (insurance, taxes, fees)"},{"name":"fromZip","in":"query","required":false,"schema":{"type":"string","pattern":"^[0-9]{5}(-[0-9]{4})?$"},"description":"5-digit ZIP code for delivery/transport calculations"}],"responses":{"200":{"description":"Successfully retrieved total cost of ownership analysis","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TotalCostOwnershipResponse"},"example":{"vehicle":{"vin":"1FTFW3LDXRFB40317","year":2019,"make":"Porsche","model":"911","manufacturer":"Dr Ing HCF Porsch Ag"},"zip":"90210","tco":{"total":{"federalTaxCredit":0,"insurance":12110,"maintenance":13788,"repairs":11874,"taxesAndFees":12164,"financeInterest":20657,"depreciation":44236,"fuel":25000,"tcoPrice":139829,"averageCostPerMile":1.86},"years":{"1":{"insurance":2281,"maintenance":2006,"repairs":2038,"taxesAndFees":9728,"financeInterest":7077,"depreciation":13474,"fuel":4709,"tcoPrice":41313,"averageCostPerMile":1.86},"2":{"insurance":2349,"maintenance":147,"repairs":2195,"taxesAndFees":684,"financeInterest":5710,"depreciation":7566,"fuel":4850,"tcoPrice":23501,"averageCostPerMile":1.86},"3":{"insurance":2420,"maintenance":6898,"repairs":2364,"taxesAndFees":635,"financeInterest":4241,"depreciation":8510,"fuel":4996,"tcoPrice":30064,"averageCostPerMile":1.86},"4":{"insurance":2493,"maintenance":694,"repairs":2543,"taxesAndFees":579,"financeInterest":2663,"depreciation":6296,"fuel":5145,"tcoPrice":20413,"averageCostPerMile":1.86},"5":{"insurance":2567,"maintenance":4043,"repairs":2734,"taxesAndFees":538,"financeInterest":966,"depreciation":8390,"fuel":5300,"tcoPrice":24538,"averageCostPerMile":1.86}}}}}}},"400":{"description":"Invalid VIN format or ZIP code","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"status":400,"error":"VIN must be exactly 17 characters","code":"INVALID_VIN_FORMAT","path":"/tco/123Invalid","requestId":"a1b2c3d4e5f6g7h8"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"402":{"$ref":"#/components/responses/PlanRequired"},"429":{"$ref":"#/components/responses/RateLimited"}},"tags":["Financial Calculations"],"operationId":"getTotalCostOfOwnership","x-required-plan":"Growth"}},"/payments/{vin}":{"get":{"summary":"Get Vehicle Payment Calculations","description":"Calculate detailed vehicle payment information including loan amounts, monthly payments, taxes, fees, and complete cost breakdowns. Get accurate financing estimates based on vehicle details, purchase price, location, and loan terms.","parameters":[{"name":"vin","in":"path","required":true,"schema":{"type":"string","pattern":"^[A-HJ-NPR-Z0-9]{17}$"},"description":"17-character Vehicle Identification Number"},{"name":"price","in":"query","required":false,"schema":{"type":"number"},"description":"Vehicle sales price. Defaults to the vehicle's estimated used retail value, else 25000"},{"name":"zip","in":"query","required":false,"schema":{"type":"string","pattern":"^[0-9]{5}(-[0-9]{4})?$"},"description":"5-digit ZIP code for tax, fee and rate calculations. Defaults to your account ZIP code, else 94020"},{"name":"docFee","in":"query","required":false,"schema":{"type":"number","default":200},"description":"Dealer documentation fee"},{"name":"tradeIn","in":"query","required":false,"schema":{"type":"number","default":0},"description":"Trade-in vehicle value"},{"name":"downPayment","in":"query","required":false,"schema":{"type":"number","default":0},"description":"Down payment amount"},{"name":"loanTerm","in":"query","required":false,"schema":{"type":"number","default":72},"description":"Loan term in months (`term` is accepted too). Rates are quoted for 36, 48, 60, 72 and 84 months; for any other term, pass interestRate"},{"name":"creditScore","in":"query","required":false,"schema":{"type":"string","default":"750"},"description":"Borrower credit score, used to quote the interest rate"},{"name":"interestRate","in":"query","required":false,"schema":{"type":"number"},"description":"Annual interest rate (APR, %) to price the loan at, instead of the quoted rate for the term. Quoted rates are used-auto loan rates; for an RV, motorcycle or other non-car loan, pass your lender's rate"}],"responses":{"200":{"description":"Successfully calculated vehicle payment information","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VehiclePaymentsResponse"},"example":{"vehicle":{"vin":"1C4RJFAG0FC625797","year":2015,"make":"Jeep","model":"Grand Cherokee"},"criteria":{"price":"25000","zip":"55414","docFee":200,"tradeIn":"0"},"paymentsData":{"loanAmount":21952.49,"loanMonthlyPayment":363.83,"loanMonthlyPaymentWithTaxes":399.35,"totalTaxesAndFees":1952.49,"taxes":{"combinedSalesTax":1625,"stateSalesTax":1625,"gasGuzzlerTax":0},"fees":{"titleFee":8.25,"registrationFee":70.99,"dmvFee":48.25,"combinedFees":327.49,"docFee":200,"dmvFees":{"Filing Fee":7,"License Plate Fee":15.5,"Public Safety Vehicle Fee":3.5,"Technology Fee":2.25,"Wheelage Tax":20}},"calculationCriteria":{"numberOfMonths":60,"financeRate":3.5,"downPayment":5000,"tradeIn":0,"tradeInOwedAmount":0,"salesPrice":25000,"conditionalIncentiveAmount":0,"primaryIncentiveAmount":0,"docFee":200,"zipCode":"55414","marketValue":25000,"withConcreteTaxesAndFees":true,"applyLimits":true,"msrp":25000,"lowerLimit":false}},"apr":{"36":9.25,"48":9.25,"60":9.25,"72":9.25,"84":9.25},"totalTaxesAndFees":1952.49,"taxes":{"combinedSalesTax":1625,"stateSalesTax":1625,"gasGuzzlerTax":0},"fees":{"titleFee":8.25,"registrationFee":70.99,"dmvFee":48.25,"combinedFees":327.49,"docFee":200,"dmvFees":{"Filing Fee":7,"License Plate Fee":15.5,"Public Safety Vehicle Fee":3.5,"Technology Fee":2.25,"Wheelage Tax":20}}}}}},"400":{"description":"Invalid VIN format or missing required parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"status":400,"error":"VIN must be exactly 17 characters containing only letters and numbers (excluding I, O, Q)","code":"INVALID_VIN_FORMAT","path":"/payments/123Invalid","requestId":"a1b2c3d4e5f6g7h8"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"402":{"$ref":"#/components/responses/PlanRequired"},"404":{"description":"VIN not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"status":404,"error":"No vehicle data found for the provided VIN","code":"VIN_NOT_FOUND","path":"/payments/1FTFW3LDXRFB40317","requestId":"b2c3d4e5f6g7h8i9"}}}},"429":{"$ref":"#/components/responses/RateLimited"},"503":{"description":"Payment calculation service temporarily unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"status":503,"error":"Payment calculation service temporarily unavailable","code":"SOURCE_ERROR","path":"/payments/1GYKPDRSXSZ102995","requestId":"c3d4e5f6g7h8i9j0"}}}}},"tags":["Financial Calculations"],"operationId":"calculateVehiclePayments","x-required-plan":"Growth"}},"/price/{vin}":{"get":{"tags":["Pricing & Incentives"],"summary":"Get Vehicle Price","description":"Current used-vehicle values for a VIN, nationally, in USD: the dealer retail and private-party values with the style's typical options, and the base style's retail, private-party and auction values. A VIN that matches several styles is not priced as one of them: prices is null and styles lists each candidate with its own values, unless ambiguity=true.\n\nThe values are at a mileage: the `mileage` you send; else the miles on the newest listing we hold for the VIN; else the typical mileage for the car's model year. The answer does not say which. The mileage moves retailOptions and privatePartyOptions; retailBase, privatePartyBase and auctionBase are the base style's national values at typical mileage, whatever the mileage.\n\nA VIN with no retail or private-party value is a 404 NO_DATA_FOUND, never a 200 without a price: a model year too new for used values has an auction value alone, and is that 404. A 404 is not billed.","operationId":"getVehiclePrice","parameters":[{"name":"vin","in":"path","required":true,"schema":{"type":"string","pattern":"^[A-HJ-NPR-Z0-9]{17}$"},"description":"17-character Vehicle Identification Number"},{"name":"mileage","in":"query","required":false,"schema":{"type":"integer","minimum":0,"maximum":999999},"example":85000,"description":"The car's odometer reading, in whole miles (digits only, no commas). Without it, the values are at the miles on the newest listing we hold for the VIN, else at the typical mileage for its model year. Anything other than a whole number from 0 to 999999 is a 400 INVALID_PARAMETER."},{"$ref":"#/components/parameters/Ambiguity"}],"responses":{"200":{"description":"The VIN's current values, at the mileage sent, else the newest listing's, else the typical mileage. Billed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PriceResponse"},"examples":{"listing":{"summary":"No mileage sent: at the miles on its newest listing (27,437)","value":{"vehicle":{"vin":"1FMCU0G60LUA05025","year":2020,"make":"Ford","model":"Escape"},"prices":{"retailOptions":17659,"privatePartyOptions":14743,"retailBase":13979,"privatePartyBase":11671,"auctionBase":8159}}},"mileage":{"summary":"mileage=85000: the same car at 85,000 miles (the base values do not move)","value":{"vehicle":{"vin":"1FMCU0G60LUA05025","year":2020,"make":"Ford","model":"Escape"},"prices":{"retailOptions":14013,"privatePartyOptions":11699,"retailBase":13979,"privatePartyBase":11671,"auctionBase":8159}}}}}}},"400":{"description":"Malformed VIN (INVALID_VIN_FORMAT), or a mileage that is not a whole number of miles from 0 to 999999 (INVALID_PARAMETER). Not billed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"},"examples":{"vin":{"summary":"A malformed VIN (INVALID_VIN_FORMAT)","value":{"vin":"1FMCU0G60","vinValid":false,"error":{"status":400,"error":"VIN must be exactly 17 characters containing only letters and numbers (excluding I, O, Q)","code":"INVALID_VIN_FORMAT","path":"/price/1FMCU0G60","requestId":"a5986becfb48f459"}}},"mileage":{"summary":"mileage=85,000 (INVALID_PARAMETER)","value":{"error":{"status":400,"error":"mileage must be a whole number of miles from 0 to 999,999.","code":"INVALID_PARAMETER","path":"/price/1FMCU0G60LUA05025","requestId":"a5986becfb48f45a"}}}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"402":{"$ref":"#/components/responses/PlanRequired"},"404":{"description":"The VIN decodes, but no retail or private-party value is on file for the vehicle (NO_DATA_FOUND; a model year too new for used values, with an auction value alone, is this 404), or the VIN does not decode (VIN_NOT_FOUND). Not billed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"},"examples":{"noPrice":{"summary":"A model year with no used values yet (NO_DATA_FOUND)","value":{"error":{"status":404,"error":"No market value on file for this 2027 Honda Civic.","code":"NO_DATA_FOUND","path":"/price/2HGFE2F20VH500227","requestId":"a59d3b0e5b8c6d38"}}},"noValue":{"summary":"A vehicle with no values on file (NO_DATA_FOUND)","value":{"error":{"status":404,"error":"No market value on file for this vehicle (The Metal Shop, Utility Trailers).","code":"NO_DATA_FOUND","path":"/price/1T9P61527VP394134","requestId":"a59d3b0e5b8c6d37"}}},"notFound":{"summary":"A VIN that does not decode (VIN_NOT_FOUND)","value":{"error":{"status":404,"error":"VIN not supported","code":"VIN_NOT_FOUND","path":"/price/3ZZAB1231RC654321","requestId":"a59d3b0f2a4e8c19"}}}}}}},"429":{"$ref":"#/components/responses/RateLimited"},"503":{"description":"The values cannot be reached right now (SOURCE_ERROR). Retry later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-required-plan":"Growth"}},"/apr/{vin}":{"get":{"summary":"Get Interest Rates","description":"Current used-auto loan APRs for 36, 48, 60, 72 and 84-month terms, from the vehicle's age and mileage, a ZIP code and a credit score. Rates depend only on age, mileage, ZIP code and credit score, not on make or model.","parameters":[{"name":"vin","in":"path","required":true,"schema":{"type":"string","pattern":"^[A-HJ-NPR-Z0-9]{17}$"},"description":"17-character Vehicle Identification Number"},{"name":"zip","in":"query","required":false,"schema":{"type":"string","pattern":"^[0-9]{5}(-[0-9]{4})?$"},"description":"5-digit ZIP code the rates are quoted for. Defaults to your account ZIP code, else 90210"},{"name":"creditScore","in":"query","required":false,"schema":{"type":"string","default":"720"},"description":"Borrower credit score"},{"name":"vehicleAge","in":"query","required":false,"schema":{"type":"number"},"description":"Age of the vehicle in years. Defaults to the years since its model year (at least 1)"},{"name":"vehicleMileage","in":"query","required":false,"schema":{"type":"number"},"description":"Vehicle mileage. Defaults to 12,000 miles a year of age"}],"responses":{"200":{"description":"Successfully retrieved interest rates","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InterestRatesResponse"},"example":{"vehicle":{"vin":"1C4HJXEN5MW592818","year":2021,"make":"Jeep","model":"Wrangler"},"zip":"37129","creditScore":"720","vehicleAge":3,"vehicleMileage":"36000","apr":{"36":7.644,"48":7.644,"60":7.524,"72":7.663,"84":8.263}}}}},"400":{"description":"Invalid VIN format or missing required parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":{"status":400,"error":"VIN must be exactly 17 characters containing only letters and numbers (excluding I, O, Q)","code":"INVALID_VIN_FORMAT","path":"/apr/123Invalid","requestId":"a1b2c3d4e5f6g7h8"}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"402":{"$ref":"#/components/responses/PlanRequired"},"404":{"description":"VIN not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":{"status":404,"error":"No vehicle data found for the provided VIN","code":"VIN_NOT_FOUND","path":"/apr/1FTFW3LDXRFB40317","requestId":"b2c3d4e5f6g7h8i9"}}}}},"429":{"$ref":"#/components/responses/RateLimited"}},"tags":["Financial Calculations"],"operationId":"getInterestRates","x-required-plan":"Growth"}},"/build/bulk":{"post":{"summary":"Get OEM Build Data in Bulk","description":"Look up many VINs in one call. The answer holds one item per VIN, in the order sent: exactly what `GET /build/{vin}` answers for that VIN, plus `vin` and `statusCode`. The call itself is 200 whenever it ran; a VIN that could not be answered is an item with its own error status, and is listed in `bulk.retry` when sending it again may help. There is no limit on how many VINs. A large list takes longer, about as fast as the Growth plan's requests per second allow, and the connection stays open until every VIN is answered. Each VIN answered with a 2xx counts as one `GET /build/{vin}` call, once per VIN per day; the bulk call itself is not counted. As on `GET /build/{vin}`, only a VIN answered with its build (a 200) is counted: a 207 or a 404 is not.","operationId":"bulkOemBuildData","tags":["Vehicle Information"],"parameters":[{"name":"includeStandard","in":"query","required":false,"schema":{"type":"boolean","default":false},"description":"As on `GET /build/{vin}`, for every VIN."},{"name":"array","in":"query","required":false,"allowEmptyValue":true,"schema":{"type":"string"},"description":"As on `GET /build/{vin}`, for every VIN."},{"name":"ambiguity","in":"query","required":false,"schema":{"type":"boolean","default":false},"description":"As on `GET /build/{vin}`, for every VIN."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["vins"],"properties":{"vins":{"description":"The VINs to look up: a list, or one string with the VINs separated by commas, spaces or new lines. Each VIN is answered once, in the order sent. There is no limit on how many.","oneOf":[{"type":"array","items":{"type":"string"}},{"type":"string"}]}}},"example":{"vins":["1FMUK7DHXSGA27345","5YJ3E1EA7KF317000"]}}}},"responses":{"200":{"description":"Every VIN answered","content":{"application/json":{"schema":{"type":"object","properties":{"bulk":{"type":"object","description":"Counts for the whole call.","properties":{"id":{"type":"string","description":"This call, as each VIN's usage row names it (`bulk=` in its query)"},"endpoint":{"type":"string","enum":["recalls","openrecalls","vin","specs","build"]},"requested":{"type":"number","description":"VINs asked, each once"},"answered":{"type":"number","description":"VINs answered with a 2xx: the VINs billed"},"failed":{"type":"number","description":"VINs answered with an error"},"byStatus":{"type":"object","additionalProperties":{"type":"number"},"description":"VINs per status"},"retry":{"type":"array","items":{"type":"string"},"description":"The VINs worth sending again: those answered 429 (but a monthly quota's) or 5xx"},"ms":{"type":"number","description":"Time taken, in milliseconds"}}},"results":{"type":"array","items":{"description":"One VIN: the answer the single-VIN endpoint gives for it (its `api`, `links`, `user` and `examples` blocks left out), with `vin` and `statusCode`, the status that call would have had. An error item carries `error`, and `retryAfter` (seconds) where that call would have sent a Retry-After header.","allOf":[{"type":"object","required":["vin","statusCode"],"properties":{"vin":{"type":"string"},"statusCode":{"type":"number","description":"The status the single-VIN call would have answered"},"retryAfter":{"type":"number","description":"Seconds to wait before asking this VIN again"}}},{"anyOf":[{"$ref":"#/components/schemas/OemBuildDataResponse"},{"$ref":"#/components/schemas/OemBuildPartialResponse"},{"$ref":"#/components/schemas/OemBuildMissResponse"},{"$ref":"#/components/schemas/ErrorEnvelope"}]}]}}}},"example":{"bulk":{"id":"6f1c0d52-3a4e-4a8e-9a43-0c4b0d1f2e3a","endpoint":"build","requested":2,"answered":1,"failed":1,"byStatus":{"200":1,"400":1},"retry":[],"ms":1412},"results":[{"vin":"1FMUK7DHXSGA27345","statusCode":200,"build":{"vin":"1FMUK7DHXSGA27345","year":2025,"make":"Ford","model":"Explorer","trim":"Active"}},{"vin":"1FMUK7DHXSGA2734","statusCode":400,"error":{"status":400,"error":"Invalid VIN format: 1FMUK7DHXSGA2734","code":"INVALID_VIN_FORMAT","path":"/build/1FMUK7DHXSGA2734","requestId":"a1b2c3d4e5f6g7h8"}}]}}}},"400":{"description":"The body names no VIN","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"},"example":{"error":{"status":400,"error":"Send {\"vins\": [\"VIN1\", \"VIN2\", ...]}.","code":"BULK_BODY_INVALID","path":"/openrecalls/bulk","requestId":"a1b2c3d4e5f6g7h8"}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"402":{"$ref":"#/components/responses/PlanRequired"},"429":{"$ref":"#/components/responses/RateLimited"}},"x-required-plan":"Growth"}},"/build/{vin}":{"get":{"summary":"Get OEM Build Data","description":"Retrieve complete vehicle build information based on the VIN, including exact trim details, drivetrain, engine specifications, interior/exterior colors, factory options, and MSRP data. This comprehensive API provides the most detailed vehicle information available from OEM build records. Add `includeStandard=true` for the standard equipment too, each line with its code where one is known. Read the status before the body: a 200 is a build, a 207 names the car, with `build` holding what is certain for the VIN (null when nothing is) and `missing` the rest, and a 404 carries a `build` object that is not a build. On the Growth plan and above; below it, a VIN whose answer is known without asking a source gets that answer (a 400 or 404) instead of the 402.","parameters":[{"name":"vin","in":"path","required":true,"schema":{"type":"string","pattern":"^[A-Za-z0-9]{17}$"},"description":"17-character Vehicle Identification Number. Read upper-cased, with I, O and Q taken as 1, 0 and 0; anything else answers 400 `INVALID_VIN_FORMAT`."},{"name":"includeStandard","in":"query","required":false,"schema":{"type":"boolean","default":false},"description":"Whether to add `build.standardEquipment`: what the vehicle ships with as standard, each line with its code where one is known. Only `true` or `1` adds it; any other value leaves it off. Never adds a cost."},{"name":"array","in":"query","required":false,"allowEmptyValue":true,"schema":{"type":"string"},"description":"Present in the query, with any value or none (`?array`), to answer `options`, `interiorColor` and `exteriorColor` as lists: each option `{ id, name }`, each color `{ name, colorCode, code }`, where `code` is the manufacturer's color code. A line with no known code has no `id`. Without it, they are objects."},{"name":"ambiguity","in":"query","required":false,"schema":{"type":"boolean","default":false},"description":"Whether to allow a best-guess trim for a VIN that matches several trims, when no record of this VIN names one. By default (false) `build.trim` is the trim the sources agree on, or absent. Only `true` allows the single best-guess pick. Also accepted as the X-Ambiguity header."}],"responses":{"200":{"description":"A build: what a record of this VIN says. Billed, once per VIN per day. A field no record held is absent or empty, and `missing` names it. An option's key is its code where one is known and its name where none is.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OemBuildDataResponse"},"examples":{"default":{"summary":"A build, recorded 2026-11-18","value":{"build":{"vin":"1FTFW3LDXRFB40317","year":2024,"make":"Ford","model":"F-150","trim":"XLT","style":"XLT 4x4 SuperCrew 5-1/2 Box","bodyType":"Pickup","drivetrain":"4WD","engine":"3.5L V6","transmission":"Automatic","confidence":0.85,"interiorColor":{"Black Unique Sport Cloth 40/Console/40 Front Seat":"#242424"},"exteriorColor":{"Oxford White":"#FFFFFF"},"interiorColorCode":"FB","exteriorColorCode":"YZ","packageCode":"302A","options":{"153":"Front License Plate Bracket","302A":"Equipment Group 302A (XLT Mid)","50M":"Mobile Office Package","68L":"Bed Utility Package","AHQAB":"First Aid Kit with Ford Logo (Dealer)","19P":"Black Appearance Package Plus","53T":"Tow Package","99D":"3.5L PowerBoost Hybrid V6 Engine","54Y":"Manual Folding, Manual Telescoping Trailer Tow Mirrors"},"headUpDisplay":false,"rainSensingWipers":false,"baseMsrp":53950,"optionsMsrp":12440}}},"optionKeyedByName":{"summary":"An option with no known code, keyed by its name, and a color not on file yet for a model year ahead of the catalogs (options trimmed), recorded 2026-11-18","value":{"build":{"vin":"1C4RJHBR3V8175351","year":2027,"make":"Jeep","model":"Grand Cherokee","trim":"Limited","style":"Sport Utility","bodyType":"Sport Utility","drivetrain":"4x4","engine":"2.0L HURRICANE 4 TURBO SO W/ESS","transmission":"8-SPD AUTO 880RE TRANS (MAKE)","confidence":0.85,"interiorColor":{"GLOBAL BLACK":"#000000"},"options":{"EC7":"2.0L HURRICANE 4 TURBO SO W/ESS","2CR":"CUSTOMER PREFERRED PACKAGE 2CR","DC1":"8-SPD AUTO 880RE TRANS (MAKE)","GWJP":"DUAL-PANE PANORAMIC SUNROOF","DETROIT 2 TRACKING":"DETROIT 2 TRACKING"},"headUpDisplay":false,"rainSensingWipers":true,"baseMsrp":47130},"missing":[{"field":"exteriorColor","reason":"not_yet_available"}]}},"array":{"summary":"With ?array: options and colors as lists, each color with its manufacturer code, recorded 2026-11-18","value":{"build":{"vin":"1FTFW3LDXRFB40317","year":2024,"make":"Ford","model":"F-150","trim":"XLT","style":"XLT 4x4 SuperCrew 5-1/2 Box","bodyType":"Pickup","drivetrain":"4WD","engine":"3.5L V6","transmission":"Automatic","confidence":0.85,"interiorColor":[{"name":"Black Unique Sport Cloth 40/Console/40 Front Seat","colorCode":"#242424","code":"FB"}],"exteriorColor":[{"name":"Oxford White","colorCode":"#FFFFFF","code":"YZ"}],"interiorColorCode":"FB","exteriorColorCode":"YZ","packageCode":"302A","options":[{"id":"302A","name":"Equipment Group 302A (XLT Mid)"},{"id":"153","name":"Front License Plate Bracket"},{"id":"50M","name":"Mobile Office Package"},{"id":"68L","name":"Bed Utility Package"},{"id":"AHQAB","name":"First Aid Kit with Ford Logo (Dealer)"},{"id":"19P","name":"Black Appearance Package Plus"},{"id":"53T","name":"Tow Package"},{"id":"99D","name":"3.5L PowerBoost Hybrid V6 Engine"},{"id":"54Y","name":"Manual Folding, Manual Telescoping Trailer Tow Mirrors"}],"headUpDisplay":false,"rainSensingWipers":false,"baseMsrp":53950,"optionsMsrp":12440}}},"includeStandard":{"summary":"With includeStandard=true (equipment trimmed), recorded 2026-11-18","value":{"build":{"vin":"3GNAXHEG0SL169355","year":2025,"make":"Chevrolet","model":"Equinox","trim":"LT","style":"LT 1.5T","bodyType":"SUV","drivetrain":"FWD","engine":"1.5L I4","transmission":"CVT","confidence":0.85,"interiorColor":{"Black Cloth":"#000000"},"exteriorColor":{"Radiant Red Tintcoat":"#971C1E"},"interiorColorCode":"EKV","exteriorColorCode":"GNT","options":{"CWN":"Safety and Technology Package","GNT":"Radiant Red Tintcoat","VLI":"Cargo Mat (Dealer)","VK3":"Front License Plate Bracket"},"standardEquipment":{"basis":"exact_trim","equipment":[{"name":"Rear View Mirror/Camera","category":"Interior"},{"name":"Heated Steering Wheel","category":"Interior","code":"KI3"},{"name":"Adaptive Cruise Control","category":"Comfort & Convenience","code":"KSG"},{"name":"Deep-Tinted Glass","code":"AKO"},{"name":"Front LED Fog Lamps","code":"T3U"},{"name":"ACH","code":"ACH"}]},"headUpDisplay":false,"rainSensingWipers":false,"baseMsrp":28600,"optionsMsrp":1715}}}}}}},"207":{"description":"Partial answer: the VIN decodes to a car but no record builds it. `build` holds what is certain for this VIN, in a 200's keys and words: a value a source pinned for the VIN, one every style the VIN can be shares, or the one a fact of the VIN admits (an Australian Ford's registered power fits one engine). `missing` names every other build field, with why. `build` is null when nothing beyond the car is certain. `vehicle` names the car, `catalog` is what the matched style ships with (or null), `reason` says why. For a European VIN, `catalog` lists the styles of its public-register neighbours, each with its share as `confidence`, and what every neighbour shares as `standardEquipment`; `reason` is `no_build_record`. The neighbours are vehicles of its VIN pattern built close to it in Denmark's Motor Register, else cars sharing its first 10 characters in Finland's open vehicle data; where neither holds any, vehicles built close to it in the Czech Republic's vehicle register, else Spain's registrations (DGT) sharing its first 10 characters. The Netherlands' type-approval data adds the gearbox, body and height their entries leave out. Not an error, not billed: a 207 is never the vehicle's build record. Most HTTP clients treat a 207 as ok: branch on the status first, since `build` is the build record only on a 200. Below the Growth plan, a VIN this answers gets the 402, from whatever market.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OemBuildPartialResponse"},"examples":{"notYetAvailable":{"summary":"A model year ahead of the catalogs: one style, so its trim, engine, gearbox and drive are certain; the colors and options missing, not yet available (catalog lists trimmed), recorded live 2026-11-18 21:14Z","value":{"vehicle":{"vin":"1N4BL4CW1VN304672","year":2027,"make":"Nissan","model":"Altima","trim":"2.5 SR","body":"Sedan","msrp":30690},"build":{"vin":"1N4BL4CW1VN304672","year":2027,"make":"Nissan","model":"Altima","trim":"2.5 SR","style":"2.5 SR 4dr Sedan AWD","bodyType":"Sedan/Saloon","drivetrain":"All wheel drive","engine":"2.5 L, Inline 4, Gas, 182 hp @ 6000 rpm","transmission":"Continuously variable-speed automatic"},"missing":[{"field":"interiorColor","reason":"not_yet_available"},{"field":"exteriorColor","reason":"not_yet_available"},{"field":"options","reason":"not_yet_available"}],"catalog":{"vinSpecific":false,"styles":[{"name":"2.5 SR 4dr Sedan AWD (2.5L 4cyl CVT)","trim":"2.5 SR","msrp":30690}],"standardEquipment":["Direct injection","Four wheel independent suspension","Front and rear stabilizer bar"],"availableOptions":[{"code":null,"name":"Sr midnight edition"},{"code":null,"name":"Sr premium package"}],"exteriorColors":[{"name":"Super Black","colorCode":"#010101"},{"name":"Gun Metallic","colorCode":"#858885"}],"interiorColors":[{"name":"Charcoal Sport, premium cloth","colorCode":"#030B0D"}]},"reason":"not_yet_available","retryable":true}},"australian":{"summary":"An Australian Ford the register decodes, recorded live 2026-11-18 21:14Z: the 155 kW its record states fits one engine (YN2S), Ford pairs that engine with one gearbox (10R80), VIN position 6 is its cab and body. No descriptor version names a double cab chassis trim with that engine, so its styles carry none, and the drive is open between them: trim, style and drive are missing. `build.options` holds the two codes, so `options` is `partial`","value":{"vehicle":{"vin":"MPBCMEF60SX665337","year":2025,"make":"Ford","model":"Ranger","body":"4dr Double Cab Chassis"},"build":{"vin":"MPBCMEF60SX665337","year":2025,"make":"Ford","model":"Ranger","bodyType":"Chassis Cab","engine":"2.0L I4","transmission":"10-speed shiftable automatic","options":{"YN2S":"2.0L I4 twin-turbo diesel engine, 207 hp","10R80":"10-speed shiftable automatic transmission"}},"missing":[{"field":"trim","reason":"no_vin_record"},{"field":"style","reason":"no_vin_record"},{"field":"drivetrain","reason":"no_vin_record"},{"field":"interiorColor","reason":"no_vin_record"},{"field":"exteriorColor","reason":"no_vin_record"},{"field":"options","reason":"partial"}],"catalog":{"vinSpecific":false,"styles":[{"name":"4dr Double Cab Chassis 4WD"},{"name":"4dr Double Cab Chassis"}],"standardEquipment":[],"availableOptions":[{"code":"YN2S","name":"2.0L I4 twin-turbo diesel engine, 207 hp"},{"code":"P02S","name":"2.0L I4 turbo diesel engine"},{"code":"BF2S","name":"3.0L V6 turbo diesel engine"},{"code":"YN2X","name":"2.0L I4 twin-turbo diesel engine, 202 hp"},{"code":"10R80","name":"10-speed shiftable automatic transmission"},{"code":"6R80","name":"6-speed shiftable automatic transmission"},{"code":"MT82","name":"6-speed manual transmission"}],"exteriorColors":[],"interiorColors":[]},"reason":"no_build_record","retryable":false}},"european":{"summary":"A European VIN, recorded live 2026-11-18 21:14Z: the engine all 93 of its register neighbours state alike in build, their styles in catalog, each named only by what its vehicles state","value":{"vehicle":{"vin":"WV1ZZZ2EZG6031948","year":2016,"make":"Volkswagen","model":"Crafter"},"build":{"vin":"WV1ZZZ2EZG6031948","year":2016,"make":"Volkswagen","model":"Crafter","engine":"2.0L 4cyl, diesel"},"missing":[{"field":"trim","reason":"no_vin_record"},{"field":"style","reason":"no_vin_record"},{"field":"bodyType","reason":"no_vin_record"},{"field":"drivetrain","reason":"no_vin_record"},{"field":"transmission","reason":"no_vin_record"},{"field":"interiorColor","reason":"no_vin_record"},{"field":"exteriorColor","reason":"no_vin_record"},{"field":"options","reason":"no_vin_record"}],"catalog":{"vinSpecific":false,"styles":[{"name":"Panel Van MWB High Roof (2.0L Diesel 163hp 6M)","confidence":0.34},{"name":"Panel Van MWB (2.0L Diesel 163hp)","confidence":0.26},{"name":"Truck (2.0L Diesel 163hp)","confidence":0.06},{"name":"Kombi MWB (2.0L Diesel 163hp)","confidence":0.04},{"name":"Panel Van LWB High Roof (2.0L Diesel 163hp 6M)","confidence":0.04},{"name":"Panel Van SWB (2.0L Diesel 109hp)","confidence":0.04},{"name":"Panel Van MWB (2.0L Diesel 136hp)","confidence":0.03},{"name":"2.0L Diesel 109hp","confidence":0.02},{"name":"Kombi MWB (2.0L Diesel 114hp)","confidence":0.02},{"name":"Panel Van LWB (2.0L Diesel 163hp)","confidence":0.02},{"name":"Panel Van MWB High Roof (2.0L Diesel 136hp 6M)","confidence":0.02},{"name":"Panel Van SWB (2.0L Diesel 136hp)","confidence":0.02},{"name":"2.0L Diesel 114hp","confidence":0.01},{"name":"2.0L Diesel 136hp","confidence":0.01},{"name":"Panel Van (2.0L Diesel 163hp)","confidence":0.01},{"name":"Panel Van MWB Normal Roof (2.0L Diesel 136hp 6M)","confidence":0.01},{"name":"Panel Van MWB Normal Roof (2.0L Diesel 163hp 6M)","confidence":0.01},{"name":"Panel Van SWB Normal Roof (2.0L Diesel 136hp 6M)","confidence":0.01}],"standardEquipment":["2.0L 4-cylinder diesel engine (1,968 cc)"],"availableOptions":[],"exteriorColors":[],"interiorColors":[]},"reason":"no_build_record","retryable":false}},"marketNotCovered":{"summary":"A VIN built outside North America that a decoder names and no register holds, recorded live 2026-11-18 21:14Z on the Scale plan: nothing certain, so build is null. Below Growth the same VIN answers the 402.","value":{"vehicle":{"vin":"6FPFXXMX2FRD07902","year":2015,"make":"Ford","model":"Ranger"},"build":null,"catalog":null,"reason":"market_not_covered","retryable":false}},"classNotCovered":{"summary":"A motorcycle, recorded live 2026-11-18 21:14Z: no catalog; the engine and body its VIN states, in the words a 200 gives them","value":{"vehicle":{"vin":"1HD1BWV10GB016330","year":2016,"make":"Harley-davidson","model":"Flstc103 / Heritage Softail Classic","body":"Motorcycle - Custom"},"build":{"vin":"1HD1BWV10GB016330","year":2016,"make":"Harley-davidson","model":"Flstc103 / Heritage Softail Classic","bodyType":"Motorcycle - Custom","engine":"1.7L 2cyl, gasoline, engine with 72HP"},"missing":[{"field":"trim","reason":"no_vin_record"},{"field":"style","reason":"no_vin_record"},{"field":"drivetrain","reason":"no_vin_record"},{"field":"transmission","reason":"no_vin_record"},{"field":"interiorColor","reason":"no_vin_record"},{"field":"exteriorColor","reason":"no_vin_record"},{"field":"options","reason":"no_vin_record"}],"catalog":null,"reason":"class_not_covered","retryable":false}}}}}},"302":{"description":"A browser that sends no API key is sent to the login page, which returns it to this URL once signed in. An API client that sends no key gets the 401.","headers":{"Location":{"description":"The login page, with this URL to return to","schema":{"type":"string"}}}},"400":{"description":"Not a VIN we can look up. `INVALID_VIN_FORMAT`: not 17 VIN characters, or a VIN we cannot decode that begins with 0; it carries no `reason` or `retryable`. `INVALID_VIN`: a 17-character VIN we cannot decode that is not a vehicle (a North American check digit that does not compute, or a test pattern such as `00000`, `11111`, `XXXXX` or a counting serial), with `reason: invalid_vin`. The same `INVALID_VIN` is a 404 for a VIN we can decode (see the 404). Answered on every plan, unbilled.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OemBuildMissResponse"},"examples":{"invalidFormat":{"summary":"Not 17 VIN characters, recorded 2026-11-18","value":{"error":{"status":400,"error":"VIN must be exactly 17 characters containing only letters and numbers (excluding I, O, Q)","code":"INVALID_VIN_FORMAT","path":"/build/123Invalid","requestId":"a5c476357dd4f6da"}}},"invalidVin":{"summary":"A VIN we cannot decode, with a test-pattern run, recorded 2026-11-18","value":{"reason":"invalid_vin","retryable":false,"error":{"status":400,"error":"This VIN is not a vehicle: its check digit does not compute, or it is a test pattern.","code":"INVALID_VIN","path":"/build/ANTAB2C3DSA000004","requestId":"a5c4797d6eafa1e2","reason":"invalid_vin","retryable":false}}}}}}},"401":{"description":"No API key was sent (`API_KEY_REQUIRED`), or the key sent is not known (`API_KEY_NOT_RECOGNISED`). `error` is an object here, not a string.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponse"},"examples":{"required":{"summary":"No API key, recorded 2026-11-18","value":{"status":401,"error":{"code":"API_KEY_REQUIRED","message":"Authentication required. Get your API key at https://auto.dev/dashboard/api-keys"}}},"notRecognised":{"summary":"A key that is not known, recorded 2026-11-18","value":{"status":401,"error":{"code":"API_KEY_NOT_RECOGNISED","message":"API key not recognised (it may have been regenerated or revoked)"}}}}}}},"402":{"description":"Payment required. `FEATURE_NOT_AVAILABLE`: the key's plan is below Growth; the X-Required-Plan and X-Current-Plan headers name the plans. It is not answered for a VIN whose answer is known without asking a source: a malformed VIN or one we cannot decode (the 400, or the 404 without `build`), a VIN that is not a vehicle, or a decoded VIN built outside North America whose year, make and model the decode does not name (the 404 `VIN_NOT_IN_COVERAGE`). A VIN whose decode names the car gets this 402, from whatever market. `TRIAL_CAP_EXCEEDED`: the account's spend limit is reached and invoiced. `ACCOUNT_PAST_DUE`: the account is suspended for a past-due invoice. `ORGANIZATION_PAYMENT_REQUIRED`: a request with no key from traffic that belongs to an account without a paid plan.","headers":{"X-Required-Plan":{"description":"`FEATURE_NOT_AVAILABLE`: the plan this operation needs","schema":{"type":"string"}},"X-Current-Plan":{"description":"`FEATURE_NOT_AVAILABLE`: the plan the caller is on","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalResponse"},"examples":{"featureNotAvailable":{"summary":"Below the Growth plan, served 2026-11-18","value":{"status":402,"error":"Payment Required","code":"FEATURE_NOT_AVAILABLE","message":"This feature requires the Growth plan or above. You are currently on the Free plan.","currentPlan":"Free","requiredPlan":"Growth","upgradeUrl":"https://auto.dev/pricing?tier=Growth","upgradeLink":"https://auto.dev/pricing?tier=Growth","docsUrl":"https://auto.dev/pricing","plans":{"Growth":{"price":"$299/mo","rateLimit":"10 req/s","features":"apr, build, dealers, glass, incentives, payments, price, recalls, rpo, specs, tco, ymm"},"Scale":{"price":"$599/mo","rateLimit":"50 req/s","features":"All Growth + openrecalls, plate, sticker, taxes"}}}},"trialCapExceeded":{"summary":"Spend limit reached, served 2026-11-06","value":{"status":402,"error":"Payment Required","code":"TRIAL_CAP_EXCEEDED","message":"Your spend limit of $100 has been reached. The usage so far has been invoiced to your payment method on file; once it is paid, your limit doubles and your requests go through."}},"accountPastDue":{"summary":"A past-due account, served 2026-10-23 (the invoice link is the account's own)","value":{"status":402,"error":"Payment Required","code":"ACCOUNT_PAST_DUE","message":"Your account access is suspended due to a past-due balance. Resolve the outstanding invoice to restore access.","link":"https://invoice.stripe.com/i/..."}},"organizationPaymentRequired":{"summary":"Traffic of an account without a paid plan, as served on any route","value":{"status":402,"error":"This traffic belongs to an account without an active paid plan.","code":"ORGANIZATION_PAYMENT_REQUIRED","path":"/build/1FTFW3LDXRFB40317","requestId":"a5b7f9501bea58d7"}}}}}},"404":{"description":"A miss: no build, and no car a 207 can name. `error.code` is `VIN_NOT_FOUND` (no record builds the VIN), `VIN_NOT_IN_COVERAGE` (built outside North America, with `detectedMarket` where the market is known, or a motorcycle, trailer or heavy truck, with `detectedClass`) or `INVALID_VIN` (a VIN we can decode that is not a vehicle: its check digit does not compute, or it is a test pattern). `reason` and `retryable` are top-level and inside `error`. For a VIN we decoded, `build` is the object `{ error, vin }`, not a build; for one we could not decode, there is no `build`. On the Growth plan and above a decoded miss is a 404 only when no decoder names the year, make and model, or the VIN is not a vehicle; otherwise it is the 207. Below Growth, a VIN built outside North America answers this 404 `VIN_NOT_IN_COVERAGE` only when the decode does not name its year, make and model; a VIN it names gets the 402. Unbilled.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OemBuildMissResponse"},"examples":{"notFound":{"summary":"No record builds the VIN, recorded 2026-11-18","value":{"build":{"error":"No build data available","vin":"1FMDU32X6RUE08716"},"reason":"no_build_record","retryable":false,"error":{"status":404,"error":"No build data available for this vehicle.","code":"VIN_NOT_FOUND","path":"/build/1FMDU32X6RUE08716","requestId":"a5c476168a9ea600","reason":"no_build_record","retryable":false}}},"notInCoverage":{"summary":"A decoded VIN built outside North America that no decoder names the model of, recorded 2026-11-18 17:12Z. Below Growth, such a VIN answers this too.","value":{"build":{"error":"No build data available","vin":"JS1AB2C3DSA947381"},"reason":"market_not_covered","retryable":false,"error":{"status":404,"error":"This VIN appears to be a non-US vehicle. auto.dev currently has full coverage for US-market vehicles only.","code":"VIN_NOT_IN_COVERAGE","path":"/build/JS1AB2C3DSA947381","requestId":"a5c899b8d95fb4c8","detectedMarket":{"country":"JP","region":"Asia"},"reason":"market_not_covered","retryable":false}}},"specsLink":{"summary":"A miss whose make /specs answers, with `discover.specs`, the VIN's /specs URL on the host asked, recorded 2026-11-18 17:11Z","value":{"build":{"error":"No build data available","vin":"WBAJB0C51JB084264"},"reason":"market_not_covered","retryable":false,"error":{"status":404,"error":"This VIN appears to be a non-US vehicle. auto.dev currently has full coverage for US-market vehicles only.","code":"VIN_NOT_IN_COVERAGE","path":"/build/WBAJB0C51JB084264","requestId":"a5c899388bdd7cc7","detectedMarket":{"country":"DE","region":"Europe"},"reason":"market_not_covered","retryable":false},"discover":{"specs":"https://api.auto.dev/specs/WBAJB0C51JB084264"}}},"invalidVin":{"summary":"A decoded VIN that is not a vehicle, recorded 2026-11-18","value":{"build":{"error":"No build data available","vin":"11111111111111111"},"reason":"invalid_vin","retryable":false,"error":{"status":404,"error":"This VIN is not a vehicle: its check digit does not compute, or it is a test pattern.","code":"INVALID_VIN","path":"/build/11111111111111111","requestId":"a5c47627cd79a1e2","reason":"invalid_vin","retryable":false}}},"undecoded":{"summary":"A VIN we cannot decode: no `build` key, recorded 2026-11-18","value":{"reason":"market_not_covered","retryable":false,"error":{"status":404,"error":"This VIN appears to be a non-US vehicle. auto.dev currently has full coverage for US-market vehicles only.","code":"VIN_NOT_IN_COVERAGE","path":"/build/ANTAB2C3DSA947381","requestId":"a5c47926da94102a","reason":"market_not_covered","retryable":false}}}}}}},"429":{"description":"Over the plan's rate limit. `limitType` says which: `burst`, the plan's requests per 10 seconds (Growth 100, Scale 500), or `quota`, the 1,000 calls a month of a key on the free allowance. Wait for the seconds in Retry-After. The body also carries the caller's `user` block, omitted here.","headers":{"Retry-After":{"description":"Seconds until the caller may retry","schema":{"type":"integer"}},"X-RateLimit-Limit":{"description":"Requests allowed in the window","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Always 0 on a 429","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Unix timestamp (seconds) when the window resets","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalResponse"},"examples":{"burst":{"summary":"Over the Growth plan's burst limit, as the limiter serves it","value":{"status":429,"error":"Rate limit exceeded for your Growth plan. Upgrade to Scale ($599/mo, 50 req/s) at https://auto.dev/pricing for higher limits.","code":"RATE_LIMIT_EXCEEDED","path":"/build/1FTFW3LDXRFB40317","requestId":"a5b1ebec5c9b160a","upgradeLink":"https://auto.dev/pricing","plans":{"Growth":{"price":"$299/mo","rateLimit":"10 req/s","features":"apr, build, dealers, glass, incentives, payments, price, recalls, rpo, specs, tco, ymm"},"Scale":{"price":"$599/mo","rateLimit":"50 req/s","features":"All Growth + openrecalls, plate, sticker, taxes"}},"limitType":"burst"}}}}}},"503":{"description":"Try again. `SOURCE_ERROR` with `reason: source_unavailable`: a build source did not answer, so nothing is known about the VIN yet; Retry-After is 30. `AUTH_VERIFICATION_UNAVAILABLE` or `PLAN_VERIFICATION_UNAVAILABLE`: the key or the plan could not be checked just now; Retry-After is 5. Unbilled.","headers":{"Retry-After":{"description":"Seconds to wait: 30 for `SOURCE_ERROR`, 5 for the key or plan check","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/OemBuildMissResponse"},{"$ref":"#/components/schemas/RefusalResponse"}]},"examples":{"sourceUnavailable":{"summary":"A source did not answer, served 2026-11-18","value":{"reason":"source_unavailable","retryable":true,"error":{"status":503,"error":"Build data is temporarily unavailable. Please retry.","code":"SOURCE_ERROR","path":"/build/1FTFW3LDXRFB40317","requestId":"a5c2e0944893069b","reason":"source_unavailable","retryable":true}}},"authUnavailable":{"summary":"The key could not be checked, served 2026-10-29","value":{"status":503,"error":"Service Unavailable","code":"AUTH_VERIFICATION_UNAVAILABLE","message":"We could not verify your API key just now. This is temporary — please retry."}}}}}}},"tags":["Vehicle Information"],"operationId":"getOemBuildData","x-required-plan":"Growth"}},"/openrecalls/{vin}":{"get":{"summary":"Get Open Recalls","description":"Get currently active and unresolved vehicle recall information for a VIN. This API filters out completed, closed, or resolved recalls to show only those requiring immediate attention or repair action.","parameters":[{"name":"vin","in":"path","required":true,"schema":{"type":"string","pattern":"^[A-HJ-NPR-Z0-9]{17}$"},"description":"17-character Vehicle Identification Number to retrieve open recalls for"},{"name":"recalls","in":"query","required":false,"schema":{"type":"string","enum":["true","false"]},"description":"When `true`, the response includes an additional `recalls` array carrying the full make/model/year recall catalog, including remedied campaigns, alongside the open-only `data` array. It lists each campaign once, plus any of the VIN's open recalls whose campaign the catalog does not list. Catalog records use the field names of `data` records but carry only what the catalog supplies (no `mfrCampaignNumber`, `remedyAvailable`, `mfrNotes` or `isSafetyRecall`); an open recall added from `data` appears as it does there. When no catalog is available, `recalls` holds only the VIN's open recalls, and is an empty array if there are none."}],"responses":{"200":{"description":"Successfully retrieved open recalls","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenRecallsResponse"},"example":{"vehicle":{"year":2025,"make":"Ford","model":"Explorer","vin":"1FMUK7DHXSGA27345"},"status":"1 Open Recall","openRecalls":1,"totalRecalls":3,"retrievedAt":"2026-08-07T12:00:00.000Z","data":[{"manufacturer":"Ford Motor Company","nhtsaCampaignNumber":"25V239000","mfrCampaignNumber":"25S35","remedyAvailable":true,"parkIt":false,"parkOutSide":false,"overTheAirUpdate":false,"reportReceivedDate":"11/04/2025","component":"POWER TRAIN:AUTOMATIC TRANSMISSION:CONTROL MODULE:SOFTWARE","summary":"Ford Motor Company (Ford) is recalling certain 2025 Explorer vehicles.  The powertrain control module (PCM) may reset while driving, which can damage the park system or cause an engine stall.","consequence":"A damaged park system can result in a vehicle rollaway when the vehicle is placed in park without the parking brake applied.  An engine stall while driving can result in a sudden loss of drive power.  Either of these scenarios can increase the risk of a crash.","remedy":"Dealers will update the powertrain control module software, free of charge.  Owner notification letters were mailed June 6, 2025. Owners may contact Ford customer service at 1-866-436-7332.  Ford's number for this recall is 25S35.","notes":"Owners may also contact the National Highway Traffic Safety Administration Vehicle Safety Hotline at 888-327-4236 (TTY 888-275-9171) or go to nhtsa.gov.","isSafetyRecall":true,"modelYear":"2025","make":"FORD","model":"EXPLORER"}],"manufacturerCampaigns":[{"mfrCampaignNumber":"25B12","summary":"Customer Satisfaction Program: a front-camera calibration fault may affect certain 2025 Explorer vehicles. This is a manufacturer program, not a NHTSA safety recall, so it is listed here and not counted in openRecalls.","remedy":"Dealers will recalibrate the front camera at no charge.","remedyAvailable":true,"reportReceivedDate":"15/05/2025"}],"manufacturerCampaignCount":1}}}},"400":{"description":"Invalid VIN format","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":{"status":400,"error":"VIN must be exactly 17 characters containing only letters and numbers (excluding I, O, Q)","code":"INVALID_VIN_FORMAT","path":"/openrecalls/1GYKPD","requestId":"a1b2c3d4e5f6g7h8"}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"402":{"$ref":"#/components/responses/PlanRequired"},"404":{"description":"VIN not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":{"status":404,"error":"No vehicle data found for the provided VIN","code":"VIN_NOT_FOUND","path":"/openrecalls/1FTFW3LDXRFB40317","requestId":"b2c3d4e5f6g7h8i9"}}}}},"429":{"$ref":"#/components/responses/RateLimited"}},"tags":["Safety & Recalls"],"operationId":"getOpenRecalls","x-required-plan":"Scale"}},"/plate/{state}/{plate}":{"get":{"summary":"Convert License Plate to VIN","description":"Quickly decode any US license plate to get the VIN, year, make, model, and comprehensive vehicle information. This powerful API connects license plate data to detailed vehicle records across all 50 states and DC. The state and the plate are both path segments; there are no query parameters.","parameters":[{"name":"state","in":"path","required":true,"schema":{"type":"string","pattern":"^[A-Za-z]{2}$"},"description":"2-letter code of the US state (or DC) where the plate is registered, e.g. CA, NY, TX. Upper or lower case."},{"name":"plate","in":"path","required":true,"schema":{"type":"string","pattern":"^[A-Za-z0-9 .-]{2,}$"},"description":"The plate number: 2 to 8 letters and digits. Spaces, hyphens and dots are ignored (KFY-3428 is looked up as KFY3428), and letters may be lower case."}],"responses":{"200":{"description":"Successfully retrieved vehicle information from license plate","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlateToVinResponse"},"example":{"vin":"WDBPJ74J83A036121","year":2003,"make":"Mercedes-Benz","model":"CL-Class","trim":"CL55 AMG","drivetrain":"RWD","engine":"8VSCG5.5","transmission":"Automatic"}}}},"400":{"description":"Invalid license plate format or state code","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":{"status":400,"error":"License plate must be 2-8 alphanumeric characters","code":"INVALID_PLATE_FORMAT","path":"/plate/CA/ABC12345XYZ","requestId":"a1b2c3d4e5f6g7h8"}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"402":{"$ref":"#/components/responses/PlanRequired"},"404":{"description":"License plate not found or no vehicle data available","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":{"status":404,"error":"No vehicle found for the provided license plate","code":"PLATE_NOT_FOUND","path":"/plate/CA/XYZ999","requestId":"c3d4e5f6g7h8i9j0"}}}}},"429":{"$ref":"#/components/responses/RateLimited"},"503":{"description":"The plate lookup could not be completed; retryable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":{"status":503,"error":"The plate lookup service is temporarily unavailable. Please retry shortly.","code":"SOURCE_ERROR","path":"/plate/CA/ABC123","requestId":"e5f6g7h8i9j0k1l2"}}}}}},"tags":["Vehicle Lookup"],"operationId":"convertPlateToVin","x-required-plan":"Scale"}},"/taxes/{vin}":{"get":{"summary":"Calculate Taxes & Fees","description":"Retrieve comprehensive tax and fee calculations for vehicle sales transactions. This API provides accurate, location-specific tax rates and government fees, ensuring compliance with local regulations and transparent pricing for both dealers and consumers.","parameters":[{"name":"vin","in":"path","required":true,"schema":{"type":"string","pattern":"^[A-HJ-NPR-Z0-9]{17}$"},"description":"The Vehicle Identification Number"},{"name":"price","in":"query","required":false,"schema":{"type":"number","minimum":0,"default":25000},"description":"The vehicle price. Defaults to 25000 if not provided."},{"name":"zip","in":"query","required":false,"schema":{"type":"string","pattern":"^[0-9]{5}(-[0-9]{4})?$","default":"94020"},"description":"The ZIP code of the location. If not provided, defaults to user zipcode or 94020."},{"name":"docFee","in":"query","required":false,"schema":{"type":"number","minimum":0,"default":200},"description":"Documentation fee. Defaults to 200 if not provided."},{"name":"taxDocFee","in":"query","required":false,"schema":{"type":"boolean"},"description":"Whether the documentation fee is part of the taxable price. Unset follows the state's law (taxed in, for example, CA, FL, GA, NC, CO, IL, VA, MD; not in TX, PA, WA). `false` never taxes it; `true` always does."},{"name":"tradeIn","in":"query","required":false,"schema":{"type":"number","minimum":0,"default":0},"description":"Trade-in value to deduct from taxable amount. Defaults to 0 if not provided."},{"name":"rate","in":"query","required":false,"schema":{"type":"number","minimum":0,"default":9.99},"description":"Interest rate for financing calculations. Defaults to 9.99 if not provided."},{"name":"downPayment","in":"query","required":false,"schema":{"type":"number","minimum":0,"default":0},"description":"Down payment amount. Defaults to 0 if not provided."},{"name":"months","in":"query","required":false,"schema":{"type":"integer","minimum":1,"default":72},"description":"Loan term in months. Defaults to 72 if not provided."}],"responses":{"200":{"description":"Successfully calculated taxes and fees","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaxesFeesResponse"},"example":{"vehicle":{"vin":"19UDE2F31MA000428","year":2021,"make":"Acura","model":"ILX"},"criteria":{"price":"85000","zip":"90210","docFee":200,"tradeIn":0},"totalTaxesAndFees":9585.5,"taxes":{"citySalesTax":637.5,"combinedSalesTax":8500,"countySalesTax":212.5,"districtSalesTax":2550,"stateSalesTax":5100,"gasGuzzlerTax":0},"fees":{"titleFee":23,"registrationFee":65,"dmvFee":797.5,"combinedFees":1085.5,"docFee":200,"dmvFees":{"Air Quality Fee":6,"Alternative Fuel/Technology Fee":3,"Auto theft deterrence/DUI fee":2,"Fingerprint ID Fee":1,"Highway Patrol Fee":29,"Reflectorized license plate fee":1,"Service Authority for Freeway Emergencies fee":1,"Smog Abatement Fee":12,"Transfer Fee":15,"Transportation Improvement Fee":175,"Vehicle License Fee":552.5}}}}}},"400":{"description":"Invalid VIN format or request parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":{"status":400,"error":"VIN must be exactly 17 characters containing only letters and numbers (excluding I, O, Q)","code":"INVALID_VIN_FORMAT","path":"/taxes/123Invalid","requestId":"a1b2c3d4e5f6g7h8"}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"402":{"$ref":"#/components/responses/PlanRequired"},"404":{"description":"VIN not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":{"status":404,"error":"No vehicle data found for the provided VIN","code":"VIN_NOT_FOUND","path":"/taxes/1FTFW3LDXRFB40317","requestId":"c3d4e5f6g7h8i9j0"}}}}},"429":{"$ref":"#/components/responses/RateLimited"}},"tags":["Financial Calculations"],"operationId":"calculateTaxesAndFees","x-required-plan":"Scale"}}}}