GET /search/car/uk/active

apigee.net:marketcheck-cars

Summary: Gets active car listings in UK for the given search criteria
Operation ID: search
Auth: api_key
Description

Search cars for sale in UK

Parameters (100)

active_inventory_date_range (string, query, optional)

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

api_key (string, query, optional)

The API Authentication Key. Mandatory with all API calls.

append_api_key (boolean, query, optional, default: False)

Flag on whether to include api_key in response API urls (if any)

base_exterior_color (string, query, optional)

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_color (string, query, optional)

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

body_type (string, query, optional)

To filter listing on their body type

boost (boolean, query, optional, default: True)

Flag to sort listings based on client filter score in solr

Constraints: {'enum': [True, False]}

car_location_city (string, query, optional)

Filter cars on city

car_location_county (string, query, optional)

Filter cars on county

car_location_latitude (number, query, optional)

Latitude component of car location

car_location_longitude (number, query, optional)

Longitude component of car location

car_location_seller_name (string, query, optional)

Filter cars on seller name

car_location_street (string, query, optional)

Filter cars on street name

car_location_zip (string, query, optional)

To filter listing on car ZIP around which they are listed

car_type (string, query, optional)

Car type. Allowed values are - new / used

Constraints: {'enum': ['new', 'used']}

city (string, query, optional)

To filter listing on City in which they are listed

city_mpg_range (string, query, optional)

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

client_filters (boolean, query, optional, default: True)

Flag to add explicit filters set on client level in solr

Constraints: {'enum': [True, False]}

co2_emissions (string, query, optional)

CO2 emissions

combined_mpg_range (string, query, optional)

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

country (string, query, optional, default: uk)

To filter listing on Country in which they are listed

Constraints: {'enum': ['uk', 'england', 'scotland', 'northan ireland', 'wales']}

county (string, query, optional)

To filter listing on county in which they are listed

cylinders (string, query, optional)

To filter listing on their cylinders

dealer_id (string, query, optional)

Dealer id to filter the listings.

dedup (boolean, query, optional)

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

dom_180_range (string, query, optional)

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

dom_active_range (string, query, optional)

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_range (string, query, optional)

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

doors (string, query, optional)

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

drivetrain (string, query, optional)

To filter listing on their drivetrain

engine (string, query, optional)

To filter listing on their engine

engine_size (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

engine_size_range (string, query, optional)

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

exclude_dealer_ids (string, query, optional)

A list of dealer ids to exclude from result

exclude_sources (string, query, optional)

A list of sources to exclude from result

exclude_write_off_category (string, query, optional)

To exclude write off category

exterior_color (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

facet_sort (string, query, optional, default: count)

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

Constraints: {'enum': ['count', 'index']}

facets (string, query, optional)

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.

fca_status (string, query, optional)

To filter on fca status

first_seen_at_mc_days (string, query, optional)

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

first_seen_at_mc_range (string, query, optional)

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

first_seen_at_source_days (string, query, optional)

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_source_range (string, query, optional)

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_days (string, query, optional)

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_range (string, query, optional)

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

fuel_type (string, query, optional)

To filter listing on their fuel type

highway_mpg_range (string, query, optional)

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

in_transit (string, query, optional)

A boolean to filter in transit vehicles

Constraints: {'enum': ['true', 'false']}

include_non_vin_listings (boolean, query, optional, default: False)

To include non vin listings. Default is false

insurance_group (string, query, optional)

Insurance Group

interior_color (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

inventory_count_range (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

last_seen_days (string, query, optional)

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

last_seen_range (string, query, optional)

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

latitude (number, query, optional)

Latitude component of location

longitude (number, query, optional)

Longitude component of location

make (string, query, optional)

To filter listings on their make

match (string, query, optional)

Comma separated list of Year, Make, Model, Trim fields. For example - year,make,model,trim fields for which user wants to do an exact match

miles_range (string, query, optional)

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

min_photo_links (string, query, optional)

Filter listings based by number of photo links within given range

min_photo_links_cached (string, query, optional)

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

model (string, query, optional)

To filter listings on their model

msa_code (string, query, optional)

To filter listing on msa code in which they are listed

msrp_range (string, query, optional)

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

nodedup (boolean, query, optional)

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

num_owners (string, query, optional)

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

owned (boolean, query, optional)

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

photo_links (boolean, query, optional)

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_cached (boolean, query, optional)

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

plot (boolean, query, optional)

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

postal_code (string, query, optional)

To filter listing on postal code around which they are listed

powertrain_type (string, query, optional)

To filter on powertrain_type

price_change (string, query, optional)

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

Constraints: {'enum': ['positive', 'negative']}

price_change_range (string, query, optional)

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

price_range (string, query, optional)

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

radius (integer, query, optional)

Radius around the search location (Unit - Miles)

Constraints: {'minimum': 0, 'maximum': 7000}

range_facets (string, query, optional)

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.

rows (integer, query, optional, default: 10)

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

Constraints: {'minimum': 0}

seating_capacity (string, query, optional)

To filter on vehicle seating capacity

sort_by (string, query, optional)

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

sort_order (string, query, optional)

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

Constraints: {'enum': ['asc', 'desc', 'ASC', 'DESC']}

source (string, query, optional)

To filter listing on their source only for widget requests

start (integer, query, optional, default: 0)

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

Constraints: {'minimum': 0}

state (string, query, optional)

To filter listing on State in which they are listed

stats (string, query, optional)

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.

stock_no (string, query, optional)

To filter listing on their stock number on lot

transmission (string, query, optional)

To filter listing on their transmission

trim (string, query, optional)

To filter listing on their trim

ulez_compliant (boolean, query, optional)

Filter listings based on drive into ultra low emmition zone

uvc_id (string, query, optional)

To filter on uvc id

variant (string, query, optional)

To filter listing on their variant

vehicle_registration_date_range (string, query, optional)

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

vehicle_registration_mark (string, query, optional)

Vehicle Registration Mark

vrm (string, query, optional)

To filter on vrm

write_off_category (string, query, optional)

write off category

year (string, query, optional)

To filter listing on their year

Constraints: {'minLength': 4}

year_range (string, query, optional)

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

ymmt (string, query, optional)

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.

zip (string, query, optional)

To filter listing on ZIP around which they are listed

No probe data for this endpoint yet.