GET /search/car/auto-complete
Operation ID: autoComplete
Auth: api_key
Description
Auto-complete the inputs of your end users
Parameters (36)
(string, query, optional)
The API Authentication Key. Mandatory with all API calls.
(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
(string, query, optional)
To filter listing on their body type
(string, query, optional)
Car type. Allowed values are - new / used
Constraints: {'enum': ['new', 'used']}
(string, query, optional)
To filter listing on City in which they are listed
(string, query, optional, default: US)
To filter listing on Country in which they are listed
Constraints: {'enum': ['US', 'CA', 'us', 'ca']}
(string, query, optional)
Dealer id to filter the listings.
(string, query, optional)
To filter listing on their drivetrain
(string, query, optional)
To filter listing on their engine
(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
(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
(string, query, optional)
A list of dealer ids to exclude from result
(string, query, optional)
A list of sources to exclude from result
(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
(number, query, optional, default: 1)
Provide minimum count value for facets
(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']}
(string, query, optional)
To filter listing on their fuel type
(boolean, query, optional, default: True)
Boolean variable to indicate ignore case of current input
(string, query, optional)
A boolean to filter in transit vehicles
Constraints: {'enum': ['true', 'false']}
(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']}
(string, query, required)
Input entered so far
(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
(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
(string, query, optional)
To filter listings on their make
(string, query, optional)
To filter listings on their model
(integer, query, optional)
Radius around the search location (Unit - Miles)
Constraints: {'minimum': 0, 'maximum': 7000}
(string, query, optional)
seller type for autocomplete
(string, query, optional, default: index)
Sort the response, either by index or count(default)
Constraints: {'enum': ['index', 'count']}
(string, query, optional)
To filter listing on their source only for widget requests
(string, query, optional)
To filter listing on State in which they are listed
(boolean, query, optional, default: False)
Boolean variable to indicate wheather to include term counts as well in response
(string, query, optional)
To filter listing on their transmission
(string, query, optional)
To filter listing on their trim
(string, query, optional)
To filter listing on their vehicle type
(string, query, optional)
To filter listing on their year
Constraints: {'minLength': 4}
(string, query, optional)
To filter listing on ZIP around which they are listed
No probe data for this endpoint yet.