{"openapi":"3.0.0","info":{"title":"Drivly API","version":"2.0.0","description":"Interface for all of our services, including listings, photos, and more."},"servers":[{"url":"https://api.driv.ly","description":"Production server"}],"components":{"schemas":{"API":{"additionalProperties":false,"properties":{"description":{"type":"string"},"from":{"type":"string"},"login":{"type":"string"},"name":{"type":"string"},"repo":{"type":"string"},"signup":{"type":"string"},"type":{"type":"string"},"url":{"type":"string"}},"required":["name","description","url","login","signup","repo","type","from"],"type":"object"},"APIDefinition":{"additionalProperties":false,"properties":{"account":{"type":"string"},"author":{"type":"string"},"build":{"type":"string"},"description":{"type":"string"},"docs":{"type":"string"},"endpoints":{"additionalProperties":{"type":"string"},"type":"object"},"from":{"type":"string"},"icon":{"type":"string"},"license":{"type":"string"},"login":{"type":"string"},"name":{"type":"string"},"prices":{"additionalProperties":{"type":"string"},"type":"object"},"repo":{"type":"string"},"resources":{"additionalProperties":{"type":"string"},"type":"object"},"signup":{"type":"string"},"site":{"type":"string"},"subscribe":{"type":"string"},"type":{"const":"data","type":"string"},"updated":{"type":"string"},"url":{"anyOf":[{"format":"uri","type":"string"},{"type":"string"}]},"version":{"type":"string"}},"type":"object"},"APRResponse":{"additionalProperties":false,"properties":{"apr":{"additionalProperties":{"type":"number"},"type":"object"},"creditScore":{"type":"string"},"vehicle":{"additionalProperties":false,"properties":{"make":{"type":"string"},"model":{"type":"string"},"vin":{"type":"string"},"year":{"type":"number"}},"required":["vin","year","make","model"],"type":"object"},"vehicleAge":{"type":"number"},"vehicleMileage":{"type":"number"},"zip":{"type":"string"}},"required":["vehicle","zip","creditScore","vehicleAge","vehicleMileage","apr"],"type":"object"},"Accept":{"additionalProperties":false,"properties":{"name":{"type":"string"},"q":{"type":"number"},"subtype":{"type":"string"},"suffix":{"type":"string"},"type":{"type":"string"}},"required":["name","type","subtype"],"type":"object"},"AcceptLanguage":{"additionalProperties":false,"properties":{"extendedLanguageSubtags":{"items":{},"type":"array"},"extensions":{"items":{},"type":"array"},"irregular":{"type":"null"},"language":{"type":"string"},"privateuse":{"items":{},"type":"array"},"q":{"type":"number"},"region":{"type":["null","string"]},"regular":{"type":"null"},"script":{"type":"null"},"variants":{"items":{},"type":"array"}},"required":["language","extendedLanguageSubtags","script","region","variants","extensions","privateuse","irregular","regular"],"type":"object"},"AllPhotosResponse":{"additionalProperties":false,"description":"API to search & view photos for any vehicle.","properties":{"data":{"additionalProperties":false,"properties":{"retail":{"description":"Retail Photos","items":{"type":"string"},"type":"array"},"wholesale":{"items":{"type":"string"},"type":"array"}},"type":"object"}},"required":["data"],"type":"object"},"ApiUser":{"additionalProperties":false,"properties":{"accessState":{"enum":["active","suspended"],"type":"string"},"admin":{"type":"boolean"},"authenticated":{"type":"boolean"},"browser":{"type":"string"},"city":{"type":"string"},"continent":{"type":"string"},"country":{"type":"string"},"edgeDistanceKilometers":{"type":"number"},"edgeDistanceMiles":{"type":"number"},"edgeLocation":{"type":"string"},"email":{"type":"string"},"flag":{"type":"string"},"image":{"type":"string"},"ip":{"type":"string"},"isp":{"type":"string"},"latencyMilliseconds":{"type":"number"},"localTime":{"type":"string"},"metro":{"type":"string"},"name":{"type":"string"},"org":{"type":"string"},"os":{"type":"string"},"plan":{"enum":["Free","Starter","Growth","Scale"],"type":"string"},"recentInteractions":{"type":"number"},"region":{"type":"string"},"requestId":{"type":"string"},"serviceLatency":{"type":"number"},"support":{"type":"string"},"timezone":{"type":"string"},"trustScore":{"type":"number"},"upgrade":{"type":"string"},"userAgent":{"type":"string"},"zipcode":{"type":"string"}},"required":["authenticated","plan","os","ip","isp","flag","city","metro","region","country","continent","requestId","localTime","timezone","edgeLocation","latencyMilliseconds","recentInteractions","trustScore"],"type":"object"},"BehaviorType":{"additionalProperties":false,"properties":{"code":{"type":"string"},"id":{"type":"number"}},"required":["id","code"],"type":"object"},"BotManagement":{"additionalProperties":false,"properties":{"corporateProxy":{"type":"boolean"},"detectionIDS":{"$ref":"#/components/schemas/Query"},"jsDetection":{"$ref":"#/components/schemas/JSDetection"},"score":{"type":"number"},"staticResource":{"type":"boolean"},"verifiedBot":{"type":"boolean"}},"required":["corporateProxy","verifiedBot","jsDetection","staticResource","detectionIDS","score"],"type":"object"},"Browser":{"additionalProperties":false,"properties":{"major":{"type":"string"},"name":{"type":"string"},"version":{"type":"string"}},"required":["name","version","major"],"type":"object"},"Build":{"additionalProperties":false,"properties":{"confidence":{"type":"number"},"drivetrain":{"type":"string"},"engine":{"type":"string"},"exteriorColor":{"additionalProperties":{"type":"string"},"type":"object"},"interiorColor":{"additionalProperties":{"type":"string"},"type":"object"},"make":{"type":"string"},"model":{"type":"string"},"options":{"additionalProperties":{"type":"string"},"type":"object"},"series":{"type":"string"},"style":{"type":"string"},"transmission":{"type":"string"},"trim":{"type":"string"},"vin":{"type":"string"},"year":{"type":"number"}},"required":["vin","year","make","model","trim","series","style","drivetrain","engine","transmission","confidence","interiorColor","exteriorColor","options"],"type":"object"},"BuildAPI":{"additionalProperties":false,"properties":{"description":{"type":"string"},"login":{"type":"string"},"name":{"type":"string"},"repo":{"type":"string"},"signup":{"type":"string"},"url":{"type":"string"}},"required":["name","description","url","login","signup","repo"],"type":"object"},"BuildBuild":{"additionalProperties":false,"properties":{"confidence":{"type":"number"},"drivetrain":{"type":"string"},"engine":{"type":"string"},"exteriorColor":{"$ref":"#/components/schemas/ExteriorColor"},"interiorColor":{"$ref":"#/components/schemas/InteriorColor"},"make":{"type":"string"},"model":{"type":"string"},"options":{"$ref":"#/components/schemas/Options"},"series":{"type":"string"},"style":{"type":"string"},"transmission":{"type":"string"},"trim":{"type":"string"},"vin":{"type":"string"},"year":{"type":"number"}},"required":["vin","year","make","model","trim","series","style","drivetrain","engine","transmission","confidence","interiorColor","exteriorColor","options"],"type":"object"},"BuildResponse":{"additionalProperties":false,"properties":{"build":{"$ref":"#/components/schemas/Build"}},"required":["build"],"type":"object"},"BuyResponse":{"additionalProperties":false,"properties":{"actions":{"$ref":"#/components/schemas/BuyResponseActions"},"build":{"$ref":"#/components/schemas/BuyResponseBuild"},"checklist":{"$ref":"#/components/schemas/Checklist"},"creditScore":{"type":"string"},"historicalListings":{"items":{"$ref":"#/components/schemas/HistoricalListing"},"type":"array"},"listing":{"$ref":"#/components/schemas/Listing"},"listingID":{"type":"string"},"miles":{"type":"number"},"payments":{"$ref":"#/components/schemas/Payments"},"price":{"type":"number"},"rates":{"$ref":"#/components/schemas/BuyResponseRates"},"shipping":{"$ref":"#/components/schemas/Shipping"},"vin":{"type":"string"},"vsc":{"$ref":"#/components/schemas/Vsc"},"zip":{"type":"string"}},"required":["vin","zip","creditScore","listingID","price","miles","checklist","actions","payments","build","historicalListings","rates","shipping","vsc","listing"],"type":"object"},"BuyResponseAPI":{"additionalProperties":false,"properties":{"by":{"type":"string"},"description":{"type":"string"},"docs":{"type":"string"},"icon":{"type":"string"},"login":{"type":"string"},"name":{"type":"string"},"url":{"type":"string"}},"required":["icon","name","description","url","login","docs","by"],"type":"object"},"BuyResponseActions":{"additionalProperties":false,"properties":{"changeBuyerZipCode":{"type":"string"},"changeDownPayment":{"type":"string"},"changeLoanTerm":{"type":"string"},"changeProtectionPlan":{"type":"string"},"getTradeInOffer":{"type":"string"}},"required":["changeBuyerZipCode","changeDownPayment","changeLoanTerm","changeProtectionPlan","getTradeInOffer"],"type":"object"},"BuyResponseBuild":{"additionalProperties":false,"properties":{"build":{"$ref":"#/components/schemas/BuildBuild"}},"required":["build"],"type":"object"},"BuyResponseRates":{"additionalProperties":false,"properties":{"terms":{"additionalProperties":{"items":{"$ref":"#/components/schemas/RatesTerm"},"type":"array"},"type":"object"}},"required":["terms"],"type":"object"},"CF":{"additionalProperties":false,"properties":{"asOrganization":{"type":"string"},"asn":{"type":"number"},"botManagement":{"$ref":"#/components/schemas/BotManagement"},"city":{"type":"string"},"clientAcceptEncoding":{"type":"string"},"clientTCPRtt":{"type":"number"},"colo":{"type":"string"},"continent":{"type":"string"},"country":{"type":"string"},"edgeRequestKeepAliveStatus":{"type":"number"},"httpProtocol":{"type":"string"},"latitude":{"type":"string"},"longitude":{"type":"string"},"postalCode":{"type":"string"},"region":{"type":"string"},"regionCode":{"type":"string"},"requestPriority":{"type":"string"},"timezone":{"type":"string"},"tlsCipher":{"type":"string"},"tlsClientAuth":{"$ref":"#/components/schemas/TLSClientAuth"},"tlsClientExtensionsSha1":{"type":"string"},"tlsClientHelloLength":{"type":"string"},"tlsClientRandom":{"type":"string"},"tlsExportedAuthenticator":{"$ref":"#/components/schemas/TLSExportedAuthenticator"},"tlsVersion":{"type":"string"},"verifiedBotCategory":{"type":"string"}},"required":["clientTCPRtt","longitude","httpProtocol","tlsCipher","continent","asn","clientAcceptEncoding","country","verifiedBotCategory","tlsClientAuth","tlsExportedAuthenticator","tlsVersion","city","timezone","colo","tlsClientHelloLength","edgeRequestKeepAliveStatus","postalCode","region","latitude","requestPriority","regionCode","asOrganization","tlsClientExtensionsSha1","tlsClientRandom","botManagement"],"type":"object"},"CPU":{"additionalProperties":false,"properties":{"architecture":{"type":"string"}},"required":["architecture"],"type":"object"},"CalculationCriteria":{"additionalProperties":false,"properties":{"applyLimits":{"type":"boolean"},"conditionalIncentiveAmount":{"type":"number"},"docFee":{"type":"number"},"downPayment":{"type":"number"},"financeRate":{"type":"number"},"lowerLimit":{"type":"boolean"},"marketValue":{"type":"number"},"msrp":{"type":"number"},"numberOfMonths":{"type":"number"},"primaryIncentiveAmount":{"type":"number"},"salesPrice":{"type":"number"},"styleID":{"type":"number"},"tradeIn":{"type":"number"},"tradeInOwedAmount":{"type":"number"},"withConcreteTaxesAndFees":{"type":"boolean"},"zipCode":{"type":"string"}},"required":["numberOfMonths","financeRate","downPayment","tradeIn","tradeInOwedAmount","salesPrice","conditionalIncentiveAmount","primaryIncentiveAmount","docFee","zipCode","styleID","marketValue","withConcreteTaxesAndFees","applyLimits","msrp","lowerLimit"],"type":"object"},"ChangeTradeInValue":{"additionalProperties":{"type":"string"},"type":"object"},"ChangeZip":{"additionalProperties":{"type":"string"},"type":"object"},"Checklist":{"additionalProperties":false,"properties":{"authorizeBankAccount":{"type":"string"},"connectInsuranceAccount":{"type":"string"},"drivewayCelebration":{"type":"string"},"eSignBuyersAgreement":{"type":"string"},"getPreApproved":{"type":"string"},"notarizePowerOfAttorney":{"type":"string"},"trackDelivery":{"type":"string"},"uploadDriversLicense":{"type":"string"}},"required":["getPreApproved","authorizeBankAccount","eSignBuyersAgreement","uploadDriversLicense","notarizePowerOfAttorney","connectInsuranceAccount","trackDelivery","drivewayCelebration"],"type":"object"},"City":{"type":"string"},"CityZips":{"additionalProperties":false,"properties":{"chicagoIL":{"type":"string"},"detroitMI":{"type":"string"},"losAngelesCA":{"type":"string"},"miamiFL":{"type":"string"},"minneapolisMN":{"type":"string"},"newYorkNY":{"type":"string"},"seattleWA":{"type":"string"}},"required":["chicagoIL","detroitMI","losAngelesCA","miamiFL","minneapolisMN","newYorkNY","seattleWA"],"type":"object"},"Code":{"type":"string"},"Colo":{"additionalProperties":false,"properties":{"cca2":{"type":"string"},"city":{"type":"string"},"iata":{"type":"string"},"lat":{"type":"number"},"lon":{"type":"number"},"region":{"type":"string"}},"required":["iata","lat","lon","cca2","region","city"],"type":"object"},"Color":{"additionalProperties":false,"properties":{"exterior":{"items":{"$ref":"#/components/schemas/Terior"},"type":"array"},"interior":{"items":{"$ref":"#/components/schemas/Terior"},"type":"array"}},"required":["exterior","interior"],"type":"object"},"Component":{"additionalProperties":false,"properties":{"description":{"$ref":"#/components/schemas/ComponentDescription"},"lossCodes":{"items":{"$ref":"#/components/schemas/LossCode"},"type":"array"}},"required":["lossCodes","description"],"type":"object"},"ComponentDescription":{"type":"string"},"CreditScores":{"additionalProperties":false,"properties":{"excellent":{"type":"number"},"fair":{"type":"number"},"good":{"type":"number"},"veryGood":{"type":"number"}},"required":["fair","good","veryGood","excellent"],"type":"object"},"Criteria":{"additionalProperties":false,"properties":{"docFee":{"type":"number"},"price":{"type":"number"},"tradeIn":{"type":"number"},"zip":{"type":"string"}},"required":["price","zip","docFee","tradeIn"],"type":"object"},"Crossover":{"additionalProperties":false,"properties":{"id":{"type":"number"},"name":{"type":"string"}},"required":["id","name"],"type":"object"},"CtxResponse":{"additionalProperties":false,"properties":{"accept":{"items":{"$ref":"#/components/schemas/Accept"},"type":"array"},"acceptLanguage":{"items":{"$ref":"#/components/schemas/AcceptLanguage"},"type":"array"},"body":{"type":"string"},"cf":{"$ref":"#/components/schemas/CF"},"checkDigit":{"type":"string"},"checksum":{"type":"boolean"},"cityZips":{"$ref":"#/components/schemas/CityZips"},"colo":{"$ref":"#/components/schemas/Colo"},"cookies":{"type":"null"},"creditScores":{"$ref":"#/components/schemas/CreditScores"},"data":{"$ref":"#/components/schemas/Data"},"emojis":{"$ref":"#/components/schemas/Emojis"},"examples":{"$ref":"#/components/schemas/Examples"},"glyphs":{"$ref":"#/components/schemas/Glyphs"},"hash":{"type":"string"},"headers":{"$ref":"#/components/schemas/Headers"},"hostSegments":{"items":{"type":"string"},"type":"array"},"hostname":{"type":"string"},"infrastructure":{"$ref":"#/components/schemas/Infrastructure"},"instanceCreated":{"type":"number"},"instanceCreatedBy":{"type":"string"},"instanceDiff":{"type":"number"},"instanceDurationMilliseconds":{"type":"number"},"instanceDurationSeconds":{"type":"number"},"instanceID":{"type":"string"},"instancePrefix":{"type":"string"},"instanceRequests":{"type":"number"},"instanceStart":{"type":"number"},"make":{"type":"string"},"method":{"type":"string"},"model":{"type":"string"},"newInstance":{"type":"boolean"},"origin":{"type":"string"},"pathDefaults":{"items":{"type":"string"},"type":"array"},"pathSegments":{"items":{"type":"string"},"type":"array"},"pathname":{"type":"string"},"query":{"$ref":"#/components/schemas/Query"},"rayID":{"type":"string"},"requestID":{"type":"string"},"requestMagicBits":{"type":"string"},"requestMagicPrefix":{"type":"string"},"requestPrefix":{"type":"string"},"requestTimestamp":{"type":"number"},"rootPath":{"type":"boolean"},"search":{"type":"string"},"services":{"$ref":"#/components/schemas/Services"},"squishVin":{"type":"string"},"styleId":{"type":"string"},"styleIds":{"items":{"type":"string"},"type":"array"},"subdomains":{"items":{"type":"string"},"type":"array"},"time":{"format":"date-time","type":"string"},"ts":{"type":"number"},"ua":{"$ref":"#/components/schemas/Ua"},"url":{"type":"string"},"userAgent":{"type":"string"},"vehicle":{"$ref":"#/components/schemas/Vehicle"},"vin":{"type":"string"},"vinValid":{"type":"boolean"},"year":{"type":"string"}},"required":["vin","vinValid","squishVin","checkDigit","checksum","year","make","model","styleId","styleIds","vehicle","examples","data","services","infrastructure","glyphs","emojis","creditScores","cityZips","colo","hostname","pathname","search","hash","origin","query","pathSegments","pathDefaults","rootPath","hostSegments","subdomains","ts","time","body","url","method","userAgent","ua","accept","acceptLanguage","cf","rayID","requestID","requestPrefix","requestTimestamp","requestMagicBits","requestMagicPrefix","instanceID","instanceCreatedBy","instancePrefix","instanceStart","instanceCreated","instanceDiff","instanceDurationMilliseconds","instanceDurationSeconds","instanceRequests","newInstance","headers","cookies"],"type":"object"},"Data":{"additionalProperties":false,"properties":{"bookValuation":{"type":"string"},"historicalPrices":{"type":"string"},"oemBuildData":{"type":"string"},"specifications":{"type":"string"},"totalCostOfOwnership":{"type":"string"},"vehicleHistoryReport":{"type":"string"},"vehicleListings":{"type":"string"},"windowSticker":{"type":"string"}},"required":["oemBuildData","specifications","totalCostOfOwnership","vehicleListings","bookValuation","historicalPrices","vehicleHistoryReport","windowSticker"],"type":"object"},"DataSource":{"type":"string"},"Dealer":{"additionalProperties":false,"properties":{"city":{"$ref":"#/components/schemas/City"},"country":{"type":"string"},"dealerType":{"type":"string"},"id":{"type":"number"},"latitude":{"type":"string"},"longitude":{"type":"string"},"name":{"$ref":"#/components/schemas/Name"},"phone":{"type":"string"},"state":{"$ref":"#/components/schemas/State"},"street":{"type":"string"},"website":{"$ref":"#/components/schemas/Source"},"zip":{"type":"string"}},"required":["id","website","name","dealerType","street","city","state","country","latitude","longitude","zip","phone"],"type":"object"},"Deductible":{"additionalProperties":false,"properties":{"amount":{"type":"number"},"description":{"$ref":"#/components/schemas/DeductibleDescription"},"type":{"$ref":"#/components/schemas/DeductibleType"}},"required":["type"],"type":"object"},"DeductibleDescription":{"type":"string"},"DeductibleType":{"type":"string"},"DmvFees":{"additionalProperties":{"type":"string"},"type":"object"},"DmvFeesItemized":{"additionalProperties":false,"properties":{"name":{"type":"string"},"value":{"type":"number"}},"required":["name","value"],"type":"object"},"DriveTrain":{"additionalProperties":false,"properties":{"centerLimitedSlipDifferential":{"type":"boolean"},"driveType":{"type":"string"},"transmission":{"type":"string"}},"required":["driveType","centerLimitedSlipDifferential","transmission"],"type":"object"},"EdmundsTypeCategories":{"additionalProperties":false,"properties":{"crossover":{"$ref":"#/components/schemas/Crossover"},"suv":{"$ref":"#/components/schemas/Crossover"}},"required":["crossover","suv"],"type":"object"},"Emojis":{"additionalProperties":{"type":"string"},"type":"object"},"Endpoints":{"additionalProperties":false,"properties":{"create":{"type":"string"},"preview":{"type":"string"},"quote":{"type":"string"}},"required":["quote","preview","create"],"type":"object"},"Engine":{"additionalProperties":false,"properties":{"baseEngineSize":{"type":"string"},"baseEngineType":{"type":"string"},"camType":{"type":"string"},"cylinders":{"type":"string"},"directInjection":{"type":"boolean"},"horsepower":{"type":"string"},"torque":{"type":"string"},"valveTiming":{"type":"string"},"valves":{"type":"string"}},"required":["torque","baseEngineSize","horsepower","valves","baseEngineType","directInjection","valveTiming","cylinders","camType"],"type":"object"},"Eta":{"additionalProperties":false,"properties":{"max":{"type":"number"},"min":{"type":"number"}},"required":["min","max"],"type":"object"},"Examples":{"additionalProperties":{"type":"string"},"type":"object"},"ExteriorColor":{"additionalProperties":{"type":"string"},"type":"object"},"Extra":{"additionalProperties":false,"properties":{"features":{"items":{"type":"string"},"type":"array"},"highValueFeatures":{"items":{"$ref":"#/components/schemas/HighValueFeature"},"type":"array"},"optionsPackages":{"items":{"type":"string"},"type":"array"}},"required":["features","highValueFeatures","optionsPackages"],"type":"object"},"Fees":{"additionalProperties":false,"properties":{"combinedFees":{"type":"number"},"dmvFee":{"type":"number"},"dmvFees":{"$ref":"#/components/schemas/DmvFees"},"docFee":{"type":"number"},"registrationFee":{"type":"number"},"titleFee":{"type":"number"}},"required":["titleFee","registrationFee","dmvFee","combinedFees","docFee","dmvFees"],"type":"object"},"Frontseats":{"additionalProperties":false,"properties":{"bucketFrontSeats":{"type":"boolean"},"driverSeatWithPowerAdjustableLumbarSupport":{"type":"boolean"},"frontHeadRoom":{"type":"string"},"frontHipRoom":{"type":"string"},"frontLegRoom":{"type":"string"},"frontShoulderRoom":{"type":"string"},"heightAdjustableDriverSeat":{"type":"boolean"},"premiumCloth":{"type":"boolean"},"the4WayManualPassengerSeatAdjustment":{"type":"boolean"},"the8WayPowerDriverSeat":{"type":"boolean"}},"required":["frontHeadRoom","premiumCloth","bucketFrontSeats","the4WayManualPassengerSeatAdjustment","heightAdjustableDriverSeat","frontShoulderRoom","driverSeatWithPowerAdjustableLumbarSupport","the8WayPowerDriverSeat","frontLegRoom","frontHipRoom"],"type":"object"},"Fuel":{"additionalProperties":false,"properties":{"epaCityHighwayMpg":{"type":"string"},"epaCombinedMpg":{"type":"string"},"fuelTankCapacity":{"type":"string"},"fuelType":{"type":"string"},"rangeInMilesCityHwy":{"type":"string"}},"required":["epaCombinedMpg","epaCityHighwayMpg","rangeInMilesCityHwy","fuelTankCapacity","fuelType"],"type":"object"},"Glyphs":{"additionalProperties":{"type":"string"},"type":"object"},"Headers":{"additionalProperties":false,"properties":{"accept":{"type":"string"},"acceptEncoding":{"type":"string"},"acceptLanguage":{"type":"string"},"cfConnectingIP":{"type":"string"},"cfIpcountry":{"type":"string"},"cfRay":{"type":"string"},"cfVisitor":{"type":"string"},"connection":{"type":"string"},"dnt":{"type":"string"},"host":{"type":"string"},"priority":{"type":"string"},"secFetchDest":{"type":"string"},"secFetchMode":{"type":"string"},"secFetchSite":{"type":"string"},"secFetchUser":{"type":"string"},"secGpc":{"type":"string"},"upgradeInsecureRequests":{"type":"string"},"userAgent":{"type":"string"},"xForwardedProto":{"type":"string"},"xRealIP":{"type":"string"}},"required":["accept","acceptEncoding","acceptLanguage","cfConnectingIP","cfIpcountry","cfRay","cfVisitor","connection","dnt","host","priority","secFetchDest","secFetchMode","secFetchSite","secFetchUser","secGpc","upgradeInsecureRequests","userAgent","xForwardedProto","xRealIP"],"type":"object"},"HighValueFeature":{"additionalProperties":false,"properties":{"category":{"type":"string"},"description":{"type":"string"},"type":{"$ref":"#/components/schemas/HighValueFeatureType"}},"required":["category","description","type"],"type":"object"},"HighValueFeatureType":{"type":"string"},"HistoricalListing":{"additionalProperties":false,"properties":{"city":{"$ref":"#/components/schemas/City"},"dataSource":{"$ref":"#/components/schemas/DataSource"},"firstSeenAt":{"type":"number"},"firstSeenAtDate":{"format":"date-time","type":"string"},"id":{"type":"string"},"inventoryType":{"$ref":"#/components/schemas/InventoryType"},"lastSeenAt":{"type":"number"},"lastSeenAtDate":{"format":"date-time","type":"string"},"miles":{"type":"number"},"price":{"type":"number"},"scrapedAt":{"type":"number"},"scrapedAtDate":{"format":"date-time","type":"string"},"sellerName":{"$ref":"#/components/schemas/Name"},"sellerType":{"$ref":"#/components/schemas/SellerType"},"source":{"$ref":"#/components/schemas/Source"},"state":{"$ref":"#/components/schemas/State"},"statusDate":{"type":"number"},"vdpURL":{"type":"string"},"zip":{"type":"string"}},"required":["id","dataSource","vdpURL","sellerType","inventoryType","lastSeenAt","lastSeenAtDate","scrapedAt","scrapedAtDate","firstSeenAt","firstSeenAtDate","source","sellerName","city","state","zip","statusDate"],"type":"object"},"InCarEntertainment":{"additionalProperties":{"type":"string"},"type":"object"},"Incentive":{"additionalProperties":false,"properties":{"apr":{"type":"number"},"aprDescription":{"type":"string"},"bulletPoints":{"items":{"type":"string"},"type":"array"},"cashDescription":{"type":"string"},"conditionalCash":{"type":"number"},"conditionalDescription":{"type":"string"},"costPerMile":{"type":"number"},"disclaimer":{"type":"string"},"display":{"type":"boolean"},"dispositionFee":{"type":"number"},"endDate":{"type":"string"},"leaseDescription":{"type":"string"},"make":{"type":"string"},"manufactName":{"type":"string"},"model":{"type":"string"},"msrp":{"type":"number"},"payment":{"type":"number"},"per1000":{"type":"number"},"term":{"type":"number"},"title":{"type":"string"},"totalCash":{"type":"number"},"totalPayments":{"type":"number"},"type":{"type":"string"},"vehicle":{"additionalProperties":false,"properties":{"make":{"type":"string"},"model":{"type":"string"},"year":{"type":"string"}},"type":"object"},"webURL":{"type":"string"},"year":{"type":"string"}},"type":"object"},"Infrastructure":{"additionalProperties":false,"properties":{"authenticate":{"type":"string"},"cryptoHash":{"type":"string"},"keyValueStore":{"type":"string"}},"required":["authenticate","keyValueStore","cryptoHash"],"type":"object"},"Instrumentation":{"additionalProperties":false,"properties":{"clock":{"type":"boolean"},"compass":{"type":"boolean"},"externalTemperatureDisplay":{"type":"boolean"},"tachometer":{"type":"boolean"},"tripComputer":{"type":"boolean"}},"required":["clock","compass","externalTemperatureDisplay","tripComputer","tachometer"],"type":"object"},"InteriorColor":{"additionalProperties":{"type":"string"},"type":"object"},"InteriorOptions":{"additionalProperties":{"type":"string"},"type":"object"},"InventoryType":{"type":"string"},"JSDetection":{"additionalProperties":false,"properties":{"passed":{"type":"boolean"}},"required":["passed"],"type":"object"},"LimitCriteria":{"additionalProperties":false,"properties":{"limitPercentage":{"type":"number"},"limitPrice":{"type":"number"},"limits":{"items":{},"type":"array"}},"required":["limitPercentage","limitPrice","limits"],"type":"object"},"Links":{"additionalProperties":false,"properties":{"changePrice":{"$ref":"#/components/schemas/DmvFees"},"changeTradeInValue":{"$ref":"#/components/schemas/ChangeTradeInValue"},"changeZip":{"$ref":"#/components/schemas/ChangeZip"}},"required":["changePrice","changeZip","changeTradeInValue"],"type":"object"},"Listing":{"additionalProperties":false,"properties":{"baseEXTColor":{"type":"string"},"baseIntColor":{"type":"string"},"build":{"$ref":"#/components/schemas/ListingBuild"},"carfax1Owner":{"type":"boolean"},"carfaxCleanTitle":{"type":"boolean"},"dataSource":{"$ref":"#/components/schemas/DataSource"},"dealer":{"$ref":"#/components/schemas/Dealer"},"dom":{"type":"number"},"dom180":{"type":"number"},"domActive":{"type":"number"},"dosActive":{"type":"number"},"exteriorColor":{"type":"string"},"extra":{"$ref":"#/components/schemas/Extra"},"firstSeenAt":{"type":"number"},"firstSeenAtDate":{"format":"date-time","type":"string"},"firstSeenAtMc":{"type":"number"},"firstSeenAtMcDate":{"format":"date-time","type":"string"},"firstSeenAtSource":{"type":"number"},"firstSeenAtSourceDate":{"format":"date-time","type":"string"},"heading":{"type":"string"},"id":{"type":"string"},"inTransit":{"type":"boolean"},"interiorColor":{"type":"string"},"inventoryType":{"$ref":"#/components/schemas/InventoryType"},"lastSeenAt":{"type":"number"},"lastSeenAtDate":{"format":"date-time","type":"string"},"media":{"$ref":"#/components/schemas/Media"},"miles":{"type":"number"},"msrp":{"type":"number"},"price":{"type":"number"},"priceChangePercent":{"type":"number"},"refMiles":{"type":"number"},"refMilesDt":{"type":"number"},"refPrice":{"type":"number"},"refPriceDt":{"type":"number"},"scrapedAt":{"type":"number"},"scrapedAtDate":{"format":"date-time","type":"string"},"sellerType":{"$ref":"#/components/schemas/SellerType"},"source":{"$ref":"#/components/schemas/Source"},"stockNo":{"type":"string"},"vdpURL":{"type":"string"},"vin":{"type":"string"}},"required":["id","vin","heading","price","priceChangePercent","miles","msrp","dataSource","vdpURL","carfax1Owner","carfaxCleanTitle","exteriorColor","interiorColor","baseIntColor","baseEXTColor","dom","dom180","domActive","dosActive","sellerType","inventoryType","stockNo","lastSeenAt","lastSeenAtDate","scrapedAt","scrapedAtDate","firstSeenAt","firstSeenAtDate","firstSeenAtMc","firstSeenAtMcDate","firstSeenAtSource","firstSeenAtSourceDate","refPrice","refPriceDt","refMiles","refMilesDt","source","inTransit","media","extra","dealer","build"],"type":"object"},"ListingBuild":{"additionalProperties":false,"properties":{"bodyType":{"type":"string"},"cityMpg":{"type":"number"},"cylinders":{"type":"number"},"doors":{"type":"number"},"drivetrain":{"type":"string"},"engine":{"type":"string"},"engineSize":{"type":"number"},"fuelType":{"type":"string"},"highwayMpg":{"type":"number"},"madeIn":{"type":"string"},"make":{"type":"string"},"model":{"type":"string"},"overallHeight":{"type":"string"},"overallLength":{"type":"string"},"overallWidth":{"type":"string"},"powertrainType":{"type":"string"},"stdSeating":{"type":"string"},"transmission":{"type":"string"},"trim":{"type":"string"},"vehicleType":{"type":"string"},"version":{"type":"string"},"year":{"type":"number"}},"required":["year","make","model","trim","version","bodyType","vehicleType","transmission","drivetrain","fuelType","engine","engineSize","doors","cylinders","madeIn","overallHeight","overallLength","overallWidth","stdSeating","highwayMpg","cityMpg","powertrainType"],"type":"object"},"LossCode":{"additionalProperties":false,"properties":{"code":{"$ref":"#/components/schemas/Code"},"coverageLossCodeID":{"type":"number"},"dealerCost":{"type":"number"},"description":{"$ref":"#/components/schemas/LossCodeDescription"},"isSelectable":{"type":"boolean"},"isSelected":{"type":"boolean"},"isSurcharge":{"type":"boolean"},"suggestedRetailCost":{"type":"number"}},"required":["coverageLossCodeID","isSelected","isSelectable","dealerCost","suggestedRetailCost","code","description","isSurcharge"],"type":"object"},"LossCodeDescription":{"type":"string"},"Measurements":{"additionalProperties":false,"properties":{"cargoCapacityAllSeatsInPlace":{"type":"string"},"countryOfFinalAssembly":{"type":"string"},"curbWeight":{"type":"string"},"grossWeight":{"type":"string"},"height":{"type":"string"},"length":{"type":"string"},"maximumCargoCapacity":{"type":"string"},"maximumPayload":{"type":"string"},"maximumTowingCapacity":{"type":"string"},"overallWidthWithoutMirrors":{"type":"string"},"turningCircle":{"type":"string"},"wheelbase":{"type":"string"}},"required":["maximumCargoCapacity","countryOfFinalAssembly","wheelbase","curbWeight","grossWeight","cargoCapacityAllSeatsInPlace","maximumPayload","length","maximumTowingCapacity","turningCircle","height","overallWidthWithoutMirrors"],"type":"object"},"MechanicalOptions":{"additionalProperties":{"type":"boolean"},"type":"object"},"Media":{"additionalProperties":false,"properties":{"photoLinks":{"items":{"type":"string"},"type":"array"}},"required":["photoLinks"],"type":"object"},"Name":{"type":"string"},"OpenRecalls":{"additionalProperties":false,"description":"A single recall record. The populated field set depends on the upstream source: OEM manufacturer portals return the OEM block (recallDescription, defectSummary, correctiveAction, mfrNotes, status, pdf, source, …); NHTSA's per-VIN feed returns the NHTSA block (manufacturer, component, consequence, remedy, parkIt, remedyAvailable, …). Identifiers are always present; the rest are source-dependent and therefore optional.","properties":{"component":{"type":"string"},"consequence":{"type":"string"},"consequenceSummary":{"type":"string"},"correctiveAction":{"type":"string"},"defectSummary":{"type":"string"},"make":{"type":"string"},"manufacturer":{"type":"string"},"mfrCampaignNumber":{"description":"Manufacturer's own campaign id, e.g. \"12D\".","type":"string"},"mfrNotes":{"type":"string"},"model":{"type":"string"},"modelYear":{"type":"string"},"nhtsaCampaignNumber":{"description":"NHTSA campaign id, e.g. \"25V170\" (may be empty for OEM-only campaigns).","type":"string"},"notes":{"type":"string"},"overTheAirUpdate":{"description":"Resolvable via OTA software update without a dealer visit.","type":"boolean"},"parkIt":{"description":"Do-not-drive safety flag.","type":"boolean"},"parkOutSide":{"description":"Park-away-from-structures (fire/explosion) safety flag.","type":"boolean"},"pdf":{"description":"Link to the manufacturer's recall PDF, when available.","type":"string"},"recallDate":{"type":"string"},"recallDescription":{"type":"string"},"remedy":{"type":"string"},"remedyAvailable":{"description":"True when the remedy/parts are available at dealers now.","type":"boolean"},"reportReceivedDate":{"type":"string"},"source":{"description":"Upstream source identifier, e.g. \"mopar-recallinfo\".","type":"string"},"status":{"description":"Status as reported by the source (\"Open\", \"Closed\", \"Recall Incomplete\", \"Completed\", …).","type":"string"},"summary":{"description":"Short title / summary of the campaign.","type":"string"}},"required":["nhtsaCampaignNumber"],"type":"object"},"OpenRecallsResponse":{"additionalProperties":false,"properties":{"data":{"description":"Open recalls for this specific VIN. Closed/remedied campaigns are excluded.","items":{"$ref":"#/components/schemas/OpenRecalls"},"type":"array"},"examples":{"additionalProperties":{"type":"string"},"description":"Navigation links to related resources.","type":"object"},"openRecalls":{"description":"Number of open recalls — equals `data.length`.","type":"number"},"recalls":{"description":"Full make/model/year recall catalog (open + closed). Present only when the request includes `?recalls=true`.","items":{"$ref":"#/components/schemas/OpenRecalls"},"type":"array"},"retrievedAt":{"description":"ISO 8601 timestamp of when the returned recall data was fetched from upstream. Recall data is cached until the next daily refresh, so this is how you tell how current the answer is; pass `?skipCache=true` to force a fresh fetch. `null` when the answer wasn't sourced from a cacheable upstream.","type":["string","null"]},"status":{"description":"Human-readable summary, e.g. \"1 Open Recall\" or \"No Open Recalls\".","type":"string"},"totalRecalls":{"description":"Total campaigns issued for this year/make/model, including ones already remedied for this VIN, so it can exceed `openRecalls`.","type":"number"},"vehicle":{"additionalProperties":false,"description":"Decoded vehicle the recalls pertain to.","properties":{"make":{"type":"string"},"model":{"type":"string"},"vin":{"type":"string"},"year":{"type":"string"}},"required":["year","make","model","vin"],"type":"object"}},"required":["vehicle","data","status","openRecalls","totalRecalls","retrievedAt"],"type":"object"},"Options":{"additionalProperties":{"type":"string"},"type":"object"},"OrderedFeature":{"additionalProperties":false,"properties":{"category":{"type":"string"},"categoryGroup":{"type":"string"},"features":{"$ref":"#/components/schemas/OrderedFeatureFeatures"}},"required":["category","categoryGroup","features"],"type":"object"},"OrderedFeatureFeatures":{"additionalProperties":{"type":["string","boolean"]},"type":"object"},"Payments":{"additionalProperties":false,"properties":{"calculationCriteria":{"$ref":"#/components/schemas/CalculationCriteria"},"fees":{"$ref":"#/components/schemas/Fees"},"limitCriteria":{"$ref":"#/components/schemas/LimitCriteria"},"loanAmount":{"type":"number"},"loanMonthlyPayment":{"type":"number"},"loanMonthlyPaymentWithTaxes":{"type":"number"},"taxes":{"$ref":"#/components/schemas/Taxes"},"totalTaxesAndFees":{"type":"number"}},"required":["loanAmount","loanMonthlyPayment","loanMonthlyPaymentWithTaxes","totalTaxesAndFees","taxes","fees","calculationCriteria","limitCriteria"],"type":"object"},"PaymentsData":{"additionalProperties":false,"properties":{"calculationCriteria":{"$ref":"#/components/schemas/CalculationCriteria"},"fees":{"$ref":"#/components/schemas/Fees"},"limitCriteria":{"$ref":"#/components/schemas/LimitCriteria"},"loanAmount":{"type":"number"},"loanMonthlyPayment":{"type":"number"},"loanMonthlyPaymentWithTaxes":{"type":"number"},"taxes":{"$ref":"#/components/schemas/Taxes"},"totalTaxesAndFees":{"type":"number"}},"required":["loanAmount","loanMonthlyPayment","loanMonthlyPaymentWithTaxes","totalTaxesAndFees","taxes","fees","calculationCriteria","limitCriteria"],"type":"object"},"PaymentsResponse":{"additionalProperties":false,"properties":{"apr":{"additionalProperties":{"type":"number"},"type":"object"},"criteria":{"$ref":"#/components/schemas/Criteria"},"fees":{"$ref":"#/components/schemas/Fees"},"paymentsData":{"$ref":"#/components/schemas/PaymentsData"},"services":{"$ref":"#/components/schemas/Services"},"taxes":{"$ref":"#/components/schemas/Taxes"},"totalTaxesAndFees":{"type":"number"},"vehicle":{"$ref":"#/components/schemas/Vehicle"}},"required":["vehicle","criteria","paymentsData","apr","totalTaxesAndFees","taxes","fees","services"],"type":"object"},"PhotosResponse":{"additionalProperties":false,"properties":{"data":{"items":{"type":"string"},"type":"array"},"examples":{"additionalProperties":{"type":"string"},"type":"object"}},"type":"object"},"PowerFeature":{"additionalProperties":{"type":"boolean"},"type":"object"},"Price":{"additionalProperties":false,"properties":{"baseInvoice":{"type":"number"},"baseMsrp":{"type":"number"}},"required":["baseMsrp","baseInvoice"],"type":"object"},"ProductType":{"additionalProperties":false,"properties":{"behaviorType":{"$ref":"#/components/schemas/BehaviorType"},"code":{"type":"string"},"description":{"type":"string"}},"required":["code","description","behaviorType"],"type":"object"},"Properties":{"additionalProperties":false,"properties":{"aspiration":{"type":"string"},"body":{"type":"string"},"bodyStyle":{"type":"string"},"cc":{"type":"number"},"cylinders":{"type":"string"},"drivingWheels":{"type":"string"},"engineBlock":{"type":"string"},"fuel":{"type":"string"},"grossVehicleWeight":{"type":"string"},"isNitrogenInstalled":{"type":"boolean"},"segmentation":{"type":"string"},"tiresOption":{"type":"string"},"tonRating":{"type":"string"},"transmission":{"type":"string"}},"required":["segmentation","fuel","aspiration","grossVehicleWeight","tonRating","cc","bodyStyle","engineBlock","body","transmission","tiresOption","cylinders","drivingWheels","isNitrogenInstalled"],"type":"object"},"ProviderCode":{"type":"string"},"Query":{"additionalProperties":{"type":"string"},"type":"object"},"QueryEngineResponse":{"additionalProperties":false,"properties":{"data":{"items":{"$ref":"#/components/schemas/Row"},"type":"array"},"facets":{"additionalProperties":{"anyOf":[{"additionalProperties":{"type":"string"},"type":"object"},{"not":{}}]},"type":"object"},"links":{"additionalProperties":false,"properties":{"first":{"type":"string"},"home":{"type":"string"},"last":{"type":"string"},"next":{"type":"string"},"prev":{"type":"string"},"self":{"type":"string"},"toggleFacets":{"type":"string"},"toggleTotal":{"type":"string"}},"type":"object"},"total":{"type":"number"},"totalFormatted":{"type":"string"}},"required":["links","data"],"type":"object"},"Rate":{"additionalProperties":false,"properties":{"code":{"type":"string"},"description":{"type":"string"},"groupCode":{"type":"string"},"groupDescription":{"type":"string"},"isBrochure":{"type":"boolean"},"minimumServicesRequired":{"type":"number"},"productType":{"$ref":"#/components/schemas/ProductType"},"providerCode":{"$ref":"#/components/schemas/ProviderCode"},"rateBookCode":{"$ref":"#/components/schemas/RateBookCode"},"rateBookDescription":{"$ref":"#/components/schemas/RateBookDescription"},"showAsUpgrade":{"type":"boolean"},"terms":{"items":{"$ref":"#/components/schemas/RateTerm"},"type":"array"},"vehicleAgeType":{"$ref":"#/components/schemas/VehicleAgeType"},"vehicleClass":{"type":"string"},"vehicleTier":{"type":"string"}},"required":["code","description","productType","vehicleAgeType","groupCode","groupDescription","vehicleClass","vehicleTier","providerCode","minimumServicesRequired","isBrochure","terms","rateBookCode","rateBookDescription","showAsUpgrade"],"type":"object"},"RateBookCode":{"type":"string"},"RateBookDescription":{"type":"string"},"RateTerm":{"additionalProperties":false,"properties":{"components":{"items":{"$ref":"#/components/schemas/Component"},"type":"array"},"customerValue":{"type":"number"},"dealerCost":{"type":"number"},"dealerPackAmount":{"type":"number"},"dealerRemit":{"type":"number"},"deductible":{"$ref":"#/components/schemas/Deductible"},"fiMarkup":{"type":"number"},"suggestedRetailCost":{"type":"number"},"termMonths":{"type":"number"},"termOdometer":{"type":"number"}},"required":["termOdometer","components","termMonths","dealerRemit","dealerCost","dealerPackAmount","fiMarkup","suggestedRetailCost","customerValue","deductible"],"type":"object"},"RatesTerm":{"additionalProperties":false,"properties":{"apr":{"type":"number"},"id":{"type":"null"}},"required":["id","apr"],"type":"object"},"Rearseats":{"additionalProperties":{"type":["string","boolean"]},"type":"object"},"Recalls":{"additionalProperties":false,"properties":{"NHTSACampaignNumber":{"type":"string"},"component":{"type":"string"},"consequence":{"type":"string"},"make":{"type":"string"},"manufacturer":{"type":"string"},"model":{"type":"string"},"modelYear":{"type":"string"},"nHTSAActionNumber":{"type":"string"},"notes":{"type":"string"},"overTheAirUpdate":{"type":"boolean"},"parkIt":{"type":"boolean"},"parkOutSide":{"type":"boolean"},"remedy":{"type":"string"},"reportReceivedDate":{"type":"string"},"summary":{"type":"string"}},"required":["manufacturer","NHTSACampaignNumber","parkIt","parkOutSide","overTheAirUpdate","reportReceivedDate","component","summary","consequence","remedy","notes","modelYear","make","model"],"type":"object"},"RecallsResponse":{"additionalProperties":false,"properties":{"data":{"items":{"$ref":"#/components/schemas/Recalls"},"type":"array"},"success":{"type":"boolean"}},"required":["success","data"],"type":"object"},"RoadsideAssistance":{"type":["boolean","string"]},"Row":{"additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]},"description":"Represents a single row in Clickhouse.\n\nThis is a generic type, and can be used to represent any row in any table.","examples":[{"make":"Honda","model":"Accord","nested":{"key":"value"},"vin":"1HGCM...","year":2021}],"type":"object"},"SellerType":{"type":"string"},"Services":{"additionalProperties":false,"properties":{"buyVehicle":{"type":"string"},"connectYourVehicle":{"type":"string"},"financeInsurance":{"type":"string"},"getPreApproved":{"type":"string"},"getVehicleServiceContract":{"type":"string"},"inspectVehicle":{"type":"string"},"insureVehicle":{"type":"string"},"transportVehicle":{"type":"string"}},"required":["inspectVehicle","transportVehicle","connectYourVehicle","getPreApproved","insureVehicle","financeInsurance","buyVehicle","getVehicleServiceContract"],"type":"object"},"Shipping":{"additionalProperties":false,"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"required":["errors"],"type":"object"},"Source":{"type":"string"},"Specs":{"additionalProperties":false,"properties":{"color":{"$ref":"#/components/schemas/Color"},"edmundsTypeCategories":{"$ref":"#/components/schemas/EdmundsTypeCategories"},"features":{"$ref":"#/components/schemas/SpecsFeatures"},"name":{"type":"string"},"orderedFeatures":{"items":{"$ref":"#/components/schemas/OrderedFeature"},"type":"array"},"price":{"$ref":"#/components/schemas/Price"},"styleAttributes":{"$ref":"#/components/schemas/StyleAttributes"},"totalSeating":{"type":"number"}},"required":["name","price","totalSeating","color","features","orderedFeatures","edmundsTypeCategories","styleAttributes"],"type":"object"},"SpecsFeatures":{"additionalProperties":false,"properties":{"comfortConvenience":{"additionalProperties":{"type":"boolean"},"type":"object"},"driveTrain":{"$ref":"#/components/schemas/DriveTrain"},"engine":{"$ref":"#/components/schemas/Engine"},"exteriorOptions":{"additionalProperties":{"type":"boolean"},"type":"object"},"frontseats":{"$ref":"#/components/schemas/Frontseats"},"fuel":{"$ref":"#/components/schemas/Fuel"},"inCarEntertainment":{"$ref":"#/components/schemas/InCarEntertainment"},"instrumentation":{"$ref":"#/components/schemas/Instrumentation"},"interiorOptions":{"$ref":"#/components/schemas/InteriorOptions"},"measurements":{"$ref":"#/components/schemas/Measurements"},"mechanicalOptions":{"$ref":"#/components/schemas/MechanicalOptions"},"packages":{"additionalProperties":{"type":"boolean"},"type":"object"},"powerFeature":{"$ref":"#/components/schemas/PowerFeature"},"rearseats":{"$ref":"#/components/schemas/Rearseats"},"safety":{"additionalProperties":{"type":"boolean"},"type":"object"},"suspension":{"$ref":"#/components/schemas/Suspension"},"telematics":{"$ref":"#/components/schemas/Telematics"},"tiresAndWheels":{"$ref":"#/components/schemas/TiresAndWheels"},"warranty":{"$ref":"#/components/schemas/Warranty"}},"required":["powerFeature","mechanicalOptions","rearseats","warranty","measurements","comfortConvenience","exteriorOptions","driveTrain","suspension","instrumentation","inCarEntertainment","frontseats","packages","fuel","telematics","safety","tiresAndWheels","engine","interiorOptions"],"type":"object"},"SpecsResponse":{"additionalProperties":false,"properties":{"specs":{"$ref":"#/components/schemas/Specs"},"vehicle":{"$ref":"#/components/schemas/Vehicle"}},"required":["vehicle","specs"],"type":"object"},"State":{"$ref":"#/components/schemas/States"},"States":{"enum":["AL","AK","AZ","AR","CA","CO","CT","DE","FL","GA","HI","ID","IL","IN","IA","KS","KY","LA","ME","MD","MA","MI","MN","MS","MO","MT","NE","NV","NH","NJ","NM","NY","NC","ND","OH","OK","OR","PA","RI","SC","SD","TN","TX","UT","VT","VA","WA","WV","WI","WY","DC"],"type":"string"},"StyleAttributes":{"additionalProperties":false,"properties":{"electric":{"type":"boolean"},"pluginElectric":{"type":"boolean"},"truck":{"type":"boolean"}},"required":["truck","electric","pluginElectric"],"type":"object"},"Suspension":{"additionalProperties":{"type":"boolean"},"type":"object"},"TLSClientAuth":{"additionalProperties":false,"properties":{"certFingerprintSHA1":{"type":"string"},"certFingerprintSHA256":{"type":"string"},"certIssuerDN":{"type":"string"},"certIssuerDNLegacy":{"type":"string"},"certIssuerDNRFC2253":{"type":"string"},"certIssuerSKI":{"type":"string"},"certIssuerSerial":{"type":"string"},"certNotAfter":{"type":"string"},"certNotBefore":{"type":"string"},"certPresented":{"type":"string"},"certRevoked":{"type":"string"},"certSKI":{"type":"string"},"certSerial":{"type":"string"},"certSubjectDN":{"type":"string"},"certSubjectDNLegacy":{"type":"string"},"certSubjectDNRFC2253":{"type":"string"},"certVerified":{"type":"string"}},"required":["certIssuerDNLegacy","certIssuerSKI","certSubjectDNRFC2253","certSubjectDNLegacy","certFingerprintSHA256","certNotBefore","certSKI","certSerial","certIssuerDN","certVerified","certNotAfter","certSubjectDN","certPresented","certRevoked","certIssuerSerial","certIssuerDNRFC2253","certFingerprintSHA1"],"type":"object"},"TLSExportedAuthenticator":{"additionalProperties":false,"properties":{"clientFinished":{"type":"string"},"clientHandshake":{"type":"string"},"serverFinished":{"type":"string"},"serverHandshake":{"type":"string"}},"required":["clientFinished","clientHandshake","serverHandshake","serverFinished"],"type":"object"},"Taxes":{"additionalProperties":false,"properties":{"combinedSalesTax":{"type":"number"},"gasGuzzlerTax":{"type":"number"},"stateSalesTax":{"type":"number"}},"required":["combinedSalesTax","stateSalesTax","gasGuzzlerTax"],"type":"object"},"TaxesQuery":{"additionalProperties":false,"properties":{"tradeIn":{"description":"Change the Trade-In value of the vehicle, if applicable.","type":"number"},"zip":{"description":"Change the ZIP code to calculate taxes and fees for a different location.","type":"string"}},"required":["zip","tradeIn"],"type":"object"},"TaxesResponse":{"additionalProperties":false,"properties":{"criteria":{"$ref":"#/components/schemas/Criteria"},"data":{"$ref":"#/components/schemas/Data"},"fees":{"$ref":"#/components/schemas/Fees"},"links":{"$ref":"#/components/schemas/Links"},"services":{"$ref":"#/components/schemas/Services"},"taxes":{"$ref":"#/components/schemas/Taxes"},"totalTaxesAndFees":{"type":"number"},"vehicle":{"$ref":"#/components/schemas/Vehicle"}},"required":["vehicle","criteria","totalTaxesAndFees","taxes","fees","links","data","services"],"type":"object"},"Telematics":{"additionalProperties":{"type":"boolean"},"type":"object"},"Terior":{"additionalProperties":false,"properties":{"name":{"type":"string"},"rgb":{"type":"string"}},"required":["name","rgb"],"type":"object"},"TiresAndWheels":{"additionalProperties":{"type":"boolean"},"type":"object"},"Transport":{"additionalProperties":false,"properties":{"available":{"type":"string"},"distance":{"type":"number"},"enclosedTrailer":{"type":"boolean"},"eta":{"$ref":"#/components/schemas/Eta"},"expiration":{"format":"date-time","type":"string"},"fromZip":{"type":"string"},"hasKeys":{"type":"boolean"},"id":{"type":"string"},"price":{"type":"number"},"rushEta":{"$ref":"#/components/schemas/Eta"},"rushPrice":{"type":"number"},"standardEta":{"$ref":"#/components/schemas/Eta"},"toZip":{"type":"string"},"vehicleOperational":{"type":"boolean"}},"required":["id","fromZip","toZip","price","rushPrice","eta","distance","expiration","vehicleOperational","hasKeys","enclosedTrailer"],"type":"object"},"TransportResponse":{"additionalProperties":false,"properties":{"transport":{"$ref":"#/components/schemas/Transport"},"vehicle":{"$ref":"#/components/schemas/Vehicle"}},"required":["vehicle","transport"],"type":"object"},"Ua":{"additionalProperties":false,"properties":{"browser":{"$ref":"#/components/schemas/Browser"},"cpu":{"$ref":"#/components/schemas/CPU"},"device":{"$ref":"#/components/schemas/Query"},"engine":{"$ref":"#/components/schemas/Engine"},"os":{"$ref":"#/components/schemas/Engine"},"ua":{"type":"string"}},"required":["ua","browser","engine","os","device","cpu"],"type":"object"},"Vehicle":{"additionalProperties":false,"properties":{"make":{"type":"string"},"manufacturer":{"type":"string"},"model":{"type":"string"},"vin":{"type":"string"},"year":{"type":"number"}},"required":["vin","year","make","model","manufacturer"],"type":"object"},"VehicleAgeType":{"type":"string"},"Vsc":{"additionalProperties":false,"properties":{"rates":{"$ref":"#/components/schemas/VscRates"},"requestBody":{"type":"string"}},"required":["rates","requestBody"],"type":"object"},"VscAPI":{"additionalProperties":false,"properties":{"description":{"type":"string"},"endpoints":{"$ref":"#/components/schemas/Endpoints"},"icon":{"type":"string"},"login":{"type":"string"},"name":{"type":"string"},"repo":{"type":"string"},"signup":{"type":"string"},"site":{"type":"string"},"subscribe":{"type":"string"},"type":{"type":"string"},"url":{"type":"string"}},"required":["icon","name","description","url","type","endpoints","site","login","signup","subscribe","repo"],"type":"object"},"VscRates":{"additionalProperties":false,"properties":{"containers":{"items":{},"type":"array"},"correlationID":{"type":"string"},"manufactureWarranties":{"items":{},"type":"array"},"rates":{"items":{"$ref":"#/components/schemas/Rate"},"type":"array"},"totalRecordCount":{"type":"number"},"vehicle":{"additionalProperties":false,"properties":{"inServiceDate":{"format":"date-time","type":"string"},"make":{"type":"string"},"model":{"type":"string"},"properties":{"$ref":"#/components/schemas/Properties"},"vehicleAgeType":{"type":"string"},"vehicleType":{"type":"string"},"vehicleYear":{"type":"number"},"vin":{"type":"string"}},"required":["vin","vehicleAgeType","inServiceDate","properties","vehicleType","make","model","vehicleYear"],"type":"object"}},"required":["vehicle","rates","containers","manufactureWarranties","totalRecordCount","correlationID"],"type":"object"},"Warranty":{"additionalProperties":false,"properties":{"basic":{"type":"string"},"drivetrain":{"type":"string"},"freeMaintenance":{"type":"string"},"roadsideAssistance":{"type":"string"},"rust":{"type":"string"}},"required":["basic","drivetrain","freeMaintenance","rust","roadsideAssistance"],"type":"object"}}},"paths":{"/ctx/{vin}":{"get":{"summary":"","tags":["ctx"],"description":"","parameters":[{"name":"vin","in":"path","required":true,"schema":{"type":"string","description":"Vehicle Identification Number","example":"1HGCM82633A123456"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"api":{"$ref":"#/components/schemas/API"},"accept":{"items":{"$ref":"#/components/schemas/Accept"},"type":"array"},"acceptLanguage":{"items":{"$ref":"#/components/schemas/AcceptLanguage"},"type":"array"},"body":{"type":"string"},"cf":{"$ref":"#/components/schemas/CF"},"checkDigit":{"type":"string"},"checksum":{"type":"boolean"},"cityZips":{"$ref":"#/components/schemas/CityZips"},"colo":{"$ref":"#/components/schemas/Colo"},"cookies":{"type":"null"},"creditScores":{"$ref":"#/components/schemas/CreditScores"},"data":{"$ref":"#/components/schemas/Data"},"emojis":{"$ref":"#/components/schemas/Emojis"},"examples":{"$ref":"#/components/schemas/Examples"},"glyphs":{"$ref":"#/components/schemas/Glyphs"},"hash":{"type":"string"},"headers":{"$ref":"#/components/schemas/Headers"},"hostSegments":{"items":{"type":"string"},"type":"array"},"hostname":{"type":"string"},"infrastructure":{"$ref":"#/components/schemas/Infrastructure"},"instanceCreated":{"type":"number"},"instanceCreatedBy":{"type":"string"},"instanceDiff":{"type":"number"},"instanceDurationMilliseconds":{"type":"number"},"instanceDurationSeconds":{"type":"number"},"instanceID":{"type":"string"},"instancePrefix":{"type":"string"},"instanceRequests":{"type":"number"},"instanceStart":{"type":"number"},"make":{"type":"string"},"method":{"type":"string"},"model":{"type":"string"},"newInstance":{"type":"boolean"},"origin":{"type":"string"},"pathDefaults":{"items":{"type":"string"},"type":"array"},"pathSegments":{"items":{"type":"string"},"type":"array"},"pathname":{"type":"string"},"query":{"$ref":"#/components/schemas/Query"},"rayID":{"type":"string"},"requestID":{"type":"string"},"requestMagicBits":{"type":"string"},"requestMagicPrefix":{"type":"string"},"requestPrefix":{"type":"string"},"requestTimestamp":{"type":"number"},"rootPath":{"type":"boolean"},"search":{"type":"string"},"services":{"$ref":"#/components/schemas/Services"},"squishVin":{"type":"string"},"styleId":{"type":"string"},"styleIds":{"items":{"type":"string"},"type":"array"},"subdomains":{"items":{"type":"string"},"type":"array"},"time":{"format":"date-time","type":"string"},"ts":{"type":"number"},"ua":{"$ref":"#/components/schemas/Ua"},"url":{"type":"string"},"userAgent":{"type":"string"},"vehicle":{"$ref":"#/components/schemas/Vehicle"},"vin":{"type":"string"},"vinValid":{"type":"boolean"},"year":{"type":"string"},"user":{"$ref":"#/components/schemas/ApiUser"}},"required":["vin","vinValid","squishVin","checkDigit","checksum","year","make","model","styleId","styleIds","vehicle","examples","data","services","infrastructure","glyphs","emojis","creditScores","cityZips","colo","hostname","pathname","search","hash","origin","query","pathSegments","pathDefaults","rootPath","hostSegments","subdomains","ts","time","body","url","method","userAgent","ua","accept","acceptLanguage","cf","rayID","requestID","requestPrefix","requestTimestamp","requestMagicBits","requestMagicPrefix","instanceID","instanceCreatedBy","instancePrefix","instanceStart","instanceCreated","instanceDiff","instanceDurationMilliseconds","instanceDurationSeconds","instanceRequests","newInstance","headers","cookies"],"type":"object"}}}}}}},"/photos/retail/{vin}":{"get":{"summary":"","tags":["photos"],"description":"","parameters":[{"name":"vin","in":"path","required":true,"schema":{"type":"string","description":"Vehicle Identification Number","example":"1HGCM82633A123456"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"api":{"$ref":"#/components/schemas/API"},"data":{"items":{"type":"string"},"type":"array"},"examples":{"additionalProperties":{"type":"string"},"type":"object"},"user":{"$ref":"#/components/schemas/ApiUser"}},"type":"object"}}}}}}},"/photos/wholesale/{vin}":{"get":{"summary":"","tags":["photos"],"description":"","parameters":[{"name":"vin","in":"path","required":true,"schema":{"type":"string","description":"Vehicle Identification Number","example":"1HGCM82633A123456"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"api":{"$ref":"#/components/schemas/API"},"data":{"items":{"type":"string"},"type":"array"},"examples":{"additionalProperties":{"type":"string"},"type":"object"},"user":{"$ref":"#/components/schemas/ApiUser"}},"type":"object"}}}}}}},"/photos/{vin}":{"get":{"summary":"","tags":["photos"],"description":"API to search & view photos for any vehicle.","parameters":[{"name":"vin","in":"path","required":true,"schema":{"type":"string","description":"Vehicle Identification Number","example":"1HGCM82633A123456"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"additionalProperties":false,"description":"API to search & view photos for any vehicle.","properties":{"api":{"$ref":"#/components/schemas/API"},"data":{"additionalProperties":false,"properties":{"retail":{"description":"Retail Photos","items":{"type":"string"},"type":"array"},"wholesale":{"items":{"type":"string"},"type":"array"}},"type":"object"},"user":{"$ref":"#/components/schemas/ApiUser"}},"required":["data"],"type":"object"}}}}}}},"/listings/{vin}":{"get":{"summary":"","tags":["listings"],"description":"","parameters":[{"name":"vin","in":"path","required":true,"schema":{"type":"string","description":"Vehicle Identification Number","example":"1HGCM82633A123456"}},{"name":"createdAt","in":"query","required":false,"description":"Filter by listing creation time (UTC). Accepts a truncated-datetime range: \"2026-06-13-2026-06-15\" (the 13th through the 15th, inclusive), a single whole period \"2026-06\" (all of June) or \"2026-06-13\" (that day), or an open-ended bound \"2026-06-13-\" (since) / \"-2026-06-15\" (until). Each side may be any precision: YYYY, YYYY-MM, YYYY-MM-DD, or YYYY-MM-DDTHH:MM:SS. The upper bound is inclusive of its whole period.","schema":{"type":"string"}},{"name":"distance","in":"query","required":false,"description":"Search radius in miles (default: 50)","schema":{"type":"number"}},{"name":"includeUnpriced","in":"query","required":false,"description":"Opt in to listings without a real retail price. Default excludes them. Opted-in rows emit `retailListing.price` as null (never 0). Pass `true` or `1`.","schema":{"type":"string"}},{"name":"includes","in":"query","required":false,"description":"Comma-separated includes, e.g. \"facets\"","schema":{"type":"string"}},{"name":"limit","in":"query","required":false,"description":"Results per page (default: 100)","schema":{"type":"number"}},{"name":"page","in":"query","required":false,"description":"Page number (default: 1)","schema":{"type":"number"}},{"name":"retailListing.miles","in":"query","required":false,"description":"Filter by mileage. Supports a numeric range, e.g. \"0-50000\".","schema":{"type":"string"}},{"name":"retailListing.price","in":"query","required":false,"description":"Filter by price. Supports a numeric range, e.g. \"20000-30000\", \"20000-\" (min), or \"-30000\" (max).","schema":{"type":"string"}},{"name":"sort","in":"query","required":false,"description":"Sort field and direction, e.g. \"price:desc\", \"mileage:asc\", \"year:desc\"","schema":{"type":"string"}},{"name":"updatedAt","in":"query","required":false,"description":"Filter by listing last-updated time (UTC). Same range syntax as createdAt.","schema":{"type":"string"}},{"name":"vehicle.bodyStyle","in":"query","required":false,"description":"Filter by body style","schema":{"type":"string"}},{"name":"vehicle.drivetrain","in":"query","required":false,"description":"Filter by drivetrain","schema":{"type":"string"}},{"name":"vehicle.exteriorColor","in":"query","required":false,"description":"Filter by exterior color","schema":{"type":"string"}},{"name":"vehicle.fuel","in":"query","required":false,"description":"Filter by fuel type. Use .not suffix to exclude.","schema":{"type":"string"}},{"name":"vehicle.interiorColor","in":"query","required":false,"description":"Filter by interior color","schema":{"type":"string"}},{"name":"vehicle.make","in":"query","required":false,"description":"Filter by vehicle make. Use .not suffix to exclude.","schema":{"type":"string"}},{"name":"vehicle.model","in":"query","required":false,"description":"Filter by vehicle model. Use .not suffix to exclude.","schema":{"type":"string"}},{"name":"vehicle.transmission","in":"query","required":false,"description":"Filter by transmission type","schema":{"type":"string"}},{"name":"vehicle.trim","in":"query","required":false,"description":"Filter by trim level","schema":{"type":"string"}},{"name":"vehicle.year","in":"query","required":false,"description":"Filter by vehicle year","schema":{"type":"string"}},{"name":"zip","in":"query","required":false,"description":"ZIP code for location-based search","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"api":{"$ref":"#/components/schemas/API"},"data":{"items":{"$ref":"#/components/schemas/Row"},"type":"array"},"facets":{"additionalProperties":{"anyOf":[{"additionalProperties":{"type":"string"},"type":"object"},{"not":{}}]},"type":"object"},"links":{"additionalProperties":false,"properties":{"first":{"type":"string"},"home":{"type":"string"},"last":{"type":"string"},"next":{"type":"string"},"prev":{"type":"string"},"self":{"type":"string"},"toggleFacets":{"type":"string"},"toggleTotal":{"type":"string"}},"type":"object"},"total":{"type":"number"},"totalFormatted":{"type":"string"},"user":{"$ref":"#/components/schemas/ApiUser"}},"required":["links","data"],"type":"object"}}}}}}},"/transport/{vin}":{"get":{"summary":"","tags":["transport"],"description":"","parameters":[{"name":"vin","in":"path","required":true,"schema":{"type":"string","description":"Vehicle Identification Number","example":"1HGCM82633A123456"}},{"name":"enclosedTrailer","in":"query","required":false,"description":"Use enclosed trailer (default: \"false\")","schema":{"type":"string"}},{"name":"fromZip","in":"query","required":false,"description":"Origin ZIP code (default: \"55435\")","schema":{"type":"string"}},{"name":"hasKeys","in":"query","required":false,"description":"Vehicle has keys (default: \"true\")","schema":{"type":"string"}},{"name":"toZip","in":"query","required":false,"description":"Destination ZIP code (default: user's ZIP or \"94020\")","schema":{"type":"string"}},{"name":"vehicleOperational","in":"query","required":false,"description":"Vehicle is operational (default: \"true\")","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"api":{"$ref":"#/components/schemas/API"},"transport":{"$ref":"#/components/schemas/Transport"},"vehicle":{"$ref":"#/components/schemas/Vehicle"},"user":{"$ref":"#/components/schemas/ApiUser"}},"required":["vehicle","transport"],"type":"object"}}}}}}},"/specs/{vin}":{"get":{"summary":"","tags":["specs"],"description":"","parameters":[{"name":"vin","in":"path","required":true,"schema":{"type":"string","description":"Vehicle Identification Number","example":"1HGCM82633A123456"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"api":{"$ref":"#/components/schemas/API"},"specs":{"$ref":"#/components/schemas/Specs"},"vehicle":{"$ref":"#/components/schemas/Vehicle"},"user":{"$ref":"#/components/schemas/ApiUser"}},"required":["vehicle","specs"],"type":"object"}}}}}}},"/recalls/{vin}":{"get":{"summary":"","tags":["recalls"],"description":"","parameters":[{"name":"vin","in":"path","required":true,"schema":{"type":"string","description":"Vehicle Identification Number","example":"1HGCM82633A123456"}},{"name":"make","in":"query","required":false,"description":"Override make from VIN decode","schema":{"type":"string"}},{"name":"model","in":"query","required":false,"description":"Override model from VIN decode","schema":{"type":"string"}},{"name":"year","in":"query","required":false,"description":"Override year from VIN decode","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"api":{"$ref":"#/components/schemas/API"},"data":{"items":{"$ref":"#/components/schemas/Recalls"},"type":"array"},"success":{"type":"boolean"},"user":{"$ref":"#/components/schemas/ApiUser"}},"required":["success","data"],"type":"object"}}}}}}},"/tco/{vin}":{"get":{"summary":"","tags":["tco"],"description":"","parameters":[{"name":"vin","in":"path","required":true,"schema":{"type":"string","description":"Vehicle Identification Number","example":"1HGCM82633A123456"}},{"name":"zip","in":"query","required":false,"description":"ZIP code (default: user's ZIP or \"90210\")","schema":{"type":"string"}}]}},"/payments/{vin}":{"get":{"summary":"","tags":["payments"],"description":"","parameters":[{"name":"vin","in":"path","required":true,"schema":{"type":"string","description":"Vehicle Identification Number","example":"1HGCM82633A123456"}},{"name":"creditScore","in":"query","required":false,"description":"Credit score (default: \"750\")","schema":{"type":"string"}},{"name":"docFee","in":"query","required":false,"description":"Documentation fee (default: 200)","schema":{"type":"number"}},{"name":"downPayment","in":"query","required":false,"description":"Down payment amount (default: 0)","schema":{"type":"number"}},{"name":"interestRate","in":"query","required":false,"description":"Override interest rate","schema":{"type":"number"}},{"name":"price","in":"query","required":false,"description":"Override vehicle price","schema":{"type":"number"}},{"name":"term","in":"query","required":false,"description":"Loan term in months (default: 72)","schema":{"type":"number"}},{"name":"tradeIn","in":"query","required":false,"description":"Trade-in value (default: 0)","schema":{"type":"number"}},{"name":"zip","in":"query","required":false,"description":"ZIP code (default: user's ZIP or \"94020\")","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"api":{"$ref":"#/components/schemas/API"},"apr":{"additionalProperties":{"type":"number"},"type":"object"},"criteria":{"$ref":"#/components/schemas/Criteria"},"fees":{"$ref":"#/components/schemas/Fees"},"paymentsData":{"$ref":"#/components/schemas/PaymentsData"},"services":{"$ref":"#/components/schemas/Services"},"taxes":{"$ref":"#/components/schemas/Taxes"},"totalTaxesAndFees":{"type":"number"},"vehicle":{"$ref":"#/components/schemas/Vehicle"},"user":{"$ref":"#/components/schemas/ApiUser"}},"required":["vehicle","criteria","paymentsData","apr","totalTaxesAndFees","taxes","fees","services"],"type":"object"}}}}}}},"/marketvalue/{vin}":{"get":{"summary":"","tags":["marketvalue"],"description":"","parameters":[{"name":"vin","in":"path","required":true,"schema":{"type":"string","description":"Vehicle Identification Number","example":"1HGCM82633A123456"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"api":{"$ref":"#/components/schemas/API"},"apr":{"additionalProperties":{"type":"number"},"type":"object"},"criteria":{"$ref":"#/components/schemas/Criteria"},"fees":{"$ref":"#/components/schemas/Fees"},"paymentsData":{"$ref":"#/components/schemas/PaymentsData"},"services":{"$ref":"#/components/schemas/Services"},"taxes":{"$ref":"#/components/schemas/Taxes"},"totalTaxesAndFees":{"type":"number"},"vehicle":{"$ref":"#/components/schemas/Vehicle"},"user":{"$ref":"#/components/schemas/ApiUser"}},"required":["vehicle","criteria","paymentsData","apr","totalTaxesAndFees","taxes","fees","services"],"type":"object"}}}}}}},"/apr/{vin}":{"get":{"summary":"","tags":["apr"],"description":"","parameters":[{"name":"vin","in":"path","required":true,"schema":{"type":"string","description":"Vehicle Identification Number","example":"1HGCM82633A123456"}},{"name":"creditScore","in":"query","required":false,"description":"Credit score (default: \"720\")","schema":{"type":"string"}},{"name":"vehicleMileage","in":"query","required":false,"description":"Vehicle mileage","schema":{"type":"string"}},{"name":"zip","in":"query","required":false,"description":"ZIP code (default: user's ZIP or \"90210\")","schema":{"type":"string"}}]}},"/openrecalls/{vin}":{"get":{"summary":"","tags":["openrecalls"],"description":"","parameters":[{"name":"vin","in":"path","required":true,"schema":{"type":"string","description":"Vehicle Identification Number","example":"1HGCM82633A123456"}},{"name":"make","in":"query","required":false,"description":"Override make from VIN decode","schema":{"type":"string"}},{"name":"model","in":"query","required":false,"description":"Override model from VIN decode","schema":{"type":"string"}},{"name":"recalls","in":"query","required":false,"description":"When set to `true`, the response includes an additional `recalls` array carrying the full make/model/year recall catalog (the same payload `/recalls/{vin}` returns in its `data` field) alongside the open-only `data` array. Useful when callers want both open campaigns for the VIN and the vehicle's full historical recall record in a single round trip.","schema":{"type":"string","enum":["true","false"]}},{"name":"year","in":"query","required":false,"description":"Override year from VIN decode","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"api":{"$ref":"#/components/schemas/API"},"data":{"description":"Open recalls for this specific VIN. Closed/remedied campaigns are excluded.","items":{"$ref":"#/components/schemas/OpenRecalls"},"type":"array"},"examples":{"additionalProperties":{"type":"string"},"description":"Navigation links to related resources.","type":"object"},"openRecalls":{"description":"Number of open recalls — equals `data.length`.","type":"number"},"recalls":{"description":"Full make/model/year recall catalog (open + closed). Present only when the request includes `?recalls=true`.","items":{"$ref":"#/components/schemas/OpenRecalls"},"type":"array"},"retrievedAt":{"description":"ISO 8601 timestamp of when the returned recall data was fetched from upstream. Recall data is cached until the next daily refresh, so this is how you tell how current the answer is; pass `?skipCache=true` to force a fresh fetch. `null` when the answer wasn't sourced from a cacheable upstream.","type":["string","null"]},"status":{"description":"Human-readable summary, e.g. \"1 Open Recall\" or \"No Open Recalls\".","type":"string"},"totalRecalls":{"description":"Total campaigns issued for this year/make/model, including ones already remedied for this VIN, so it can exceed `openRecalls`.","type":"number"},"vehicle":{"additionalProperties":false,"description":"Decoded vehicle the recalls pertain to.","properties":{"make":{"type":"string"},"model":{"type":"string"},"vin":{"type":"string"},"year":{"type":"string"}},"required":["year","make","model","vin"],"type":"object"},"user":{"$ref":"#/components/schemas/ApiUser"}},"required":["vehicle","data","status","openRecalls","totalRecalls","retrievedAt"],"type":"object"}}}}}}},"/taxes/{vin}":{"get":{"summary":"","tags":["taxes"],"description":"","parameters":[{"name":"vin","in":"path","required":true,"schema":{"type":"string","description":"Vehicle Identification Number","example":"1HGCM82633A123456"}},{"name":"docFee","in":"query","required":false,"description":"Documentation fee (default: 200)","schema":{"type":"number"}},{"name":"downPayment","in":"query","required":false,"description":"Down payment (default: 0)","schema":{"type":"number"}},{"name":"months","in":"query","required":false,"description":"Loan term in months (default: 72)","schema":{"type":"number"}},{"name":"price","in":"query","required":false,"description":"Vehicle price (default: 25000)","schema":{"type":"number"}},{"name":"rate","in":"query","required":false,"description":"Interest rate (default: 9.99)","schema":{"type":"number"}},{"name":"tradeIn","in":"query","required":false,"description":"Trade-in value (default: 0)","schema":{"type":"number"}},{"name":"zip","in":"query","required":false,"description":"ZIP code (default: user's ZIP or \"94020\")","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"api":{"$ref":"#/components/schemas/API"},"criteria":{"$ref":"#/components/schemas/Criteria"},"data":{"$ref":"#/components/schemas/Data"},"fees":{"$ref":"#/components/schemas/Fees"},"links":{"$ref":"#/components/schemas/Links"},"services":{"$ref":"#/components/schemas/Services"},"taxes":{"$ref":"#/components/schemas/Taxes"},"totalTaxesAndFees":{"type":"number"},"vehicle":{"$ref":"#/components/schemas/Vehicle"},"user":{"$ref":"#/components/schemas/ApiUser"}},"required":["vehicle","criteria","totalTaxesAndFees","taxes","fees","links","data","services"],"type":"object"}}}}}}}}}