v1

latestOpenAPI 3.0.02026-07-147195292.0 KB
Car Search

Gets active car listings in UK for the given search criteria

Search cars for sale in UK

get/search/car/uk/active

Query parameters

api_keystring

The API Authentication Key. Mandatory with all API calls.

latitudenumber double

Latitude component of location

longitudenumber double

Longitude component of location

radiusinteger

Radius around the search location (Unit - Miles)

postal_codestring

To filter listing on postal code around which they are listed

zipstring

To filter listing on ZIP around which they are listed

car_type'new' | 'used'

Car type. Allowed values are - new / used

yearstring

To filter listing on their year

year_rangestring string

Year range to filter listings with the year in the range given. Range to be given in the format - min-max e.g. 2019-2021

makestring

To filter listings on their make

modelstring

To filter listings on their model

variantstring

To filter listing on their variant

trimstring

To filter listing on their trim

vinstring

To filter listing on their VIN

body_typestring

To filter listing on their body type

ymmtstring

Comma separated list of Year, Make, Model, Trim combinations. Each combination needs to have the year,make,model, trim values separated by a pipe '|' character in the form year|make|model|trim. e.g. 2010|Audi|A5,2014|Nissan|Sentra|S 6MT,|Honda|City| You could just provide strings of the form - 'year|make||' or 'year|make|model' or '|make|model|' combinations. Individual year / make / model filters provied with the API calls will take precedence over the Year, Make, Model, Trim combinations. The Make, Model, Trim values must be valid values as per the Marketcheck Vin Decoder. If you are using a separate vin decoder then look at using the 'vins' or 'taxonomy_vins' parameter to the search api instead the year|make|model|trim combinations.

transmissionstring

To filter listing on their transmission

doorsstring string

Doors to filter the cars on. Valid filter values are those that our Search facets API returns for unique doors. You can pass in multiple doors values comma separated

drivetrainstring

To filter listing on their drivetrain

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

miles_rangestring string

Miles range to filter listings with miles in the given range. Range to be given in the format - min-max e.g. 1000-5000

price_rangestring string

Price range to filter listings with the price in the range given. Range to be given in the format - min-max e.g. 1000-5000

msrp_rangestring string

MSRP range to filter listings with the msrp in the range given. Range to be given in the format - min-max e.g. 1000-5000

sort_bystring string

Sort by field. Default sort field is distance from the given point

sort_order'asc' | 'desc' | 'ASC' | 'DESC' string

Sort order - asc or desc. Default sort order is asc

rowsinteger

Number of results to return. Default is 10. Max is 50

startinteger

Page number to fetch the results for the given criteria. Default is 0. Pagination is allowed only till first 10000 results for the search and sort criteria. The page value can be only between 1 to 10000/rows

msa_codestring

To filter listing on msa code in which they are listed

facetsstring

The comma separated list of fields for which facets are requested. Facets could be requested in addition to the listings for the search. Please note - The API calls with lots of facet fields may take longer to respond.

range_facetsstring

The comma separated list of numeric fields for which range facets are requested. Range facets could be requested in addition to the listings for the search. Please note - The API calls with lots of range facet fields may take longer to respond.

facet_sort'count' | 'index'

Control sort order of facets with this parameter with default sort being on count, Other available sort is alphabetical sort, which can be obtained by using index as value for this param

statsstring

The list of fields for which stats need to be generated based on the matching listings for the search criteria. The stats consists of mean, max, average and count of listings based on which the stats are calculated for the field. Stats could be requested in addition to the listings for the search. Please note - The API calls with the stats fields may take longer to respond.

country'uk' | 'england' | 'scotland' | 'northan ireland' | 'wales'

To filter listing on Country in which they are listed

plotboolean

If plot has value true results in around 25k coordinates with limited fields to plot respective graph

nodedupboolean

If nodedup is set to true then API will give results without is_searchable i.e multiple listings for single vin

dedupboolean

If dedup is set to true then will give results with is_searchable irrespecive of dealer_id or source

countystring

To filter listing on county in which they are listed

statestring

To filter listing on State in which they are listed

citystring

To filter listing on City in which they are listed

fuel_typestring

To filter listing on their fuel type

stock_nostring

To filter listing on their stock number on lot

dom_rangestring string

Days on Market range to filter cars with the DOM within the given range. Range to be given in the format - min-max e.g. 10-50

dom_active_rangestring string

Active Days on Market range to filter cars with the DOM within the given range. Range to be given in the format - min-max e.g. 10-50

dom_180_rangestring string

Last 180 Days on Market range to filter cars with the DOM within the given range. Range to be given in the format - min-max e.g. 10-50

last_seen_rangestring string

Last seen date range to filter listings with the last seen in the range given. Range to be given in the format [YYYYMMDD] - min-max e.g. 20190523-20190623

first_seen_rangestring string

First seen date range to filter listings with the first seen in the range given. Range to be given in the format [YYYYMMDD] - min-max e.g. 20190523-20190623

first_seen_at_source_rangestring string

First seen at source date range to filter listings with the first seen at source in the range given. Range to be given in the format [YYYYMMDD] - min-max e.g. 20190523-20190623

first_seen_at_mc_rangestring string

First seen at MC date range to filter listings with the first seen at MC in the range given. Range to be given in the format [YYYYMMDD] - min-max e.g. 20190523-20190623

last_seen_daysstring string

Last seen days range to filter listings with the last seen in the range given. Range to be given in the format - min-max e.g. 25-12

first_seen_daysstring string

First seen days range to filter listings with the first seen in the range given. Range to be given in the format - min-max e.g. 25-12

first_seen_at_source_daysstring string

First seen at source days range to filter listings with the first seen at source in the range given. Range to be given in the format - min-max e.g. 25-12

first_seen_at_mc_daysstring string

First seen at MC days range to filter listings with the first seen at MC in the range given. Range to be given in the format - min-max e.g. 25-12

co2_emissionsstring

CO2 emissions

insurance_groupstring

Insurance Group

vehicle_registration_markstring

Vehicle Registration Mark

vehicle_registration_date_rangestring string

Vehicle registration date range to be given in the format [YYYYMMDD] - min-max e.g. 20190523-20190623

num_ownersstring string

Number of owners. Range to be given in the format - min-max e.g. 1000-5000

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

sourcestring

To filter listing on their source only for widget requests

dealer_idstring string

Dealer id to filter the listings.

exclude_sourcesstring string

A list of sources to exclude from result

exclude_dealer_idsstring string

A list of dealer ids to exclude from result

in_transit'true' | 'false'

A boolean to filter in transit vehicles

include_non_vin_listingsboolean

To include non vin listings. Default is false

cylindersstring

To filter listing on their cylinders

photo_linksboolean

A boolean indicating whether to include only those listings that have photo_links in search results, And discard those that don't have them

photo_links_cachedboolean

A boolean indicating whether to include only those listings that have photo_links_cached in search results, And discard those that don't have them

base_exterior_colorstring

Base exterior color to match. Valid filter values are those that our Search facets API returns for unique base exterior colors. You can pass in multiple base interior color values comma separated

base_interior_colorstring

Base interior color to match. Valid filter values are those that our Search facets API returns for unique base interior colors. You can pass in multiple base interior color values comma separated

write_off_categorystring string

write off category

exclude_write_off_categorystring string

To exclude write off category

fca_statusstring string

To filter on fca status

seating_capacitystring string

To filter on vehicle seating capacity

vrmstring string

To filter on vrm

powertrain_typestring string

To filter on powertrain_type

client_filterstrue | false

Flag to add explicit filters set on client level in solr

boosttrue | false

Flag to sort listings based on client filter score in solr

car_location_seller_namestring

Filter cars on seller name

car_location_streetstring

Filter cars on street name

car_location_citystring

Filter cars on city

car_location_countystring

Filter cars on county

car_location_zipstring

To filter listing on car ZIP around which they are listed

car_location_latitudenumber double

Latitude component of car location

car_location_longitudenumber double

Longitude component of car location

price_change'positive' | 'negative'

Query to filter listings based on their positive and negative price change

price_change_rangestring string

Price change range to filter listings with price change within given price_change_range. Range to be given in the format - min-max e.g. 10-500

active_inventory_date_rangestring string

date range to filter listings that were active within given date range. Range to be given in the format [YYYYMMDD] - min-max e.g. 20190523-20190623

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_size_rangestring string

Engine size range to filter listings with engine size in the given range. Range to be given in the format - min-max e.g. 1.0-2

uvc_idstring string

To filter on uvc id

highway_mpg_rangestring string

Highway mileage range for UK to filter listings with the mileage in the range given. Range to be given in the format - min-max e.g. 1000-5000

city_mpg_rangestring string

City mileage range for UK to filter listings with the mileage in the range given. Range to be given in the format - min-max e.g. 1000-5000

combined_mpg_rangestring string

Combined mileage range for UK to filter listings with the mileage in the range given. Range to be given in the format - min-max e.g. 1000-5000

ownedboolean

Used in combination with dealer_id or source, when true returns the listings actually owned by dealer himself

min_photo_linksstring string

Filter listings based by number of photo links within given range

min_photo_links_cachedstring string

Filter listings based by number of cached photo links within given range

Response

List of all cars listings matching the search & filter criteria

num_foundinteger

The number of listings found