openapi-directory/api/apigee.net/marketcheck-cars.json

Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS

{"openapi":"3.0.0","info":{"description":"<b>Access the New, Used and Certified cars inventories for all Car Dealers in US.</b> <br/>The data is sourced from online listings by over 44,000 Car dealers in US. At any time, there are about 6.2M searchable listings (about 1.9M unique VINs) for Used & Certified cars and about 6.6M (about 3.9M unique VINs) New Car listings from all over US. We use this API at the back for our website <a href='https://www.marketcheck.com' target='_blank'>www.marketcheck.com</a> and our Android and iOS mobile apps too.<br/><h5> Few useful links : </h5><ul><li>A quick view of the API and the use cases is depicated <a href='https://portals.marketcheck.com/mcapi/' target='_blank'>here</a></li><li>The Postman collection with various usages of the API is shared here https://www.getpostman.com/collections/2752684ff636cdd7bac2</li></ul>","title":"Marketcheck Cars","version":"1.0.3","x-apisguru-categories":["ecommerce"],"x-logo":{"url":"https://twitter.com/MarketcheckAPIs/profile_image?size=original"},"x-origin":[{"format":"swagger","url":"https://stagingapi.marketcheck.com/api-docs","version":"2.0"}],"x-providerName":"apigee.net","x-serviceName":"marketcheck-cars"},"externalDocs":{"description":"Find more details here","url":"https://apidocs.marketcheck.com"},"paths":{"/averages":{"get":{"description":"[Merged with the /search API - Please check the 'stats' parameter to the Search API above] Get market averages for price / miles / msrp / dom (days on market) fields for active cars matching the given reference VIN's basic specification or Year, Make, Model, Trim (Optional) criteria","operationId":"getAverages","parameters":[{"$ref":"#/components/parameters/api_key"},{"description":"VIN as a reference to the type of car for which averages data is to be returned","in":"query","name":"vin","required":true,"schema":{"type":"string","format":"string"}},{"description":"Year of the car","in":"query","name":"year","required":false,"schema":{"type":"string","format":"string"}},{"description":"Make of the car","in":"query","name":"make","required":false,"schema":{"type":"string","format":"string"}},{"description":"Model of the Car","in":"query","name":"model","required":false,"schema":{"type":"string","format":"string"}},{"description":"Trim of the Car","in":"query","name":"trim","required":false,"schema":{"type":"string","format":"string"}},{"description":"Comma separated list of fields to generate stats for. Allowed fields in the list are - price, miles, msrp, dom (days on market)","in":"query","name":"fields","schema":{"type":"string","format":"string"}}],"responses":{"200":{"description":"Data with Market averages","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Averages"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"summary":"[MOCK] Get Averages for YMM","tags":["Market"],"x-swagger-router-controller":"Market"}},"/comparison":{"get":{"description":"[MOCK] Get historical market trends for cars matching the given VIN's basic specification or Year, Make, Model, Trim (Optional) criteria","operationId":"getComparison","parameters":[{"$ref":"#/components/parameters/api_key"},{"description":"VIN as a reference to the type of car for which comparison data is to be returned","in":"query","name":"vin","required":true,"schema":{"type":"string","format":"string"}}],"responses":{"200":{"description":"Data after Comparing market","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ComparisonPoint"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"summary":"Compare market","tags":["Market"],"x-swagger-router-controller":"Market"}},"/competition":{"get":{"description":"[MOCK] Competitor cars in market for current vin","operationId":"getCompetition","parameters":[{"$ref":"#/components/parameters/api_key"},{"description":"VIN as a reference to the type of car for which competitors data is to be returned","in":"query","name":"vin","required":true,"schema":{"type":"string","format":"string"}}],"responses":{"200":{"description":"Data after Comparing market","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CompetitorsPoint"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"summary":"Competitors","tags":["Market"],"x-swagger-router-controller":"Market"}},"/dealer/{dealer_id}":{"get":{"description":"Get a particular dealer's information by its id","operationId":"getDealer","parameters":[{"$ref":"#/components/parameters/api_key"},{"description":"Dealer id to get all the dealer info attributes","in":"path","name":"dealer_id","required":true,"schema":{"type":"string","format":"string"}}],"responses":{"200":{"description":"Dealer for the given id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Dealer"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"summary":"Dealer by id","tags":["Dealer"],"x-swagger-router-controller":"Dealer"}},"/dealer/{dealer_id}/active/inventory":{"get":{"description":"Get a dealer's currently active inventory","operationId":"getDealerActiveInventory","parameters":[{"$ref":"#/components/parameters/api_key"},{"description":"Id representing the dealer to fetch the active inventory for","in":"path","name":"dealer_id","required":true,"schema":{"type":"string","format":"string"}},{"description":"Number of results to return. Default is 10. Max is 50","in":"query","name":"rows","required":false,"schema":{"type":"string"}},{"description":"Page number to fetch the results for the given criteria. Default is 1. Pagination is allowed only till first 1000 results for the search and sort criteria. The page value can be only between 1 to 1000/rows","in":"query","name":"start","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Inventory for the dealer","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseListing"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"summary":"Dealer inventory","tags":["Inventory","Dealer"],"x-swagger-router-controller":"Dealer"}},"/dealer/{dealer_id}/historical/inventory":{"get":{"description":"[v1 : Not Implemented Yet] - Get a dealer's historical inventory","operationId":"getDealerHistoricalInventory","parameters":[{"description":"Id representing the dealer to fetch the active inventory for","in":"path","name":"dealer_id","required":true,"schema":{"type":"string","format":"string"}}],"responses":{"200":{"description":"Historical Inventory for the dealer","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseListing"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"summary":"Dealer's historical inventory","tags":["Inventory","Dealer"],"x-swagger-router-controller":"Dealer"}},"/dealer/{dealer_id}/landing":{"get":{"description":"Experimental: Get cached version of dealer landing page by dealer id","operationId":"getDealerLandingPage","parameters":[{"$ref":"#/components/parameters/api_key"},{"description":"Robot id to get the landing page html for","in":"path","name":"dealer_id","required":true,"schema":{"type":"string","format":"string"}}],"responses":{"200":{"description":"Cached html for dealer for the given robot id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DealerLandingPage"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"summary":"Experimental: Get cached version of dealer landing page by dealer id","tags":["Dealer"],"x-swagger-router-controller":"Dealer"}},"/dealer/{dealer_id}/ratings":{"get":{"description":"[MOCK] Get a dealer's Rating","operationId":"getDealerRatings","parameters":[{"description":"Id representing the dealer to fetch the ratings for","in":"path","name":"dealer_id","required":true,"schema":{"type":"string","format":"string"}}],"responses":{"200":{"description":"Rating for respective Dealer","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DealerRating"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"summary":"Dealer's Rating","tags":["Dealer"],"x-swagger-router-controller":"Dealer"}},"/dealer/{dealer_id}/reviews":{"get":{"description":"[MOCK] Get a dealer's Review","operationId":"getDealerReviews","parameters":[{"description":"Id representing the dealer to fetch the ratings for","in":"path","name":"dealer_id","required":true,"schema":{"type":"string","format":"string"}}],"responses":{"200":{"description":"Review for respective Dealer","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DealerReview"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"summary":"Dealer's Review","tags":["Dealer"],"x-swagger-router-controller":"Dealer"}},"/dealers":{"get":{"description":"The dealers API returns a list of dealers around a given point and radius. Max radius of only 50 miles is supported.","operationId":"dealerSearch","parameters":[{"$ref":"#/components/parameters/api_key"},{"description":"Latitude component of location","in":"query","name":"latitude","required":true,"schema":{"type":"number","format":"double"}},{"description":"Longitude component of location","in":"query","name":"longitude","required":true,"schema":{"type":"number","format":"double"}},{"description":"Radius around the search location","in":"query","name":"radius","required":true,"schema":{"type":"integer"}},{"description":"Number of results to return. Default is 10. Max is 50","in":"query","name":"rows","required":false,"schema":{"type":"number","format":"number"}},{"description":"Offset for the search results. Default is 1.","in":"query","name":"start","required":false,"schema":{"type":"number","format":"number"}}],"responses":{"200":{"description":"List of dealers for the search","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DealersResponse"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"summary":"Find car dealers around","tags":["Dealer"]},"x-swagger-router-controller":"Dealer"},"/depreciation":{"get":{"description":"[MOCK] Model resale value based on depreciation","operationId":"getDepreciation","parameters":[{"$ref":"#/components/parameters/api_key"},{"description":"VIN as a reference to the type of car for which Depreciation stats is to be returned","in":"query","name":"vin","required":true,"schema":{"type":"string","format":"string"}}],"responses":{"200":{"description":"Model resale value based on depreciation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DepreciationPoint"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"summary":"Depreciation","tags":["Market"],"x-swagger-router-controller":"Market"}},"/economy":{"get":{"description":"[MOCK] Calculate Economy i.e. Environmental Friendliness","operationId":"getEconomy","parameters":[{"$ref":"#/components/parameters/api_key"},{"description":"VIN as a reference to the type of car for which Environmental Economy data is to be returned","in":"query","name":"vin","required":true,"schema":{"type":"string","format":"string"}}],"responses":{"200":{"description":"Calculate Environmental friendliness","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Economy"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"summary":"Get Economy based on environmental factors","tags":["VIN Decoder"],"x-swagger-router-controller":"VINDecoder"}},"/facets":{"get":{"description":"[Merged with the /search API - Please check the 'facets' parameter to the Search API above] Get the facets for the given simple filter criteria (by given VIN's basic specification, Or by Year, Make, Model, Trim criteria) and facet fields","operationId":"getFacets","parameters":[{"$ref":"#/components/parameters/api_key"},{"description":"VIN as a reference to the type of car for which facets data is to be returned","in":"query","name":"vin","required":false,"schema":{"type":"string","format":"string"}},{"description":"Year of the car","in":"query","name":"year","required":false,"schema":{"type":"string","format":"string"}},{"description":"Make of the car","in":"query","name":"make","required":false,"schema":{"type":"string","format":"string"}},{"description":"Model of the Car","in":"query","name":"model","required":false,"schema":{"type":"string","format":"string"}},{"description":"Trim of the Car","in":"query","name":"trim","required":false,"schema":{"type":"string","format":"string"}},{"description":"Comma separated list of fields to generate facets for. Supported fields are - year, make, model, trim, exterior_color, interior_color, drivetrain, vehicle_type, car_type, body_style, body_subtype, doors","in":"query","name":"fields","required":true,"schema":{"type":"string","format":"string"}}],"responses":{"200":{"description":"Facet details for the requested fields","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/FacetItem"},"type":"array"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"summary":"Facets","tags":["Facets"],"x-swagger-router-controller":"Facets"}},"/fuel_efficiency":{"get":{"description":"[MOCK] Calculate fuel efficiency from taxonomy db mileage values","operationId":"getEfficiency","parameters":[{"$ref":"#/components/parameters/api_key"},{"description":"VIN as a reference to the type of car for which fuel data is to be returned","in":"query","name":"vin","required":true,"schema":{"type":"string","format":"string"}}],"responses":{"200":{"description":"Fuel Efficiency","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FuelEfficiency"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"summary":"Get fuel effeciency","tags":["VIN Decoder"],"x-swagger-router-controller":"VINDecoder"}},"/history/{vin}":{"get":{"description":"The history API returns online listing history for a car identified by its VIN. History listings are sorted in the descending order of the listing date / last seen date","operationId":"history","parameters":[{"$ref":"#/components/parameters/api_key"},{"description":"The VIN to identify the car to fetch the listing history. Must be a valid 17 char VIN","in":"path","name":"vin","required":true,"schema":{"type":"string","format":"string"}},{"description":"List of fields to fetch, in case the default fields list in the response is to be trimmed down","in":"query","name":"fields","required":false,"schema":{"type":"string","format":"string"}},{"description":"Number of results to return. Default is 10. Max is 50","in":"query","name":"rows","required":false,"schema":{"type":"number","format":"number"}},{"description":"Page number to fetch the results for the given criteria. Default is 1.","in":"query","name":"page","required":false,"schema":{"type":"number","format":"number"}}],"responses":{"200":{"description":"Online listing history for the given vin","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/HistoricalListing"},"type":"array"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"summary":"Get a cars online listing history","tags":["History"]},"x-swagger-router-controller":"Listing"},"/listing/{id}":{"get":{"description":"Get a particular listing by its id","operationId":"getListing","parameters":[{"$ref":"#/components/parameters/api_key"},{"description":"Listing id to get all the listing attributes","in":"path","name":"id","required":true,"schema":{"type":"string","format":"string"}}],"responses":{"200":{"description":"Listing for the given id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Listing"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"summary":"Listing by id","tags":["Listings"]},"x-swagger-router-controller":"Listing"},"/listing/{id}/extra":{"get":{"description":"Get listing options, features, seller comments","operationId":"getListingExtra","parameters":[{"$ref":"#/components/parameters/api_key"},{"description":"Listing id to get all the long text listing attributes","in":"path","name":"id","required":true,"schema":{"type":"string","format":"string"}}],"responses":{"200":{"description":"ListingAttributes for the given listing id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListingExtraAttributes"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"summary":"Long text Listings attributes for Listing with the given id","tags":["Listings"]},"x-swagger-router-controller":"Listing"},"/listing/{id}/media":{"get":{"description":"Get listing media (photo, photos) by id","operationId":"getListingMedia","parameters":[{"$ref":"#/components/parameters/api_key"},{"description":"Listing id to get all the listing attributes","in":"path","name":"id","required":true,"schema":{"type":"string","format":"string"}}],"responses":{"200":{"description":"ListingMedia for the given listing id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListingMedia"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"summary":"Listing media by id","tags":["Listings"]},"x-swagger-router-controller":"Listing"},"/listing/{id}/vdp":{"get":{"description":"Cached HTML of the Vehicle Details Page (VDP) for the listing. The HTML is cached only for 7 days for all listings. So this API could be used to get HTML of mostly active listings and that have recently expired","operationId":"getListingVDP","parameters":[{"$ref":"#/components/parameters/api_key"},{"description":"Listing id to get the vehicle details page (VDP) HTML","in":"path","name":"id","required":true,"schema":{"type":"string","format":"string"}},{"description":"Get only HTML for given listings VDP page","in":"query","name":"html","required":false,"schema":{"type":"string","format":"string"}}],"responses":{"200":{"description":"ListingVDP for the given listing id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListingVDP"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"summary":"Get listing HTML","tags":["Listings"]},"x-swagger-router-controller":"Listing"},"/mds":{"get":{"description":"Get the basic information on specifications for a car identified by a valid VIN","operationId":"getMDS","parameters":[{"$ref":"#/components/parameters/api_key"},{"description":"VIN to decode","in":"query","name":"vin","required":true,"schema":{"type":"string","format":"string"}},{"description":"Exact parameter","in":"query","name":"exact","required":false,"schema":{"type":"string","format":"string"}},{"description":"Latitude component of location","in":"query","name":"latitude","required":false,"schema":{"type":"number","format":"double"}},{"description":"Longitude component of location","in":"query","name":"longitude","required":false,"schema":{"type":"number","format":"double"}},{"description":"Radius around the search location","in":"query","name":"radius","required":false,"schema":{"type":"integer"}},{"description":"Debug parameter","in":"query","name":"debug","required":false,"schema":{"type":"string","format":"string"}},{"description":"To fetch sold vins","in":"query","name":"include_sold","required":false,"schema":{"type":"string","format":"string"}}],"responses":{"200":{"description":"Provides Market Days supply for year make model or trim combination","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Mds"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"summary":"Market Days Supply","tags":["Market"],"x-swagger-router-controller":"MDS"}},"/plots":{"get":{"description":"[DEPRECIATED Please check this in /search API using plot=true]Get price, miles plot data for active cars matching the given VIN's basic specification or Year, Make, Model, Trim (Optional) criteria","operationId":"getPriceMilesPlotData","parameters":[{"$ref":"#/components/parameters/api_key"},{"description":"VIN as a reference to the type of car for which plot data is to be returned","in":"query","name":"vin","required":false,"schema":{"type":"string","format":"string"}},{"description":"Year of the car","in":"query","name":"year","required":false,"schema":{"type":"string","format":"string"}},{"description":"Make of the car","in":"query","name":"make","required":false,"schema":{"type":"string","format":"string"}},{"description":"Model of the Car","in":"query","name":"model","required":false,"schema":{"type":"string","format":"string"}},{"description":"Trim of the Car","in":"query","name":"trim","required":false,"schema":{"type":"string","format":"string"}},{"description":"Car type to get the scatter plot data for","in":"query","name":"car_type","required":true,"schema":{"type":"string","format":"string"}},{"description":"Number of results to return. Default is 1000. Max is 10000","in":"query","name":"rows","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Data to plot Price x Miles on a graph","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/PlotPoint"},"type":"array"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"summary":"Price, Miles plots data for given criteria","tags":["Graphs"],"x-swagger-router-controller":"Graph"}},"/popularity":{"get":{"description":"[MOCK] [Merged with the /search API - Please check the 'popularity' parameter to the Search API above] Get the Popularity for the given simple filter criteria (by given Year, Make, Model, Trim criteria)","operationId":"getPopularity","parameters":[{"$ref":"#/components/parameters/api_key"},{"description":"Year of the car","in":"query","name":"year","required":true,"schema":{"type":"string","format":"string"}},{"description":"Make of the car","in":"query","name":"make","required":true,"schema":{"type":"string","format":"string"}},{"description":"Model of the Car","in":"query","name":"model","required":true,"schema":{"type":"string","format":"string"}},{"description":"Trim of the Car","in":"query","name":"trim","required":true,"schema":{"type":"string","format":"string"}},{"description":"Body type to filter the cars on. Valid values are the ones returned by body_type facets API call","in":"query","name":"body_type","required":true,"schema":{"type":"string","format":"string"}},{"description":"The list of fields for which stats need to be generated based on the matching listings for the search criteria. Allowed fields are - price, miles, msrp, dom The stats consists of mean, max, average and count of listings based on which the stats are calculated for the field. Stats could be requested in addition to the listings for the search. Please note - The API calls with the stats fields may take longer to respond.","in":"query","name":"stats","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Popularity details for the requested fields","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/PopularityItem"},"type":"array"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"summary":"Popularity","tags":["Market"],"x-swagger-router-controller":"Listing"}},"/safety":{"get":{"description":"[MOCK] Get Safety ratings from third party sources","operationId":"getSafetyRating","parameters":[{"$ref":"#/components/parameters/api_key"},{"description":"VIN to fetch the safety ratings","in":"query","name":"vin","required":true,"schema":{"type":"string","format":"string"}}],"responses":{"200":{"description":"Safety Rating for the given vin","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SafetyRating"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"summary":"Get Safety Rating","tags":["VIN Decoder"]},"x-swagger-router-controller":"VINDecoder"},"/search":{"get":{"description":"This endpoint is the meat of the API and serves many purposes. This API produces a list of currently active cars from the market for the given search criteria. The API results are limited to allow pagination upto 1000 rows.\n The search API facilitates the following use cases -\n1. Search Cars around a given geo-point within a given radius\n2. Search cars for a specific year / make / model or combination of these\n3. Search cars matching multiple year, make, model combinatins in the same search request\n4. Filter results by most car specification attributes\n5. Search for similar cars by VIN or Taxonomy VIN\n6. Filter cars within a given price / miles / days on market (dom) range\n7. Specify a sort order for the results on price / miles / dom / listed date\n8. Search cars for a given City / State combination\n9. Get Facets to build the search drill downs\n10. Get Market averages for price/miles/dom/msrp for your search","operationId":"search","parameters":[{"$ref":"#/components/parameters/api_key"},{"description":"Latitude component of location","in":"query","name":"latitude","required":false,"schema":{"type":"number","format":"double"}},{"description":"Longitude component of location","in":"query","name":"longitude","required":false,"schema":{"type":"number","format":"double"}},{"description":"Radius around the search location","in":"query","name":"radius","required":false,"schema":{"type":"integer"}},{"description":"car search bases on zipcode","in":"query","name":"zip","required":false,"schema":{"type":"string"}},{"description":"Car type. Allowed values are - new / used / certified","in":"query","name":"car_type","required":false,"schema":{"type":"string","enum":["new","used","certified"]}},{"description":"Seller type to filter cars on. Valid filter values are those that our Search facets API returns for unique seller types. You can pass in multiple seller type values comma separated.","in":"query","name":"seller_type","required":false,"schema":{"type":"string","format":"string"}},{"description":"Indicates whether car has had only one owner or not","in":"query","name":"carfax_1_owner","required":false,"schema":{"type":"string","format":"string"}},{"description":"Indicates whether car has had any accidents or not","in":"query","name":"carfax_clean_title","required":false,"schema":{"type":"string","format":"string"}},{"description":"Car year - 1980 onwards. Valid filter values are those that our Search facets API returns for unique years. You can pass in multiple year values comma separated.","in":"query","name":"year","required":false,"schema":{"type":"string"}},{"description":"Car Make - should be a standard OEM Make name. Valid filter values are those that our Search facets API returns for unique make. You can pass in multiple make values separated by comma. e.g. ford,audi","in":"query","name":"make","required":false,"schema":{"type":"string","format":"string"}},{"description":"Car model to search. Valid filter values are those that our Search facets API returns for unique model. You can pass in multiple model values comma separated for e.g f-150,Mustang.","in":"query","name":"model","required":false,"schema":{"type":"string","format":"string"}},{"description":"Car trim to search. Valid filter values are those that our Search facets API returns for unique trim. You can pass in multiple trim values comma separated","in":"query","name":"trim","required":false,"schema":{"type":"string","format":"string"}},{"description":"Dealer id to filter the cars.","in":"query","name":"dealer_id","required":false,"schema":{"type":"string","format":"string"}},{"description":"Car vin to search","in":"query","name":"vin","required":false,"schema":{"type":"string","format":"string"}},{"description":"Source to search cars. Valid filter values are those that our Search facets API returns for unique source. You can pass in multiple source values comma separated","in":"query","name":"source","required":false,"schema":{"type":"string","format":"string"}},{"description":"Body type to filter the cars on. Valid filter values are those that our Search facets API returns for unique body types. You can pass in multiple body types comma separated.","in":"query","name":"body_type","required":false,"schema":{"type":"string","format":"string"}},{"description":"Body subtype to filter the cars on. Valid filter values are those that our Search facets API returns for unique body subtypes. You can pass in multiple body subtype values comma separated","in":"query","name":"body_subtype","required":false,"schema":{"type":"string","format":"string"}},{"description":"Vehicle type to filter the cars on. Valid filter values are those that our Search facets API returns for unique vehicle types. You can pass in multiple vehicle type values comma separated","in":"query","name":"vehicle_type","required":false,"schema":{"type":"string","format":"string"}},{"description":"Comma separated list of 17 digit vins to search the matching cars for. Only 10 VINs allowed per request. If the request contains more than 10 VINs the first 10 VINs will be considered. Could be used as a More Like This or Similar Vehicles search for the given VINs. Ths vins parameter is an alternative to taxonomy_vins or ymmt parameters available with the search API. vins and taxonomy_vins parameters could be used to filter our cars with the exact build represented by the vins or taxonomy_vins whereas ymmt is a top level filter that does not filter cars by the build attributes like doors, drivetrain, cylinders, body type, body subtype, vehicle type etc","in":"query","name":"vins","required":false,"schema":{"type":"string"}},{"description":"Comma separated list of 10 letters excert from the 17 letter VIN. The 10 letters to be picked up from the 17 letter VIN are - first 8 letters and the 10th and 11th letter. E.g. For a VIN - 1FTFW1EF3EKE57182 the taxonomy vin would be - 1FTFW1EFEK  A taxonomy VIN identified a build of a car and could be used to filter our cars of a particular build. This is an alternative to the vin or ymmt parameters to the search API.","in":"query","name":"taxonomy_vins","required":false,"schema":{"type":"string"}},{"description":"Comma separated list of Year, Make, Model, Trim combinations. Each combination needs to have the year,make,model, trim values separated by a pipe '|' character in the form year|make|model|trim. e.g. 2010|Audi|A5,2014|Nissan|Sentra|S 6MT,|Honda|City|   You could just provide strings of the form - 'year|make||' or 'year|make|model' or '|make|model|' combinations. Individual year / make / model filters provied with the API calls will take precedence over the Year, Make, Model, Trim combinations. The Make, Model, Trim values must be valid values as per the Marketcheck Vin Decoder. If you are using a separate vin decoder then look at using the 'vins' or 'taxonomy_vins' parameter to the search api instead the year|make|model|trim combinations.","in":"query","name":"ymmt","required":false,"schema":{"type":"string"}},{"description":"Comma separated list of Year, Make, Model, Trim fields. For example - year,make,model,trim fields for which user wants to do an exact match","in":"query","name":"match","required":false,"schema":{"type":"string"}},{"description":"Cylinders to filter the cars on. Valid filter values are those that our Search facets API returns for unique cylinder values. You can pass in multiple cylinder values comma separated","in":"query","name":"cylinders","required":false,"schema":{"type":"string","format":"string"}},{"description":"Transmission to filter the cars on. [a = Automatic, m = Manual]. Valid filter values are those that our Search facets API returns for unique transmission. You can pass in multiple transmission values comma separated","in":"query","name":"transmission","required":false,"schema":{"type":"string","format":"string"}},{"description":"Speeds to filter the cars on. Valid filter values are those that our Search facets API returns for unique speeds. You can pass in multiple speeds values comma separated","in":"query","name":"speeds","required":false,"schema":{"type":"string","format":"string"}},{"description":"Doors to filter the cars on. Valid filter values are those that our Search facets API returns for unique doors. You can pass in multiple doors values comma separated","in":"query","name":"doors","required":false,"schema":{"type":"string","format":"string"}},{"description":"Drivetrain to filter the cars on. Valid filter values are those that our Search facets API returns for unique drivetrains. You can pass in multiple drivetrain values comma separated","in":"query","name":"drivetrain","required":false,"schema":{"type":"string","format":"string"}},{"description":"Exterior color to match. Valid filter values are those that our Search facets API returns for unique exterior colors. You can pass in multiple exterior color values comma separated","in":"query","name":"exterior_color","required":false,"schema":{"type":"string"}},{"description":"Interior color to match. Valid filter values are those that our Search facets API returns for unique interior colors. You can pass in multiple interior color values comma separated","in":"query","name":"interior_color","required":false,"schema":{"type":"string"}},{"description":"Filter listings on engine","in":"query","name":"engine","required":false,"schema":{"type":"string"}},{"description":"Engine Type to match. Valid filter values are those that our Search facets API returns for unique engine types. You can pass in multiple engine type values comma separated","in":"query","name":"engine_type","required":false,"schema":{"type":"string"}},{"description":"Engine Aspiration to match. Valid filter values are those that our Search facets API returns for unique Engine Aspirations. You can pass in multiple Engine aspirations values comma separated","in":"query","name":"engine_aspiration","required":false,"schema":{"type":"string"}},{"description":"Engine Block to match. Valid filter values are those that our Search facets API returns for unique Engine Block. You can pass in multiple Engine Block values comma separated","in":"query","name":"engine_block","required":false,"schema":{"type":"string"}},{"description":"Miles range to filter cars with miles in the given range. Range to be given in the format - min-max e.g. 1000-5000","in":"query","name":"miles_range","required":false,"schema":{"type":"string","format":"string"}},{"description":"Price range to filter cars with the price in the range given. Range to be given in the format - min-max e.g. 1000-5000","in":"query","name":"price_range","required":false,"schema":{"type":"string","format":"string"}},{"description":"Days on Market range to filter cars with the DOM within the given range. Range to be given in the format - min-max e.g. 10-50","in":"query","name":"dom_range","required":false,"schema":{"type":"string","format":"string"}},{"description":"Sort by field - allowed fields are distance|price|miles|dom|age|posted_at|year. Default sort field is distance from the given point","in":"query","name":"sort_by","required":false,"schema":{"type":"string","format":"string"}},{"description":"Sort order - asc or desc. Default sort order is distance from a point.","in":"query","name":"sort_order","required":false,"schema":{"type":"string","format":"string"}},{"description":"Number of results to return. Default is 10. Max is 50","in":"query","name":"rows","required":false,"schema":{"type":"string"}},{"description":"Page number to fetch the results for the given criteria. Default is 1. Pagination is allowed only till first 1000 results for the search and sort criteria. The page value can be only between 1 to 1000/rows","in":"query","name":"start","required":false,"schema":{"type":"string"}},{"description":"The comma separated list of fields for which facets are requested. Supported fields are - year, make, model, trim, vehicle_type, car_type, body_type, body_subtype, drivetrain, cylinders, transmission, exterior_color, interior_color, doors, engine_type, engine_aspiration, engine_block. Facets could be requested in addition to the listings for the search. Please note - The API calls with lots of facet fields may take longer to respond.","in":"query","name":"facets","required":false,"schema":{"type":"string"}},{"description":"The list of fields for which stats need to be generated based on the matching listings for the search criteria. Allowed fields are - price, miles, msrp, dom The stats consists of mean, max, average and count of listings based on which the stats are calculated for the field. Stats could be requested in addition to the listings for the search. Please note - The API calls with the stats fields may take longer to respond.","in":"query","name":"stats","required":false,"schema":{"type":"string"}},{"description":"Filter on Country, by default US. Search available on US (United States) and CA (Canada)","in":"query","name":"country","required":false,"schema":{"type":"string"}},{"description":"If plot has value true results in around 25k coordinates with limited fields to plot respective graph","in":"query","name":"plot","required":false,"schema":{"type":"string"}},{"description":"If nodedup is set to true then will give results using is_searchable","in":"query","name":"nodedup","required":false,"schema":{"type":"string"}},{"description":"Filter listsings on State","in":"query","name":"state","required":false,"schema":{"type":"string"}},{"description":"Filter listings on city","in":"query","name":"city","required":false,"schema":{"type":"string"}},{"description":"Filter listings on dealer_name","in":"query","name":"dealer_name","required":false,"schema":{"type":"string"}},{"description":"Filter listings on web scraped trim","in":"query","name":"trim_o","required":false,"schema":{"type":"string"}},{"description":"Filter trim on custom possible matches","in":"query","name":"trim_r","required":false,"schema":{"type":"string"}},{"description":"Active Days on Market range to filter cars with the DOM within the given range. Range to be given in the format - min-max e.g. 10-50","in":"query","name":"dom_active_range","required":false,"schema":{"type":"string","format":"string"}},{"description":"Last 180 Days on Market range to filter cars with the DOM within the given range. Range to be given in the format - min-max e.g. 10-50","in":"query","name":"dom_180_range","required":false,"schema":{"type":"string","format":"string"}},{"description":"Tokenizer search on options for multiple options use | as seperator","in":"query","name":"options","required":false,"schema":{"type":"string","format":"string"}},{"description":"Tokenizer search on features for multiple options use | as seperator","in":"query","name":"features","required":false,"schema":{"type":"string","format":"string"}}],"responses":{"200":{"description":"List of all cars listings matching the search & filter criteria","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchResponse"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"summary":"Gets active car listings for the given search criteria","tags":["Listings"]},"x-swagger-router-controller":"Listing"},"/trends":{"get":{"description":"Get historical market trends for cars matching the given VIN's basic specification or Year, Make, Model, Trim (Optional) criteria","operationId":"getTrends","parameters":[{"$ref":"#/components/parameters/api_key"},{"description":"VIN as a reference to the type of car for which trend data is to be returned","in":"query","name":"vin","required":true,"schema":{"type":"string","format":"string"}},{"description":"Car type. Allowed values are - new / used / certified","in":"query","name":"car_type","required":true,"schema":{"type":"string","format":"string"}},{"description":"Year of the car","in":"query","name":"year","required":false,"schema":{"type":"string","format":"string"}},{"description":"Make of the car","in":"query","name":"make","required":false,"schema":{"type":"string","format":"string"}},{"description":"Model of the Car","in":"query","name":"model","required":false,"schema":{"type":"string","format":"string"}},{"description":"Trim of the Car","in":"query","name":"trim","required":false,"schema":{"type":"string","format":"string"}}],"responses":{"200":{"description":"Data with Market Trend values","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/TrendPoint"},"type":"array"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"summary":"Get Trends for criteria","tags":["Market"],"x-swagger-router-controller":"Trends"}},"/vin/{vin}/specs":{"get":{"description":"Get the basic information on specifications for a car identified by a valid VIN","operationId":"decode","parameters":[{"$ref":"#/components/parameters/api_key"},{"description":"VIN to decode","in":"path","name":"vin","required":true,"schema":{"type":"string","format":"string"}}],"responses":{"200":{"description":"Basic sepcifications details about the car","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Build"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"summary":"VIN Decoder","tags":["VIN Decoder"],"x-swagger-router-controller":"VINDecoder"}},"/vin_report_summary":{"get":{"description":"[MOCK] Generate Summary report","operationId":"getSummaryReport","parameters":[{"$ref":"#/components/parameters/api_key"},{"description":"VIN as a reference to the type of car for which Summary data is to be returned","in":"query","name":"vin","required":true,"schema":{"type":"string","format":"string"}}],"responses":{"200":{"description":"Summary Report","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/VinReport"},"type":"array"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"summary":"Get Summary Report","tags":["Listings"],"x-swagger-router-controller":"Listing"}}},"servers":[{"url":"https://marketcheck-prod.apigee.net/v1"}],"components":{"parameters":{"api_key":{"description":"The API Authentication Key. Mandatory with all API calls.","in":"query","name":"api_key","required":false,"schema":{"type":"string"}}},"schemas":{"Averages":{"properties":{"age":{"description":"Average age of the car","type":"number"},"dom":{"description":"Average Days on Market value for the car based on all listings found in the Marketcheck database for this car","type":"number"},"miles":{"description":"Mean miles value for the car","type":"number"},"msrp":{"description":"Mean msrp value for the car","type":"number"},"price":{"description":"Mean price value for the car","type":"number"},"units":{"description":"No of units for this car on the market","type":"number"}},"type":"object"},"BaseListing":{"description":"Minimal set of attributes describing a listing","properties":{"build":{"$ref":"#/components/schemas/Build"},"dealer":{"$ref":"#/components/schemas/Dealer"},"distance":{"description":"Distance of the car's location from the specified user lcoation","type":"number"},"dom":{"description":"Days on Market value for the car based on current and historical listings found in the Marketcheck database for this car","type":"number"},"dom_180":{"description":"Days on Market value for the car based on current and last 6 month listings found in the Marketcheck database for this car","type":"number"},"dom_active":{"description":"Days on Market value for the car based on current and last 30 days listings found in the Marketcheck database for this car","type":"number"},"exterior_color":{"description":"Exterior color of the car","type":"string"},"first_seen_at":{"description":"Listing first seen at first scraped timestamp","type":"number"},"first_seen_at_date":{"description":"Listing first seen at first scraped date","type":"string"},"heading":{"description":"Listing title as displayed on the source website","type":"string"},"id":{"description":"Unique identifier representing a specific listing from the Marketcheck database","type":"string"},"interior_color":{"description":"Interior color of the car","type":"string"},"inventory_type":{"description":"Inventory type of car","type":"string"},"is_certified":{"description":"Certified car","type":"integer"},"last_seen_at":{"description":"Listing last seen at (most recent) timestamp","type":"number"},"last_seen_at_date":{"description":"Listing last seen at (most recent) date","type":"string"},"media":{"$ref":"#/components/schemas/ListingMedia"},"miles":{"description":"Odometer reading / reported miles usage for the car","type":"string"},"price":{"description":"Asking price for the car","type":"string"},"ref_miles":{"description":"Last Odometer reading / reported miles usage for the car. If the asking miles value is not or is available then the last_miles could perhaps be used. last_miles is the miles for the car listed on the source website as of last_miles_dt date","type":"string"},"ref_miles_dt":{"description":"The date at which the last miles was reported online. This is earlier to last_seen_date","type":"integer"},"ref_price":{"description":"Last reported price for the car. If the asking price value is not or is available then the last_price could perhaps be used. last_price is the price for the car listed on the source website as of last_price_dt date","type":"string"},"ref_price_dt":{"description":"The date at which the last price was reported online. This is earlier to last_seen_date","type":"integer"},"scraped_at_date":{"description":"Listing first seen at first scraped date","type":"number"},"seller_type":{"description":"Seller type for the car","type":"string"},"source":{"description":"Source domain of the listing","type":"string"},"stock_no":{"description":"Stock no of the car","type":"string"},"vdp_url":{"description":"Vehicle Details Page url of the specific car","type":"string"},"vin":{"description":"VIN for the car","type":"string"}},"type":"object"},"Build":{"description":"Describes the Car specification","properties":{"antibrake_sys":{"description":"Antibrake system of the car","type":"string"},"body_type":{"description":"Body type of the car","type":"string"},"city_miles":{"description":"City miles of the car","type":"string"},"cylinders":{"description":"No of cylinders of the car","type":"number"},"doors":{"description":"No of doors of the car","type":"number"},"drivetrain":{"description":"Drivetrain of the car","type":"string"},"engine":{"description":"Engine of the car","type":"string"},"engine_aspiration":{"description":"Engine aspiration of the car","type":"string"},"engine_block":{"description":"Engine block of the car","type":"string"},"engine_measure":{"description":"Engine block of the car","type":"string"},"engine_size":{"description":"Engine size of the car","type":"string"},"fuel_type":{"description":"Fuel type of the car","type":"string"},"highway_miles":{"description":"Highway miles of the car","type":"string"},"made_in":{"description":"Made in of the car","type":"string"},"make":{"description":"Car Make","type":"string"},"model":{"description":"Car model","type":"string"},"overall_height":{"description":"Overall height of the car","type":"string"},"overall_length":{"description":"Overall length of the car","type":"string"},"overall_width":{"description":"Overall width of the car","type":"string"},"std_seating":{"description":"Std seating of the car","type":"string"},"steering_type":{"description":"Steering type of the car","type":"string"},"tank_size":{"description":"Tank size of the car","type":"string"},"transmission":{"description":"Transmission of the car","type":"string"},"trim":{"description":"Trim of the car","type":"string"},"vehicle_type":{"description":"Vehicle type of the car","type":"string"},"year":{"description":"Year of the Car","type":"number"}},"type":"object"},"ComparisonPoint":{"properties":{"dealer_indicator":{"description":"Deal Indicator","type":"string"},"fair_deal_price":{"description":"Fair Deal Price","type":"number"},"similar_vehicles_count":{"description":"Similar Vehicles Count","type":"number"},"vin_price":{"description":"Price for Vin","type":"number"}},"type":"object"},"CompetitorsCarDetails":{"properties":{"avg_market_value":{"description":"Estimated market value","type":"string"},"miles":{"description":"mileage of car","type":"string"},"name":{"description":"Current car name","type":"string"},"price":{"description":"price of car","type":"string"}},"type":"object"},"CompetitorsPoint":{"properties":{"current_car":{"$ref":"#/components/schemas/CompetitorsCarDetails"},"same_car_models":{"items":{"$ref":"#/components/schemas/CompetitorsSameCars"},"type":"array"},"similar_car_models":{"items":{"$ref":"#/components/schemas/CompetitorsSimilarCars"},"type":"array"}},"type":"object"},"CompetitorsSameCars":{"properties":{"avg_market_value":{"description":"Estimated market value of year make model com