Sign in

v1

latestOpenAPI 3.0.02026-07-147195292.0 KB
Car Search

API for auto-completion of inputs

Auto-complete the inputs of your end users

get/search/car/auto-complete

Query parameters

api_keystring

The API Authentication Key. Mandatory with all API calls.

field'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 required

Field name for which you want auto-completion

inputstring string required

Input entered so far

yearstring

To filter listing on their year

makestring

To filter listings on their make

modelstring

To filter listings on their model

trimstring

To filter listing on their trim

body_typestring

To filter listing on their body type

body_subtypestring string

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

vehicle_typestring

To filter listing on their vehicle type

transmissionstring

To filter listing on their transmission

drivetrainstring

To filter listing on their drivetrain

fuel_typestring

To filter listing on their fuel type

exterior_colorstring

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_colorstring

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

enginestring

To filter listing on their engine

engine_sizestring

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_blockstring

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

statestring

To filter listing on State in which they are listed

citystring

To filter listing on City in which they are listed

sourcestring

To filter listing on their source only for widget requests

dealer_idstring string

Dealer id to filter the listings.

country'US' | 'CA' | 'us' | 'ca'

To filter listing on Country in which they are listed

car_type'new' | 'used'

Car type. Allowed values are - new / used

include_non_vin_listings'true' | '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

ignore_caseboolean

Boolean variable to indicate ignore case of current input

term_countsboolean

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

sort_by'index' | 'count'

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

seller_typestring

seller type for autocomplete

radiusinteger

Radius around the search location (Unit - Miles)

zipstring

To filter listing on ZIP around which they are listed

inventory_count_rangestring string

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

exclude_dealer_idsstring string

A list of dealer ids to exclude from result

exclude_sourcesstring string

A list of sources to exclude from result

in_transit'true' | 'false'

A boolean to filter in transit vehicles

facet_min_countnumber

Provide minimum count value for facets

Response

Unique terms available in given field for auto completion