Marketcheck APIs
  1. Car Search
Marketcheck APIs
  • Car Search
    • Get dealers active inventory
      GET
    • Listing by id
      GET
    • Long text Listings attributes for Listing with the given id
      GET
    • Listing media by id
      GET
    • Listing by id
      GET
    • Long text Listings attributes for Listing with the given id
      GET
    • Listing media by id
      GET
    • Listing by id
      GET
    • Long text Listings attributes for Listing with the given id
      GET
    • Listing media by id
      GET
    • Listing by id
      GET
    • Long text Listings attributes for Listing with the given id
      GET
    • Listing media by id
      GET
    • Gets active car listings for the given search criteria
      GET
    • Gets active auction car listings for the given search criteria
      GET
    • API for auto-completion of inputs
      GET
    • Gets active private party car listings for the given search criteria
      GET
    • Gets Recent car listings for the given search criteria
      GET
    • Gets active car listings in UK for the given search criteria
      GET
    • Gets Recent UK car listings for the given search criteria
      GET
  • Recall Search
    • Recall info by vin
      GET
  • CRM Cleanse API
    • CRM check of a particular vin
      GET
  • Dealer API
    • Dealer by id
      GET
    • Dealer by id
      GET
    • Dealer by id
      GET
    • Dealer by id
      GET
    • Dealer by id
      GET
    • Find car dealers around
      GET
    • Find car dealers around
      GET
    • Find car dealers around
      GET
    • Find car dealers around
      GET
    • Find car dealers around
      GET
  • VIN Decoder API
    • EPI VIN Decoder
    • NeoVIN Decoder
    • VIN Decoder
    • API for auto-completion of inputs based on taxonomy
    • API for getting terms from taxonomy
  • Cars History API
    • Get a cars online listing history
    • Get a cars online listing history
  • Car Cached Image
    • Fetch cached image
  • Heavy Equipment Search
    • Heavy equipment listing by id
    • Long text Heavy equipment Listings attributes for Listing with the given id
    • Listing media by id
    • Gets active heavy equipment listings for the given search criteria
    • API for auto-completion of inputs
  • Motorcycle Search
    • Motorcycle listing by id
    • Long text Motorcycle Listings attributes for Listing with the given id
    • Motorcycle listing media by id
    • Gets active motorcycle listings for the given search criteria
    • API for auto-completion of inputs
  • RV Search
    • RV listing by id
    • Long text RV Listings attributes for Listing with the given id
    • Listing media by id
    • RV listing by id
    • Long text RV Listings attributes for Listing with the given id
    • Listing media by id
    • Gets active RV listings for the given search criteria
    • API for auto-completion of inputs
    • Gets active RV listings for the given search criteria
  • Cars Market API
    • Market Days Supply
    • Get make model wise top 50 popular cars on national, state, city level
    • Predict car price based on it's specifications
    • Predict fare value of car for UK based on YMMT & miles
    • Predict car price for UK based on it's specifications
    • Get sales count by make, model, year, trim or taxonomy vin
    • Price, Miles and Days on Market stats
  • Rank Car Listings
    • Compute relative rank for car listings.
    • Compute relative rank for car listings.
  • OEM Incentive Search
    • Gets oem incentive listings for the given search criteria
  • client filters
    • get client filters
    • set client filters
  1. Car Search

Get dealers active inventory

GET
/car/dealer/inventory/active
Car Search
Get dealers active inventory
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://marketcheck-prod.apigee.net/v2/car/dealer/inventory/active'
Response Response Example
200 - Example 1
{
    "facets": {
        "base_exterior_color": [
            {
                "count": 0,
                "item": "string"
            }
        ],
        "base_interior_color": [
            {
                "count": 0,
                "item": "string"
            }
        ],
        "body_subtype": [
            {
                "count": 0,
                "item": "string"
            }
        ],
        "body_type": [
            {
                "count": 0,
                "item": "string"
            }
        ],
        "car_type": [
            {
                "count": 0,
                "item": "string"
            }
        ],
        "carfax_1_owner": [
            {
                "count": 0,
                "item": "string"
            }
        ],
        "carfax_clean_title": [
            {
                "count": 0,
                "item": "string"
            }
        ],
        "city": [
            {
                "count": 0,
                "item": "string"
            }
        ],
        "cylinders": [
            {
                "count": 0,
                "item": "string"
            }
        ],
        "data_source": [
            {
                "count": 0,
                "item": "string"
            }
        ],
        "dealer_id": [
            {
                "count": 0,
                "item": "string"
            }
        ],
        "dealer_type": [
            {
                "count": 0,
                "item": "string"
            }
        ],
        "doors": [
            {
                "count": 0,
                "item": "string"
            }
        ],
        "drivetrain": [
            {
                "count": 0,
                "item": "string"
            }
        ],
        "engine": [
            {
                "count": 0,
                "item": "string"
            }
        ],
        "engine_aspiration": [
            {
                "count": 0,
                "item": "string"
            }
        ],
        "engine_block": [
            {
                "count": 0,
                "item": "string"
            }
        ],
        "engine_size": [
            {
                "count": 0,
                "item": "string"
            }
        ],
        "exterior_color": [
            {
                "count": 0,
                "item": "string"
            }
        ],
        "fuel_type": [
            {
                "count": 0,
                "item": "string"
            }
        ],
        "interior_color": [
            {
                "count": 0,
                "item": "string"
            }
        ],
        "make": [
            {
                "count": 0,
                "item": "string"
            }
        ],
        "model": [
            {
                "count": 0,
                "item": "string"
            }
        ],
        "seller_name": [
            {
                "count": 0,
                "item": "string"
            }
        ],
        "seller_name_o": [
            {
                "count": 0,
                "item": "string"
            }
        ],
        "seller_type": [
            {
                "count": 0,
                "item": "string"
            }
        ],
        "source": [
            {
                "count": 0,
                "item": "string"
            }
        ],
        "state": [
            {
                "count": 0,
                "item": "string"
            }
        ],
        "transmission": [
            {
                "count": 0,
                "item": "string"
            }
        ],
        "trim": [
            {
                "count": 0,
                "item": "string"
            }
        ],
        "trim_o": [
            {
                "count": 0,
                "item": "string"
            }
        ],
        "trim_r": [
            {
                "count": 0,
                "item": "string"
            }
        ],
        "vehicle_type": [
            {
                "count": 0,
                "item": "string"
            }
        ],
        "year": [
            {
                "count": 0,
                "item": "string"
            }
        ]
    },
    "listings": [
        {
            "base_ext_color": "string",
            "base_int_color": "string",
            "build": {
                "antibrake_sys": "string",
                "body_subtype": "string",
                "body_type": "string",
                "city_miles": "string",
                "city_mpg": 0,
                "cylinders": 0,
                "doors": 0,
                "drivetrain": "string",
                "engine": "string",
                "engine_aspiration": "string",
                "engine_block": "string",
                "engine_measure": "string",
                "engine_size": 0,
                "fuel_type": "string",
                "highway_miles": "string",
                "highway_mpg": 0,
                "made_in": "string",
                "make": "string",
                "model": "string",
                "opt_seating": "string",
                "overall_height": "string",
                "overall_length": "string",
                "overall_width": "string",
                "powertrain_type": "string",
                "short_trim": "string",
                "std_seating": "string",
                "steering_type": "string",
                "tank_size": "string",
                "transmission": "string",
                "trim": "string",
                "trim_r": "string",
                "vehicle_type": "string",
                "year": 0
            },
            "carfax_1_owner": true,
            "carfax_clean_title": true,
            "data_source": "string",
            "dealer": {
                "city": "string",
                "country": "string",
                "county": "string",
                "dealer_type": "string",
                "dealership_group_name": "string",
                "id": 0,
                "latitude": "string",
                "longitude": "string",
                "msa_code": "string",
                "name": "string",
                "phone": "string",
                "seller_email": "string",
                "state": "string",
                "street": "string",
                "website": "string",
                "zip": "string"
            },
            "dist": 0,
            "dom": 0,
            "dom_180": 0,
            "dom_active": 0,
            "exterior_color": "string",
            "financing_options": [
                {
                    "down_payment": 0,
                    "down_payment_percentage": 0,
                    "estimated_monthly_payment": 0,
                    "loan_apr": 0,
                    "loan_term": 0
                }
            ],
            "first_seen_at": 0,
            "first_seen_at_date": "string",
            "heading": "string",
            "id": "string",
            "in_transit": true,
            "interior_color": "string",
            "inventory_type": "string",
            "is_certified": 0,
            "is_translated": true,
            "last_seen_at": 0,
            "last_seen_at_date": "string",
            "leasing_options": [
                {
                    "down_payment": 0,
                    "estimated_monthly_payment": 0,
                    "lease_term": 0
                }
            ],
            "media": {
                "photo_links": [
                    "string"
                ],
                "photo_links_cached": [
                    "string"
                ]
            },
            "miles": 0,
            "model_code": "string",
            "msrp": 0,
            "price": 0,
            "price_change_percent": 0,
            "ref_miles": "string",
            "ref_miles_dt": 0,
            "ref_price": "string",
            "ref_price_dt": 0,
            "scraped_at": 0,
            "scraped_at_date": "string",
            "seller_type": "string",
            "source": "string",
            "stock_no": "string",
            "title_type": "string",
            "vdp_url": "string",
            "vin": "string"
        }
    ],
    "num_found": 0,
    "range_facets": {
        "dom": {},
        "dom_180": {},
        "dom_active": {},
        "finance_down_payment": {},
        "finance_emp": {},
        "finance_loan_apr": {},
        "finance_loan_term": {},
        "lease_down_payment": {},
        "lease_emp": {},
        "lease_term": {},
        "miles": {},
        "msrp": {},
        "price": {}
    },
    "stats": {
        "dom": {
            "count": 0,
            "max": 0,
            "mean": 0,
            "median": 0,
            "min": 0,
            "missing": 0,
            "stddev": 0,
            "sum": 0,
            "sum_of_squares": 0
        },
        "dom_180": {
            "count": 0,
            "max": 0,
            "mean": 0,
            "median": 0,
            "min": 0,
            "missing": 0,
            "stddev": 0,
            "sum": 0,
            "sum_of_squares": 0
        },
        "dom_active": {
            "count": 0,
            "max": 0,
            "mean": 0,
            "median": 0,
            "min": 0,
            "missing": 0,
            "stddev": 0,
            "sum": 0,
            "sum_of_squares": 0
        },
        "finance_down_payment": {
            "count": 0,
            "max": 0,
            "mean": 0,
            "median": 0,
            "min": 0,
            "missing": 0,
            "stddev": 0,
            "sum": 0,
            "sum_of_squares": 0
        },
        "finance_down_payment_per": {
            "count": 0,
            "max": 0,
            "mean": 0,
            "median": 0,
            "min": 0,
            "missing": 0,
            "stddev": 0,
            "sum": 0,
            "sum_of_squares": 0
        },
        "finance_emp": {
            "count": 0,
            "max": 0,
            "mean": 0,
            "median": 0,
            "min": 0,
            "missing": 0,
            "stddev": 0,
            "sum": 0,
            "sum_of_squares": 0
        },
        "finance_loan_apr": {
            "count": 0,
            "max": 0,
            "mean": 0,
            "median": 0,
            "min": 0,
            "missing": 0,
            "stddev": 0,
            "sum": 0,
            "sum_of_squares": 0
        },
        "finance_loan_term": {
            "count": 0,
            "max": 0,
            "mean": 0,
            "median": 0,
            "min": 0,
            "missing": 0,
            "stddev": 0,
            "sum": 0,
            "sum_of_squares": 0
        },
        "lease_down_payment": {
            "count": 0,
            "max": 0,
            "mean": 0,
            "median": 0,
            "min": 0,
            "missing": 0,
            "stddev": 0,
            "sum": 0,
            "sum_of_squares": 0
        },
        "lease_emp": {
            "count": 0,
            "max": 0,
            "mean": 0,
            "median": 0,
            "min": 0,
            "missing": 0,
            "stddev": 0,
            "sum": 0,
            "sum_of_squares": 0
        },
        "lease_term": {
            "count": 0,
            "max": 0,
            "mean": 0,
            "median": 0,
            "min": 0,
            "missing": 0,
            "stddev": 0,
            "sum": 0,
            "sum_of_squares": 0
        },
        "miles": {
            "count": 0,
            "max": 0,
            "mean": 0,
            "median": 0,
            "min": 0,
            "missing": 0,
            "stddev": 0,
            "sum": 0,
            "sum_of_squares": 0
        },
        "msrp": {
            "count": 0,
            "max": 0,
            "mean": 0,
            "median": 0,
            "min": 0,
            "missing": 0,
            "stddev": 0,
            "sum": 0,
            "sum_of_squares": 0
        },
        "price": {
            "count": 0,
            "max": 0,
            "mean": 0,
            "median": 0,
            "min": 0,
            "missing": 0,
            "stddev": 0,
            "sum": 0,
            "sum_of_squares": 0
        }
    }
}

Request

Query Params
api_key
string 
optional
The API Authentication Key. Mandatory with all API calls.
append_api_key
string 
optional
Flag on whether to include api_key in response API urls (if any)
latitude
number 
optional
Latitude component of location
longitude
number 
optional
Longitude component of location
radius
integer 
optional
Radius around the search location (Unit - Miles)
zip
string 
optional
To filter listing on ZIP around which they are listed
include_lease
string 
optional
Boolean param to search for listings that include leasing options in them
include_finance
string 
optional
Boolean param to search for listings that include finance options in them
lease_term
string 
optional
Search listings with exact lease term, or inside a range with min and max seperated by a dash like lease_term=30-60
lease_down_payment
string 
optional
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
lease_emp
string 
optional
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
finance_loan_term
string 
optional
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
finance_loan_apr
string 
optional
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
finance_emp
string 
optional
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
finance_down_payment
string 
optional
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
finance_down_payment_per
string 
optional
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
car_type
string 
optional
Car type. Allowed values are - new / used / certified
carfax_1_owner
string 
optional
Indicates whether car has had only one owner or not
carfax_clean_title
string 
optional
Indicates whether car has clean ownership records
year_range
string 
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
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
dealer_id
string 
optional
Dealer id to filter the listings.
vin
string 
optional
To filter listing on their VIN
source
string 
optional
To filter listing on their source
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
vins
string 
optional
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
taxonomy_vins
string 
optional
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.
mm
string 
optional
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
ymm
string 
optional
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
ymmt
string 
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.
match
string 
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
cylinders
string 
optional
To filter listing on their cylinders
transmission
string 
optional
To filter listing on their transmission
doors
string 
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 
optional
To filter listing on their drivetrain
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
base_exterior_color
string 
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 
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
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_aspiration
string 
optional
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
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
highway_mpg_range
string 
optional
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
city_mpg_range
string 
optional
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
miles_range
string 
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
price_range
string 
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
msrp_range
string 
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
dom_range
string 
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
sort_by
string 
optional
Sort by field. Default sort field is distance from the given point
sort_order
string 
optional
Sort order - asc or desc. Default sort order is asc
rows
integer 
optional
Number of results to return. Default is 10. Max is 50
start
integer 
optional
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
include_non_vin_listings
string 
optional
To include non vin listings. Default is false
msa_code
string 
optional
To filter listing on msa code in which they are listed
facets
string 
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.
range_facets
string 
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.
facet_sort
string 
optional
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
stats
string 
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.
country
string 
optional
To filter listing on Country in which they are listed
plot
string 
optional
If plot has value true results in around 25k coordinates with limited fields to plot respective graph
nodedup
string 
optional
If nodedup is set to true then API will give results without is_searchable i.e multiple listings for single vin
dedup
string 
optional
If dedup is set to true then will give results with is_searchable irrespecive of dealer_id or source
owned
string 
optional
Used in combination with dealer_id or source, when true returns the listings actually owned by dealer himself
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
dealer_name
string 
optional
Filter listings on dealer_name
dealership_group_name
string 
optional
Name of the dealership group to search for
trim_o
string 
optional
Filter listings on web scraped trim
trim_r
string 
optional
Filter trim on custom possible matches
dom_active_range
string 
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_180_range
string 
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
exclude_certified
string 
optional
Boolean param to exclude certified cars from search results
fuel_type
string 
optional
To filter listing on their fuel type
dealer_type
string 
optional
Filter based on dealer type independant or franchise
photo_links
string 
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
string 
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
stock_no
string 
optional
To filter listing on their stock number on lot
last_seen_range
string 
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
first_seen_range
string 
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
first_seen_at_source_range
string 
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_at_mc_range
string 
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
last_seen_days
string 
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
first_seen_days
string 
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_at_source_days
string 
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_mc_days
string 
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
include_relevant_links
string 
optional
To include_relevant_links. Default is true
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
in_transit
string 
optional
A boolean to filter in transit vehicles
seating_capacity
string 
optional
To filter on vehicle seating capacity
engine_size_range
string 
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
powertrain_type
string 
optional
To filter on powertrain_type
min_photo_links
string 
optional
Filter listings based by number of photo links within given range
min_photo_links_cached
string 
optional
Filter listings based by number of cached photo links within given range

Responses

🟢200List of all cars listings matching the search & filter criteria
application/json
Body
Search query response
facets
object (CarSearchFacets) 
optional
base_exterior_color
array[object (FacetItem) {2}] 
optional
base_interior_color
array[object (FacetItem) {2}] 
optional
body_subtype
array[object (FacetItem) {2}] 
optional
body_type
array[object (FacetItem) {2}] 
optional
car_type
array[object (FacetItem) {2}] 
optional
carfax_1_owner
array[object (FacetItem) {2}] 
optional
carfax_clean_title
array[object (FacetItem) {2}] 
optional
city
array[object (FacetItem) {2}] 
optional
cylinders
array[object (FacetItem) {2}] 
optional
data_source
array[object (FacetItem) {2}] 
optional
dealer_id
array[object (FacetItem) {2}] 
optional
dealer_type
array[object (FacetItem) {2}] 
optional
doors
array[object (FacetItem) {2}] 
optional
drivetrain
array[object (FacetItem) {2}] 
optional
engine
array[object (FacetItem) {2}] 
optional
engine_aspiration
array[object (FacetItem) {2}] 
optional
engine_block
array[object (FacetItem) {2}] 
optional
engine_size
array[object (FacetItem) {2}] 
optional
exterior_color
array[object (FacetItem) {2}] 
optional
fuel_type
array[object (FacetItem) {2}] 
optional
interior_color
array[object (FacetItem) {2}] 
optional
make
array[object (FacetItem) {2}] 
optional
model
array[object (FacetItem) {2}] 
optional
seller_name
array[object (FacetItem) {2}] 
optional
seller_name_o
array[object (FacetItem) {2}] 
optional
seller_type
array[object (FacetItem) {2}] 
optional
source
array[object (FacetItem) {2}] 
optional
state
array[object (FacetItem) {2}] 
optional
transmission
array[object (FacetItem) {2}] 
optional
trim
array[object (FacetItem) {2}] 
optional
trim_o
array[object (FacetItem) {2}] 
optional
trim_r
array[object (FacetItem) {2}] 
optional
vehicle_type
array[object (FacetItem) {2}] 
optional
year
array[object (FacetItem) {2}] 
optional
listings
array[object (BaseListing) {43}] 
optional
base_ext_color
string 
optional
Base exterior color of the car
base_int_color
string 
optional
Base interior color of the car
build
object (Build) 
optional
Describes the Car specification
carfax_1_owner
boolean 
optional
Flag to indicate whether listing is carfax_1_owner
carfax_clean_title
boolean 
optional
Flag to indicate whether listing is carfax_clean_title
data_source
string 
optional
Data source of the listing
dealer
object (NestDealer) 
optional
dist
number <double>
optional
Distance of the car's location from the specified user lcoation
dom
integer 
optional
Days on Market value for the car based on current and historical listings found in the Marketcheck database for this car
dom_180
integer 
optional
Days on Market value for the car based on current and last 6 month listings found in the Marketcheck database for this car
dom_active
integer 
optional
Days on Market value for the car based on current and last 30 days listings found in the Marketcheck database for this car
exterior_color
string 
optional
Exterior color of the car
financing_options
array[object (ListingFinance) {5}] 
optional
Array of all finance offers for this listing
first_seen_at
integer 
optional
Listing first seen at first scraped timestamp
first_seen_at_date
string 
optional
Listing first seen at first scraped date
heading
string 
optional
Listing title as displayed on the source website
id
string 
optional
Unique identifier representing a specific listing from the Marketcheck database
in_transit
boolean 
optional
in_transit of the listing
interior_color
string 
optional
Interior color of the car
inventory_type
string 
optional
Inventory type of car
is_certified
integer 
optional
Certified car
is_translated
boolean 
optional
is_translated of the listing
last_seen_at
integer 
optional
Listing last seen at (most recent) timestamp
last_seen_at_date
string 
optional
Listing last seen at (most recent) date
leasing_options
array[object (ListingLease) {3}] 
optional
Array of all finance offers for this listing
media
object (ListingNestMedia) 
optional
miles
integer 
optional
Odometer reading / reported miles usage for the car
model_code
string 
optional
model_code of the listing
msrp
integer 
optional
MSRP for the car
price
integer 
optional
Asking price for the car
price_change_percent
number <double>
optional
Percentage difference between the cars's current price and ref_price i.e. last reported price
ref_miles
string 
optional
Last Odometer reading / reported miles usage for the car. If the asking miles value is not or is available then the last_miles could perhaps be used. last_miles is the miles for the car listed on the source website as of last_miles_dt date
ref_miles_dt
integer 
optional
The date at which the last miles was reported online. This is earlier to last_seen_date
ref_price
string 
optional
Last reported price for the car. If the asking price value is not or is available then the last_price could perhaps be used. last_price is the price for the car listed on the source website as of last_price_dt date
ref_price_dt
integer 
optional
The date at which the last price was reported online. This is earlier to last_seen_date
scraped_at
number 
optional
Listing last seen at date timestamp
scraped_at_date
string 
optional
Listing last seen at date
seller_type
string 
optional
Seller type for the car
source
string 
optional
Source domain of the listing
stock_no
string 
optional
Stock number of car in dealers inventory
title_type
string 
optional
title_type of the listing
vdp_url
string 
optional
Vehicle Details Page url of the specific car
vin
string 
optional
VIN for the car
num_found
integer 
optional
The number of listings found
range_facets
object (CarSearchRangeFacets) 
optional
dom
object 
optional
dom_180
object 
optional
dom_active
object 
optional
finance_down_payment
object 
optional
finance_emp
object 
optional
finance_loan_apr
object 
optional
finance_loan_term
object 
optional
lease_down_payment
object 
optional
lease_emp
object 
optional
lease_term
object 
optional
miles
object 
optional
msrp
object 
optional
price
object 
optional
stats
object (CarSearchStats) 
optional
dom
object (StatsItem) 
optional
dom_180
object (StatsItem) 
optional
dom_active
object (StatsItem) 
optional
finance_down_payment
object (StatsItem) 
optional
finance_down_payment_per
object (StatsItem) 
optional
finance_emp
object (StatsItem) 
optional
finance_loan_apr
object (StatsItem) 
optional
finance_loan_term
object (StatsItem) 
optional
lease_down_payment
object (StatsItem) 
optional
lease_emp
object (StatsItem) 
optional
lease_term
object (StatsItem) 
optional
miles
object (StatsItem) 
optional
msrp
object (StatsItem) 
optional
price
object (StatsItem) 
optional
🔴500Error
Modified at 2023-08-15 07:36:55
Next
Listing by id
Built with