API for auto-completion of inputs

GET

/search/car/auto-complete

Car Search

Auto-complete the inputs of your end users

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://marketcheck-prod.apigee.net/v2/search/car/auto-complete?field=&input='

Response Example

200 - Example 1

{
    "terms": [
        {
            "count": 0,
            "item": "string"
        }
    ]
}

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

body_subtype

string

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

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

exterior_color

string

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

interior_color

string

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

engine

string

optional

To filter listing on their engine

engine_size

string

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

engine_block

string

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

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

source

string

optional

To filter listing on their source only for widget requests

dealer_id

string

optional

Dealer id to filter the listings.

country

string

optional

To filter listing on Country in which they are listed

car_type

string

optional

Car type. Allowed values are - new / used

include_non_vin_listings

string

optional

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_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

inventory_count_range

string

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

exclude_dealer_ids

string

optional

A list of dealer ids to exclude from result

exclude_sources

string

optional

A list of sources to exclude from result

in_transit

string

optional

A boolean to filter in transit vehicles

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

Modified at 2023-08-15 07:36:55

Gets active auction car listings for the given search criteria

Gets active private party car listings for the given search criteria