@datafire/apigee_marketcheck_cars v5.0.0
@datafire/apigee_marketcheck_cars
Client library for Marketcheck APIs
Installation and Usage
npm install --save @datafire/apigee_marketcheck_cars
let apigee_marketcheck_cars = require('@datafire/apigee_marketcheck_cars').create();
.then(data => {
console.log(data);
});
Description
Actions
crm_check
Check whether particular vin has had a listing after stipulated date or not
apigee_marketcheck_cars.crm_check({
"vin": "",
"sale_date": ""
}, context)
Input
- input
object
- api_key
string
: The API Authentication Key. Mandatory with all API calls. - vin required
string
: vin for which CRM check needs to be done - sale_date required
string
: sale date after which listing has appeared or not
- api_key
Output
- output CRMResponse
getDealer
Get a particular dealer's information by its id
apigee_marketcheck_cars.getDealer({
"dealer_id": ""
}, context)
Input
- input
object
- api_key
string
: The API Authentication Key. Mandatory with all API calls. - dealer_id required
string
: Dealer id to get all the dealer info attributes - provider
boolean
: boolean param to include site providers name in response
- api_key
Output
- output Dealer
dealerSearch
The dealers API returns a list of dealers around a given point and radius.
apigee_marketcheck_cars.dealerSearch({}, context)
Input
- input
object
- api_key
string
: The API Authentication Key. Mandatory with all API calls. - latitude
number
: Latitude component of location - longitude
number
: Longitude component of location - radius
integer
: Radius around the search location - rows
number
: Number of results to return. Default is 10. Max is 50 - start
number
: Offset for the search results. Default is 1. - country
string
(values: us, ca, CA, Ca, US, Us): Country to search dealers from, Value can either be US or CA - dealer_type
string
(values: independent, franchise): Search dealers based on their type - either franchise or independent - city
string
: City to search dealers from - state
string
: State to search dealers from - inventory_url
string
: inventory_url of dealer to be searched - zip
string
: Zip code around which to search for dealers - sort_order
string
(values: asc, desc): sort for dealer search, can either be asc or desc, default is asc - provider
boolean
: boolean param to include site providers name in response
- api_key
Output
- output DealersResponse
history
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
apigee_marketcheck_cars.history({
"vin": ""
}, context)
Input
- input
object
- api_key
string
: The API Authentication Key. Mandatory with all API calls. - vin required
string
: The VIN to identify the car to fetch the listing history. Must be a valid 17 char VIN - fields
string
: List of fields to fetch, in case the default fields list in the response is to be trimmed down - page
number
: Page number to fetch the results for the given criteria. Default is 1.
- api_key
Output
- output
array
- items HistoricalListing
getListing
Get a particular listing by its id
apigee_marketcheck_cars.getListing({
"id": ""
}, context)
Input
- input
object
- api_key
string
: The API Authentication Key. Mandatory with all API calls. - id required
string
: Listing id to get all the listing attributes
- api_key
Output
- output Listing
getListingExtra
Get listing options, features, seller comments
apigee_marketcheck_cars.getListingExtra({
"id": ""
}, context)
Input
- input
object
- api_key
string
: The API Authentication Key. Mandatory with all API calls. - id required
string
: Listing id to get all the long text listing attributes
- api_key
Output
- output ListingExtraAttributes
getListingMedia
Get listing media (photo, photos) by id
apigee_marketcheck_cars.getListingMedia({
"id": ""
}, context)
Input
- input
object
- api_key
string
: The API Authentication Key. Mandatory with all API calls. - id required
string
: Listing id to get all the listing attributes
- api_key
Output
- output ListingMedia
getMDS
Get the basic information on specifications for a car identified by a valid VIN
apigee_marketcheck_cars.getMDS({
"vin": ""
}, context)
Input
- input
object
- api_key
string
: The API Authentication Key. Mandatory with all API calls. - vin required
string
: VIN to decode - exact
boolean
: Exact parameter - latitude
number
: Latitude component of location - longitude
number
: Longitude component of location - radius
integer
: Radius around the search location - debug
integer
(values: 0, 1): Debug parameter - include_sold
boolean
: To fetch sold vins - country
string
: Country for which to fetch MDS
- api_key
Output
- output Mds
getPopularCars
Get make model wise top 50 popular cars on national, state, city level
apigee_marketcheck_cars.getPopularCars({
"car_type": ""
}, context)
Input
- input
object
- api_key
string
: The API Authentication Key. Mandatory with all API calls. - state
string
: State level sales count - city_state
string
: City level sales count, pipe seperated like city_state=jacksonville|FL - car_type required
string
(values: new, used): Inventory type for which popular count is to be searched - country
string
(values: us, ca, US, CA): Country for which the sales records are to be searched
- api_key
Output
- output PopularCars
getSalesCount
Get a sales count for city, state or national level by make, model, year, trim or taxonomy vin
apigee_marketcheck_cars.getSalesCount({}, context)
Input
- input
object
- api_key
string
: The API Authentication Key. Mandatory with all API calls. - car_type
string
(values: new, used): Inventory type for which sales count is to be searched, default is used - make
string
: Make for which sales count is to be searched - mm
string
: Make-Model for which sales count is to be searched, pipe seperated like mm=ford|f-150 - ymm
string
: Year-Make-Model for which sales count is to be searched, pipe seperated like ymm=2015|ford|f-150 - ymmt
string
: Year-Make-Model-Trim for which sales count is to be searched, pipe seperated like ymmt=2015|ford|f-150|platinum - taxonomy_vin
string
: taxonomy_vin for which sales count is to be searched - state
string
: State level sales count - city_state
string
: City level sales count, pipe seperated like city_state=jacksonville|FL - vin
string
: VIN that will be transformed to taxonomy_vin - country
string
(values: us, ca, US, CA): Country for which the sales records are to be searched
- api_key
Output
- output Sales
search.get
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 10000 rows. The search API facilitates the following use cases - 1. Search Cars around a given geo-point within a given radius 2. Search cars for a specific year / make / model or combination of these 3. Search cars matching multiple year, make, model combinatins in the same search request 4. Filter results by most car specification attributes 5. Search for similar cars by VIN or Taxonomy VIN 6. Filter cars within a given price / miles / days on market (dom) range 7. Specify a sort order for the results on price / miles / dom / listed date 8. Search cars for a given City / State combination 9. Get Facets to build the search drill downs 10. Get Market averages for price/miles/dom for your search
apigee_marketcheck_cars.search.get({}, context)
Input
- input
object
- api_key
string
: The API Authentication Key. Mandatory with all API calls. - latitude
number
: Latitude component of location - longitude
number
: Longitude component of location - radius
integer
: Radius around the search location - zip
string
: car search bases on zipcode - include_lease
boolean
: Boolean param to search for listings that include leasing options in them - include_finance
boolean
: Boolean param to search for listings that include finance options in them - lease_term
string
: Search listings with exact lease term, or inside a range with min and max seperated by a dash like lease_term=30-60 - lease_down_payment
string
: Search listings with exact down payment in lease offers, or inside a range with min and max seperated by a dash like lease_down_payment=30-60 - lease_emp
string
: Search listings with lease offers exactly matching Estimated Monthly Payment(EMI), or inside a range with min and max seperated by a dash like lease_emp=30-60 - finance_loan_term
string
: Search listings with exact finance loan term, or inside a range with min and max seperated by a dash like finance_loan_term=30-60 - finance_loan_apr
string
: Search listings with finance offers exactly matching loans Annual Percentage Rate, or inside a range with min and max seperated by a dash like finance_loan_apr=30-60 - finance_emp
string
: Search listings with finance offers exactly matching Estimated Monthly Payment(EMI), or inside a range with min and max seperated by a dash like finance_emp=30-60 - finance_down_payment
string
: Search listings with exact down payment in finance offers, or inside a range with min and max seperated by a dash like finance_down_payment=30-60 - finance_down_payment_per
string
: Search listings with exact down payment percentage in finance offers, or inside a range with min and max seperated by a dash like finance_down_payment_per=30-60 - car_type
string
(values: new, used, certified): Car type. Allowed values are - new / used / certified - seller_type
string
: 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. - carfax_1_owner
string
(values: true, false): Indicates whether car has had only one owner or not - carfax_clean_title
string
(values: true, false): Indicates whether car has clean ownership records - year
string
: 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. - make
string
: 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 - model
string
: 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. - trim
string
: 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 - dealer_id
string
: Dealer id to filter the cars. - vin
string
: Car vin to search - source
string
: 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 - body_type
string
: 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. - body_subtype
string
: 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 - vehicle_type
string
: 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 - vins
string
: 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 - taxonomy_vins
string
: 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. - ymmt
string
: 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. - match
string
: 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 - cylinders
string
: 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 - transmission
string
: 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 - speeds
string
: 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 - doors
string
: 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 - drivetrain
string
: 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 - exterior_color
string
: 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 - interior_color
string
: 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 - base_exterior_color
string
: Base exterior color to match. Valid filter values are those that our Search facets API returns for unique base exterior colors. You can pass in multiple base interior color values comma separated - base_interior_color
string
: Base interior color to match. Valid filter values are those that our Search facets API returns for unique base interior colors. You can pass in multiple base interior color values comma separated - engine
string
: Filter listings on engine - engine_size
string
: Engine Size to match. Valid filter values are those that our Search facets API returns for unique engine size. You can pass in multiple engine size values comma separated - engine_aspiration
string
: 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 - engine_block
string
: 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 - miles_range
string
: Miles range to filter cars with miles in the given range. Range to be given in the format - min-max e.g. 1000-5000 - price_range
string
: 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 - dom_range
string
: 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 - sort_by
string
: Sort by field - allowed fields are distance|price|miles|dom|age|posted_at|year. Default sort field is distance from the given point - sort_order
string
: Sort order - asc or desc. Default sort order is distance from a point. - rows
string
: Number of results to return. Default is 10. Max is 50 - start
string
: Page number to fetch the results for the given criteria. Default is 1. Pagination is allowed only till first 10000 results for the search and sort criteria. The page value can be only between 1 to 10000/rows - facets
string
: 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_size, 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. - range_facets
string
: The comma separated list of numeric fields for which range facets are requested. Supported fields are - price, miles, dom. 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. - facet_sort
string
(values: count, index): Control sort order of facets with this parameter with default sort being on count, Other available sort is alphabetical sort, which can be obtained by using index as value for this param - stats
string
: 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. - country
string
: Filter on Country, by default US. Search available on US (United States) and CA (Canada) - plot
boolean
: If plot has value true results in around 25k coordinates with limited fields to plot respective graph - nodedup
boolean
: If nodedup is set to true then API will give results without is_searchable i.e multiple listings for single vin - dedup
boolean
: If dedup is set to true then will give results with is_searchable irrespecive of dealer_id or source - owned
boolean
: Used in combination with dealer_id or source, when true returns the listings actually owned by dealer himself - state
string
: Filter listsings on State - city
string
: Filter listings on city - dealer_name
string
: Filter listings on dealer_name - trim_o
string
: Filter listings on web scraped trim - trim_r
string
: Filter trim on custom possible matches - dom_active_range
string
: 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 - dom_180_range
string
: 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 - exclude_certified
boolean
: Boolean param to exclude certified cars from search results - fuel_type
string
: fuel type of the car to be searched - dealer_type
string
(values: franchise, independent): Filter based on dealer type independant or franchise - photo_links
boolean
: A boolean indicating whether to include only those listings that have photo_links in search results, And discard those that don't have them
- api_key
Output
- output SearchResponse
search.auction.get
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 10000 rows. The search API facilitates the following use cases - 1. Search Cars around a given geo-point within a given radius 2. Search cars for a specific year / make / model or combination of these 3. Search cars matching multiple year, make, model combinatins in the same search request 4. Filter results by most car specification attributes 5. Search for similar cars by VIN or Taxonomy VIN 6. Filter cars within a given price / miles / days on market (dom) range 7. Specify a sort order for the results on price / miles / dom / listed date 8. Search cars for a given City / State combination 9. Get Facets to build the search drill downs 10. Get Market averages for price/miles/dom for your search
apigee_marketcheck_cars.search.auction.get({}, context)
Input
- input
object
- api_key
string
: The API Authentication Key. Mandatory with all API calls. - latitude
number
: Latitude component of location - longitude
number
: Longitude component of location - radius
integer
: Radius around the search location - zip
string
: car search bases on zipcode - include_lease
boolean
: Boolean param to search for listings that include leasing options in them - include_finance
boolean
: Boolean param to search for listings that include finance options in them - lease_term
string
: Search listings with exact lease term, or inside a range with min and max seperated by a dash like lease_term=30-60 - lease_down_payment
string
: Search listings with exact down payment in lease offers, or inside a range with min and max seperated by a dash like lease_down_payment=30-60 - lease_emp
string
: Search listings with lease offers exactly matching Estimated Monthly Payment(EMI), or inside a range with min and max seperated by a dash like lease_emp=30-60 - finance_loan_term
string
: Search listings with exact finance loan term, or inside a range with min and max seperated by a dash like finance_loan_term=30-60 - finance_loan_apr
string
: Search listings with finance offers exactly matching loans Annual Percentage Rate, or inside a range with min and max seperated by a dash like finance_loan_apr=30-60 - finance_emp
string
: Search listings with finance offers exactly matching Estimated Monthly Payment(EMI), or inside a range with min and max seperated by a dash like finance_emp=30-60 - finance_down_payment
string
: Search listings with exact down payment in finance offers, or inside a range with min and max seperated by a dash like finance_down_payment=30-60 - finance_down_payment_per
string
: Search listings with exact down payment percentage in finance offers, or inside a range with min and max seperated by a dash like finance_down_payment_per=30-60 - car_type
string
(values: new, used, certified): Car type. Allowed values are - new / used / certified - carfax_1_owner
string
(values: true, false): Indicates whether car has had only one owner or not - carfax_clean_title
string
(values: true, false): Indicates whether car has clean ownership records - year
string
: 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. - make
string
: 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 - model
string
: 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. - trim
string
: 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 - dealer_id
string
: Dealer id to filter the cars. - vin
string
: Car vin to search - source
string
: 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 - body_type
string
: 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. - body_subtype
string
: 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 - vehicle_type
string
: 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 - vins
string
: 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 - taxonomy_vins
string
: 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. - ymmt
string
: 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. - match
string
: 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 - cylinders
string
: 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 - transmission
string
: 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 - speeds
string
: 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 - doors
string
: 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 - drivetrain
string
: 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 - exterior_color
string
: 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 - interior_color
string
: 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 - base_exterior_color
string
: Base exterior color to match. Valid filter values are those that our Search facets API returns for unique base exterior colors. You can pass in multiple base interior color values comma separated - base_interior_color
string
: Base interior color to match. Valid filter values are those that our Search facets API returns for unique base interior colors. You can pass in multiple base interior color values comma separated - engine
string
: Filter listings on engine - engine_size
string
: Engine Size to match. Valid filter values are those that our Search facets API returns for unique engine size. You can pass in multiple engine size values comma separated - engine_aspiration
string
: 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 - engine_block
string
: 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 - miles_range
string
: Miles range to filter cars with miles in the given range. Range to be given in the format - min-max e.g. 1000-5000 - price_range
string
: 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 - dom_range
string
: 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 - sort_by
string
: Sort by field - allowed fields are distance|price|miles|dom|age|posted_at|year. Default sort field is distance from the given point - sort_order
string
: Sort order - asc or desc. Default sort order is distance from a point. - rows
string
: Number of results to return. Default is 10. Max is 50 - start
string
: Page number to fetch the results for the given criteria. Default is 1. Pagination is allowed only till first 10000 results for the search and sort criteria. The page value can be only between 1 to 10000/rows - facets
string
: 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_size, 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. - range_facets
string
: The comma separated list of numeric fields for which range facets are requested. Supported fields are - price, miles, dom. 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. - facet_sort
string
(values: count, index): Control sort order of facets with this parameter with default sort being on count, Other available sort is alphabetical sort, which can be obtained by using index as value for this param - stats
string
: 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. - country
string
: Filter on Country, by default US. Search available on US (United States) and CA (Canada) - plot
boolean
: If plot has value true results in around 25k coordinates with limited fields to plot respective graph - nodedup
boolean
: If nodedup is set to true then API will give results without is_searchable i.e multiple listings for single vin - dedup
boolean
: If dedup is set to true then will give results with is_searchable irrespecive of dealer_id or source - owned
boolean
: Used in combination with dealer_id or source, when true returns the listings actually owned by dealer himself - state
string
: Filter listsings on State - city
string
: Filter listings on city - dealer_name
string
: Filter listings on dealer_name - trim_o
string
: Filter listings on web scraped trim - trim_r
string
: Filter trim on custom possible matches - dom_active_range
string
: 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 - dom_180_range
string
: 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 - exclude_certified
boolean
: Boolean param to exclude certified cars from search results - fuel_type
string
: fuel type of the car to be searched - photo_links
boolean
: A boolean indicating whether to include only those listings that have photo_links in search results, And discard those that don't have them
- api_key
Output
- output SearchResponse
searchAutoComplete
Auto-complete the inputs of your end users
apigee_marketcheck_cars.searchAutoComplete({
"field": "",
"input": ""
}, context)
Input
- input
object
- api_key
string
: The API Authentication Key. Mandatory with all API calls. - field required
string
(values: ymm, mm, make, model, trim, body_type, body_subtype, vehicle_type, transmission, drivetrain, fuel_type, exterior_color, interior_color, engine, engine_size, engine_block, state, city): Field name for which you want auto-completion - input required
string
: Input entered so far - year
string
: Apply year filter to selections - make
string
: Apply make filter to selections - model
string
: Apply model filter to selections - trim
string
: Apply trim filter to selections - body_type
string
: Apply body_type filter to selections - body_subtype
string
: Apply body_subtype filter to selections - vehicle_type
string
: Apply vehicle_type filter to selections - transmission
string
: Apply transmission filter to selections - drivetrain
string
: Apply drivetrain filter to selections - fuel_type
string
: Apply fuel_type filter to selections - exterior_color
string
: Apply exterior_color filter to selections - interior_color
string
: Apply interior_color filter to selections - engine
string
: Apply engine filter to selections - engine_size
string
: Apply engine_size filter to selections - engine_block
string
: Apply engine_block filter to selections - state
string
: State level auto-completion - city
string
: City level auto-completion - country
string
(values: US, CA): Country for which auto-completion is to be performed - car_type
string
(values: new, used): Inventory type - ignore_case
boolean
: Boolean variable to indicate ignore case of current input - term_counts
boolean
: Boolean variable to indicate wheather to include term counts as well in response - sort_by
string
(values: index, count): Sort the response, either by index or count(default)
- api_key
Output
- output SearchAutoCompleteResponse
search.fsbo.get
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 10000 rows. The search API facilitates the following use cases - 1. Search Cars around a given geo-point within a given radius 2. Search cars for a specific year / make / model or combination of these 3. Search cars matching multiple year, make, model combinatins in the same search request 4. Filter results by most car specification attributes 5. Search for similar cars by VIN or Taxonomy VIN 6. Filter cars within a given price / miles / days on market (dom) range 7. Specify a sort order for the results on price / miles / dom / listed date 8. Search cars for a given City / State combination 9. Get Facets to build the search drill downs 10. Get Market averages for price/miles/dom for your search
apigee_marketcheck_cars.search.fsbo.get({}, context)
Input
- input
object
- api_key
string
: The API Authentication Key. Mandatory with all API calls. - latitude
number
: Latitude component of location - longitude
number
: Longitude component of location - radius
integer
: Radius around the search location - zip
string
: car search bases on zipcode - include_lease
boolean
: Boolean param to search for listings that include leasing options in them - include_finance
boolean
: Boolean param to search for listings that include finance options in them - lease_term
string
: Search listings with exact lease term, or inside a range with min and max seperated by a dash like lease_term=30-60 - lease_down_payment
string
: Search listings with exact down payment in lease offers, or inside a range with min and max seperated by a dash like lease_down_payment=30-60 - lease_emp
string
: Search listings with lease offers exactly matching Estimated Monthly Payment(EMI), or inside a range with min and max seperated by a dash like lease_emp=30-60 - finance_loan_term
string
: Search listings with exact finance loan term, or inside a range with min and max seperated by a dash like finance_loan_term=30-60 - finance_loan_apr
string
: Search listings with finance offers exactly matching loans Annual Percentage Rate, or inside a range with min and max seperated by a dash like finance_loan_apr=30-60 - finance_emp
string
: Search listings with finance offers exactly matching Estimated Monthly Payment(EMI), or inside a range with min and max seperated by a dash like finance_emp=30-60 - finance_down_payment
string
: Search listings with exact down payment in finance offers, or inside a range with min and max seperated by a dash like finance_down_payment=30-60 - finance_down_payment_per
string
: Search listings with exact down payment percentage in finance offers, or inside a range with min and max seperated by a dash like finance_down_payment_per=30-60 - car_type
string
(values: new, used, certified): Car type. Allowed values are - new / used / certified - carfax_1_owner
string
(values: true, false): Indicates whether car has had only one owner or not - carfax_clean_title
string
(values: true, false): Indicates whether car has clean ownership records - year
string
: 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. - make
string
: 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 - model
string
: 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. - trim
string
: 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 - dealer_id
string
: Dealer id to filter the cars. - vin
string
: Car vin to search - source
string
: 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 - body_type
string
: 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. - body_subtype
string
: 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 - vehicle_type
string
: 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 - vins
string
: 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 - taxonomy_vins
string
: 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. - ymmt
string
: 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. - match
string
: 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 - cylinders
string
: 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 - transmission
string
: 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 - speeds
string
: 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 - doors
string
: 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 - drivetrain
string
: 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 - exterior_color
string
: 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 - interior_color
string
: 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 - base_exterior_color
string
: Base exterior color to match. Valid filter values are those that our Search facets API returns for unique base exterior colors. You can pass in multiple base interior color values comma separated - base_interior_color
string
: Base interior color to match. Valid filter values are those that our Search facets API returns for unique base interior colors. You can pass in multiple base interior color values comma separated - engine
string
: Filter listings on engine - engine_size
string
: Engine Size to match. Valid filter values are those that our Search facets API returns for unique engine size. You can pass in multiple engine size values comma separated - engine_aspiration
string
: 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 - engine_block
string
: 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 - miles_range
string
: Miles range to filter cars with miles in the given range. Range to be given in the format - min-max e.g. 1000-5000 - price_range
string
: 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 - dom_range
string
: 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 - sort_by
string
: Sort by field - allowed fields are distance|price|miles|dom|age|posted_at|year. Default sort field is distance from the given point - sort_order
string
: Sort order - asc or desc. Default sort order is distance from a point. - rows
string
: Number of results to return. Default is 10. Max is 50 - start
string
: Page number to fetch the results for the given criteria. Default is 1. Pagination is allowed only till first 10000 results for the search and sort criteria. The page value can be only between 1 to 10000/rows - facets
string
: 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_size, 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. - range_facets
string
: The comma separated list of numeric fields for which range facets are requested. Supported fields are - price, miles, dom. 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. - facet_sort
string
(values: count, index): Control sort order of facets with this parameter with default sort being on count, Other available sort is alphabetical sort, which can be obtained by using index as value for this param - stats
string
: 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. - country
string
: Filter on Country, by default US. Search available on US (United States) and CA (Canada) - plot
boolean
: If plot has value true results in around 25k coordinates with limited fields to plot respective graph - nodedup
boolean
: If nodedup is set to true then API will give results without is_searchable i.e multiple listings for single vin - dedup
boolean
: If dedup is set to true then will give results with is_searchable irrespecive of dealer_id or source - owned
boolean
: Used in combination with dealer_id or source, when true returns the listings actually owned by dealer himself - state
string
: Filter listsings on State - city
string
: Filter listings on city - dealer_name
string
: Filter listings on dealer_name - trim_o
string
: Filter listings on web scraped trim - trim_r
string
: Filter trim on custom possible matches - dom_active_range
string
: 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 - dom_180_range
string
: 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 - exclude_certified
boolean
: Boolean param to exclude certified cars from search results - fuel_type
string
: fuel type of the car to be searched - photo_links
boolean
: A boolean indicating whether to include only those listings that have photo_links in search results, And discard those that don't have them
- api_key
Output
- output SearchResponse
search90Days
This endpoint is the meat of the API and serves many purposes. This API produces a list of 90 days cars from the market for the given search criteria. The API results are limited to allow pagination upto 10000 rows. The search API facilitates the following use cases - 1. Search Cars around a given geo-point within a given radius 2. Search cars for a specific year / make / model or combination of these 3. Search cars matching multiple year, make, model combinatins in the same search request 4. Filter results by most car specification attributes 5. Search for similar cars by VIN or Taxonomy VIN 6. Filter cars within a given price / miles / days on market (dom) range 7. Specify a sort order for the results on price / miles / dom / listed date 8. Search cars for a given City / State combination 9. Get Facets to build the search drill downs 10. Get Market averages for price/miles/dom for your search
apigee_marketcheck_cars.search90Days({}, context)
Input
- input
object
- api_key
string
: The API Authentication Key. Mandatory with all API calls. - latitude
number
: Latitude component of location - longitude
number
: Longitude component of location - radius
integer
: Radius around the search location - zip
string
: car search bases on zipcode - include_lease
boolean
: Boolean param to search for listings that include leasing options in them - include_finance
boolean
: Boolean param to search for listings that include finance options in them - lease_term
string
: Search listings with exact lease term, or inside a range with min and max seperated by a dash like lease_term=30-60 - lease_down_payment
string
: Search listings with exact down payment in lease offers, or inside a range with min and max seperated by a dash like lease_down_payment=30-60 - lease_emp
string
: Search listings with lease offers exactly matching Estimated Monthly Payment(EMI), or inside a range with min and max seperated by a dash like lease_emp=30-60 - finance_loan_term
string
: Search listings with exact finance loan term, or inside a range with min and max seperated by a dash like finance_loan_term=30-60 - finance_loan_apr
string
: Search listings with finance offers exactly matching loans Annual Percentage Rate, or inside a range with min and max seperated by a dash like finance_loan_apr=30-60 - finance_emp
string
: Search listings with finance offers exactly matching Estimated Monthly Payment(EMI), or inside a range with min and max seperated by a dash like finance_emp=30-60 - finance_down_payment
string
: Search listings with exact down payment in finance offers, or inside a range with min and max seperated by a dash like finance_down_payment=30-60 - finance_down_payment_per
string
: Search listings with exact down payment percentage in finance offers, or inside a range with min and max seperated by a dash like finance_down_payment_per=30-60 - car_type
string
(values: new, used, certified): Car type. Allowed values are - new / used / certified - carfax_1_owner
string
(values: true, false): Indicates whether car has had only one owner or not - carfax_clean_title
string
(values: true, false): Indicates whether car has clean ownership records - year
string
: 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. - make
string
: 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 - model
string
: 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. - trim
string
: 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 - dealer_id
string
: Dealer id to filter the cars. - vin
string
: Car vin to search - source
string
: 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 - body_type
string
: 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. - body_subtype
string
: 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 - vehicle_type
string
: 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 - vins
string
: 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 - taxonomy_vins
string
: 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. - ymmt
string
: 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. - match
string
: 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 - cylinders
string
: 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 - transmission
string
: 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 - speeds
string
: 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 - doors
string
: 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 - drivetrain
string
: 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 - exterior_color
string
: 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 - interior_color
string
: 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 - base_exterior_color
string
: Base exterior color to match. Valid filter values are those that our Search facets API returns for unique base exterior colors. You can pass in multiple base interior color values comma separated - base_interior_color
string
: Base interior color to match. Valid filter values are those that our Search facets API returns for unique base interior colors. You can pass in multiple base interior color values comma separated - engine
string
: Filter listings on engine - engine_size
string
: Engine Size to match. Valid filter values are those that our Search facets API returns for unique engine size. You can pass in multiple engine size values comma separated - engine_aspiration
string
: 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 - engine_block
string
: 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 - miles_range
string
: Miles range to filter cars with miles in the given range. Range to be given in the format - min-max e.g. 1000-5000 - price_range
string
: 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 - dom_range
string
: 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 - sort_by
string
: Sort by field - allowed fields are distance|price|miles|dom|age|posted_at|year. Default sort field is distance from the given point - sort_order
string
: Sort order - asc or desc. Default sort order is distance from a point. - rows
string
: Number of results to return. Default is 10. Max is 50 - start
string
: Page number to fetch the results for the given criteria. Default is 1. Pagination is allowed only till first 10000 results for the search and sort criteria. The page value can be only between 1 to 10000/rows - facets
string
: 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_size, 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. - range_facets
string
: The comma separated list of numeric fields for which range facets are requested. Supported fields are - price, miles, dom. 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. - facet_sort
string
(values: count, index): Control sort order of facets with this parameter with default sort being on count, Other available sort is alphabetical sort, which can be obtained by using index as value for this param - stats
string
: 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. - country
string
: Filter on Country, by default US. Search available on US (United States) and CA (Canada) - plot
boolean
: If plot has value true results in around 25k coordinates with limited fields to plot respective graph - nodedup
boolean
: If nodedup is set to true then API will give results without is_searchable i.e multiple listings for single vin - dedup
boolean
: If dedup is set to true then will give results with is_searchable irrespecive of dealer_id or source - owned
boolean
: Used in combination with dealer_id or source, when true returns the listings actually owned by dealer himself - state
string
: Filter listsings on State - city
string
: Filter listings on city - dealer_name
string
: Filter listings on dealer_name - trim_o
string
: Filter listings on web scraped trim - trim_r
string
: Filter trim on custom possible matches - dom_active_range
string
: 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 - dom_180_range
string
: 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 - exclude_certified
boolean
: Boolean param to exclude certified cars from search results - fuel_type
string
: fuel type of the car to be searched - photo_links
boolean
: A boolean indicating whether to include only those listings that have photo_links in search results, And discard those that don't have them - sold
boolean
: sold parameter to display only sold listings - last_seen_range
string
: Last seen date range to filter listings with the last seen in the range given. Range to be given in the format YYYYMMDD - min-max e.g. 20190523-20190623 - first_seen_range
string
: First seen date range to filter listings with the last seen in the range given. Range to be given in the format YYYYMMDD - min-max e.g. 20190523-20190623
- api_key
Output
- output SearchResponse
specsAutoComplete
Auto-complete the inputs of your end users, not from active set but from taxonomy (decoder database)
apigee_marketcheck_cars.specsAutoComplete({
"field": "",
"input": ""
}, context)
Input
- input
object
- api_key
string
: The API Authentication Key. Mandatory with all API calls. - field required
string
(values: make, model, trim, body_type, body_subtype, vehicle_type, transmission, drivetrain, fuel_type, engine, engine_size, engine_block): Field name for which you want auto-completion - input required
string
: Input entered so far - year
string
: Apply year filter to selections - make
string
: Apply make filter to selections - model
string
: Apply model filter to selections - trim
string
: Apply trim filter to selections - body_type
string
: Apply body_type filter to selections - body_subtype
string
: Apply body_subtype filter to selections - vehicle_type
string
: Apply vehicle_type filter to selections - transmission
string
: Apply transmission filter to selections - drivetrain
string
: Apply drivetrain f
- api_key