GET /search/car/auction/active

The API Authentication Key. Mandatory with all API calls.

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

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

To filter listing on their body type

Car type. Allowed values are - new / used / certified

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

Indicates whether car has had only one owner or not

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

Indicates whether car has clean ownership records

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

To filter listing on City in which they are listed

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

To filter listing on Country in which they are listed

Constraints: {'enum': ['US', 'CA', 'us', 'ca', 'all', 'ALL']}

To filter listing on their cylinders

Dealer id to filter the listings.

Filter based on dealer type independant or franchise

Constraints: {'enum': ['franchise', 'independent']}

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

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

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

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

To filter listing on their drivetrain

To filter listing on their engine

Engine Aspiration to match. Valid filter values are those that our Search facets API returns for unique Engine Aspirations. You can pass in multiple Engine aspirations values comma separated

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

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 to filter listings with engine size in the given range. Range to be given in the format - min-max e.g. 1.0-2

Boolean param to exclude certified cars from search results

A list of dealer ids to exclude from result

A list of sources to exclude from result

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

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']}

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.

Search listings with exact down payment in finance offers, or inside a range with min and max seperated by a dash like finance_down_payment=30-60

Search listings with exact down payment percentage in finance offers, or inside a range with min and max seperated by a dash like finance_down_payment_per=30-60

Search listings with finance offers exactly matching Estimated Monthly Payment(EMI), or inside a range with min and max seperated by a dash like finance_emp=30-60

Search listings with finance offers exactly matching loans Annual Percentage Rate, or inside a range with min and max seperated by a dash like finance_loan_apr=30-60

Search listings with exact finance loan term, or inside a range with min and max seperated by a dash like finance_loan_term=30-60

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

To filter listing on their fuel type

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

A boolean to filter in transit vehicles

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

Boolean param to search for listings that include finance options in them

Boolean param to search for listings that include leasing options in them

To include non vin listings. Default is false

To include_relevant_links. Default is true

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 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 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 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 component of location

Search listings with exact down payment in lease offers, or inside a range with min and max seperated by a dash like lease_down_payment=30-60

Search listings with lease offers exactly matching Estimated Monthly Payment(EMI), or inside a range with min and max seperated by a dash like lease_emp=30-60

Search listings with exact lease term, or inside a range with min and max seperated by a dash like lease_term=30-60

Longitude component of location

To filter listings on their make

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 to filter listings with miles in the given range. Range to be given in the format - min-max e.g. 1000-5000

Filter listings based by number of photo links within given range

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

Make-Model concatenated string. To help passing the results of auto-complete API on mm field, use this parameter and pass in the selected value as is

To filter listings on their model

To filter listing on msa code in which they are listed

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

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

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

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

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

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

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 around the search location (Unit - Miles)

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

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.

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

Constraints: {'minimum': 0}

To filter on vehicle seating capacity

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

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

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

To filter listing on their source only for widget requests

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}

To filter listing on State in which they are listed

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.

To filter listing on their stock number on lot

Comma separated list of 10 letters excert from the 17 letter VIN. The 10 letters to be picked up from the 17 letter VIN are - first 8 letters and the 10th and 11th letter. E.g. For a VIN - 1FTFW1EF3EKE57182 the taxonomy vin would be - 1FTFW1EFEK A taxonomy VIN identified a build of a car and could be used to filter our cars of a particular build. This is an alternative to the vin or ymmt parameters to the search API.

To filter on title type

Constraints: {'enum': ['clean', 'salvage']}

To filter listing on their transmission

To filter listing on their trim

Filter listings on web scraped trim

Filter trim on custom possible matches

To filter listing on their vehicle type

To filter listing on their VIN

Comma separated list of 17 digit vins to search the matching cars for. Only 10 VINs allowed per request. If the request contains more than 10 VINs the first 10 VINs will be considered. Could be used as a More Like This or Similar Vehicles search for the given VINs. Ths vins parameter is an alternative to taxonomy_vins or ymmt parameters available with the search API. vins and taxonomy_vins parameters could be used to filter our cars with the exact build represented by the vins or taxonomy_vins whereas ymmt is a top level filter that does not filter cars by the build attributes like doors, drivetrain, cylinders, body type, body subtype, vehicle type etc

To filter listing on their year

Constraints: {'minLength': 4}

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

Year-Make-Model concatenated string. To help passing the results of auto-complete API on ymm field, use this parameter and pass in the selected value as is

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.

To filter listing on ZIP around which they are listed