Marketcheck APIs
  1. Heavy Equipment 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
    • Dealer by id
    • Dealer by id
    • Dealer by id
    • Dealer by id
    • Find car dealers around
    • Find car dealers around
    • Find car dealers around
    • Find car dealers around
    • Find car dealers around
  • 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
      GET
    • Long text Heavy equipment Listings attributes for Listing with the given id
      GET
    • Listing media by id
      GET
    • Gets active heavy equipment listings for the given search criteria
      GET
    • API for auto-completion of inputs
      GET
  • 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. Heavy Equipment Search

Gets active heavy equipment listings for the given search criteria

GET
/search/heavy-equipment/active
Heavy Equipment Search
This endpoint provides search on heavy equipment inventory. This API produces a list of currently active heavy equipments from the market for the given search criteria. The API results are limited to allow pagination upto 5000 rows.
The search API facilitates the following use cases -
1.
Search heavy equipments around a given geo-point within a given radius
2.
Search heavy equipments for a specific year / make / model or combination of these
3.
Search heavy equipments matching multiple year, make, model combinatins in the same search request
4.
Filter results by most heavy equipment specification attributes
5.
Filter heavy equipments within a given price / miles range
6.
Specify a sort order for the results on price / miles / listed date
7.
Search heavy equipments for a given City / State combination
8.
Get Facets to build the search drill downs
9.
Get Market averages for price/miles for your search
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://marketcheck-prod.apigee.net/v2/search/heavy-equipment/active'
Response Response Example
200 - Example 1
{
    "facets": {},
    "listings": [
        {
            "build": {
                "body_type": "string",
                "category": "string",
                "condition": "string",
                "drivetrain": "string",
                "engine": "string",
                "fuel_type": "string",
                "make": "string",
                "model": "string",
                "sub_category": "string",
                "transmission": "string",
                "trim": "string",
                "year": 0
            },
            "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,
            "dp_url": "string",
            "exterior_color": "string",
            "first_seen_at": 0,
            "first_seen_at_date": "string",
            "heading": "string",
            "id": "string",
            "interior_color": "string",
            "inventory_type": "string",
            "last_seen_at": 0,
            "last_seen_at_date": "string",
            "media": {
                "photo_links": [
                    "string"
                ],
                "photo_links_cached": [
                    "string"
                ]
            },
            "miles": 0,
            "msrp": 0,
            "price": 0,
            "scraped_at": 0,
            "scraped_at_date": "string",
            "seller_type": "string",
            "source": "string",
            "stock_no": "string",
            "vin": "string"
        }
    ],
    "num_found": 0,
    "range_facets": {},
    "stats": {}
}

Request

Query Params
api_key
string 
optional
The API Authentication Key. Mandatory with all API calls.
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
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
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
latitude
number 
optional
Latitude component of location
longitude
number 
optional
Longitude component of location
radius
integer 
optional
Radius around the search location (Unit - Miles)
search_text
string 
optional
To search a substring across entire document
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
vin
string 
optional
To filter listing on their VIN
inventory_type
string 
optional
To filter listing on their condition. Either used or new
stock_no
string 
optional
To filter listing on their stock number on lot
source
string 
optional
To filter listing on their source
dealer_name
string 
optional
Filter listings on dealer_name
dealer_id
string 
optional
Dealer id to filter the listings.
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
fuel_type
string 
optional
To filter listing on their fuel type
transmission
string 
optional
To filter listing on their transmission
drivetrain
string 
optional
To filter listing on their drivetrain
body_type
string 
optional
To filter listing on their body type
category
string 
optional
To filter heavy equipments on their category
sub_category
string 
optional
To filter heavy equipments on their sub-category
hours_used_range
string 
optional
Hours used range to filter heavy equipments with the their usage in the range given. Range to be given in the format - min-max e.g. 1000-5000
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
zip
string 
optional
To filter listing on ZIP around which they are listed
msa_code
string 
optional
To filter listing on msa code in which they are listed
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
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.
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
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

Responses

🟢200List of all heavy equipment listings matching the search & filter criteria
application/json
Body
Heavy Equipments search query response
facets
object 
optional
listings
array[object (HeavyEquipmentsBaseListing) {23}] 
optional
build
object (HeavyEquipmentsBuild) 
optional
Describes the Heavy Equipments specification
dealer
object (NestDealer) 
optional
dist
number <double>
optional
Distance of the quipments's location from the specified user lcoation
dp_url
string 
optional
Details Page url of the specific heavy equipment
exterior_color
string 
optional
Exterior color of the heavy equipment
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
interior_color
string 
optional
Interior color of the heavy equipment
inventory_type
string 
optional
Inventory type of heavy equipment
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
media
object (ListingNestMedia) 
optional
miles
integer 
optional
Odometer reading / reported miles usage for the heavy equipment
msrp
integer 
optional
MSRP for the heavy equipment
price
integer 
optional
Asking price for the heavy equipment
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 heavy equipment
source
string 
optional
Source domain of the listing
stock_no
string 
optional
Stock number of heavy equipment in dealers inventory
vin
string 
optional
VIN for the heavy equipment
num_found
integer 
optional
The number of listings found
range_facets
object 
optional
stats
object 
optional
🔴500Error
Modified at 2023-08-15 07:36:55
Previous
Listing media by id
Next
API for auto-completion of inputs
Built with