GET /search/car/auto-complete

apigee.net:marketcheck-cars

Summary: API for auto-completion of inputs
Operation ID: autoComplete
Auth: api_key
Description

Auto-complete the inputs of your end users

Parameters (36)

api_key (string, query, optional)

The API Authentication Key. Mandatory with all API calls.

body_subtype (string, query, optional)

Body subtype to filter the listings 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

body_type (string, query, optional)

To filter listing on their body type

car_type (string, query, optional)

Car type. Allowed values are - new / used

Constraints: {'enum': ['new', 'used']}

city (string, query, optional)

To filter listing on City in which they are listed

country (string, query, optional, default: US)

To filter listing on Country in which they are listed

Constraints: {'enum': ['US', 'CA', 'us', 'ca']}

dealer_id (string, query, optional)

Dealer id to filter the listings.

drivetrain (string, query, optional)

To filter listing on their drivetrain

engine (string, query, optional)

To filter listing on their engine

engine_block (string, query, optional)

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

engine_size (string, query, optional)

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

exclude_dealer_ids (string, query, optional)

A list of dealer ids to exclude from result

exclude_sources (string, query, optional)

A list of sources to exclude from result

exterior_color (string, query, optional)

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

facet_min_count (number, query, optional, default: 1)

Provide minimum count value for facets

field (string, query, required)

Field name for which you want auto-completion

Constraints: {'enum': ['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']}

fuel_type (string, query, optional)

To filter listing on their fuel type

ignore_case (boolean, query, optional, default: True)

Boolean variable to indicate ignore case of current input

in_transit (string, query, optional)

A boolean to filter in transit vehicles

Constraints: {'enum': ['true', 'false']}

include_non_vin_listings (string, query, optional, default: false)

Flag to indicate whether to include non vin listing terms in results or not. Default is false to avoid un-normalised terms from non vin listings out of results

Constraints: {'enum': ['true', 'false']}

input (string, query, required)

Input entered so far

interior_color (string, query, optional)

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

inventory_count_range (string, query, optional)

Inventory count range to filter listings with count of total listings in dealers inventory. Range to be given in the format - min-max e.g. 10-50

make (string, query, optional)

To filter listings on their make

model (string, query, optional)

To filter listings on their model

radius (integer, query, optional)

Radius around the search location (Unit - Miles)

Constraints: {'minimum': 0, 'maximum': 7000}

seller_type (string, query, optional)

seller type for autocomplete

sort_by (string, query, optional, default: index)

Sort the response, either by index or count(default)

Constraints: {'enum': ['index', 'count']}

source (string, query, optional)

To filter listing on their source only for widget requests

state (string, query, optional)

To filter listing on State in which they are listed

term_counts (boolean, query, optional, default: False)

Boolean variable to indicate wheather to include term counts as well in response

transmission (string, query, optional)

To filter listing on their transmission

trim (string, query, optional)

To filter listing on their trim

vehicle_type (string, query, optional)

To filter listing on their vehicle type

year (string, query, optional)

To filter listing on their year

Constraints: {'minLength': 4}

zip (string, query, optional)

To filter listing on ZIP around which they are listed

No probe data for this endpoint yet.