API for auto-completion of inputs

Auto-complete the inputs of your end users

Request

Query Params

api_key

string

optional

The API Authentication Key. Mandatory with all API calls.

field

string

required

Field name for which you want auto-completion

input

string

required

Input entered so far

year

string

optional

To filter listing on their year

make

string

optional

To filter listings on their make

model

string

optional

To filter listings on their model

trim

string

optional

To filter listing on their trim

body_type

string

optional

To filter listing on their body type

vehicle_type

string

optional

To filter listing on their vehicle type

transmission

string

optional

To filter listing on their transmission

drivetrain

string

optional

To filter listing on their drivetrain

fuel_type

string

optional

To filter listing on their fuel type

color

string

optional

Color of the vehicle

engine

string

optional

To filter listing on their engine

state

string

optional

To filter listing on State in which they are listed

city

string

optional

To filter listing on City in which they are listed

inventory_type

string

optional

To filter listing on their condition. Either used or new

ignore_case

string

optional

Boolean variable to indicate ignore case of current input

term_counts

string

optional

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

sort_by

string

optional

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

seller_type

string

optional

seller type for autocomplete

radius

integer

optional

Radius around the search location (Unit - Miles)

zip

string

optional

To filter listing on ZIP around which they are listed

facet_min_count

number

optional

Provide minimum count value for facets

Responses

🟢200Unique terms available in given field for auto completion

application/json

Body

Search auto complete query response

terms

array [object {2}]

optional

count

integer

optional

The number of listings with item as value for given field

item

string

optional

The actual term that either has prefix or contains given input

🔴500Error