v1
latestOpenAPI 3.0.02026-07-147195292.0 KBGets active heavy equipment listings for the given search criteria
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 -
- Search heavy equipments around a given geo-point within a given radius
- Search heavy equipments for a specific year / make / model or combination of these
- Search heavy equipments matching multiple year, make, model combinatins in the same search request
- Filter results by most heavy equipment specification attributes
- Filter heavy equipments within a given price / miles range
- Specify a sort order for the results on price / miles / listed date
- Search heavy equipments for a given City / State combination
- Get Facets to build the search drill downs
- Get Market averages for price/miles for your search
Query parameters
The API Authentication Key. Mandatory with all API calls.
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 to filter listings with miles in the given range. Range to be given in the format - min-max e.g. 1000-5000
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 component of location
Longitude component of location
Radius around the search location (Unit - Miles)
To search a substring across entire document
To filter listing on their year
To filter listings on their make
To filter listings on their model
To filter listing on their trim
To filter listing on their VIN
To filter listing on their condition. Either used or new
To filter listing on their stock number on lot
To filter listing on their source
Filter listings on dealer_name
Dealer id to filter the listings.
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 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
To filter listing on their engine
To filter listing on their fuel type
To filter listing on their transmission
To filter listing on their drivetrain
To filter listing on their body type
To filter heavy equipments on their category
To filter heavy equipments on their sub-category
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
To filter listing on State in which they are listed
To filter listing on City in which they are listed
To filter listing on ZIP around which they are listed
To filter listing on msa code in which they are listed
Sort by field. Default sort field is distance from the given point
Sort order - asc or desc. Default sort order is asc
Number of results to return. Default is 10. Max is 50
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
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.
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.
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
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 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 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 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 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
Response
List of all heavy equipment listings matching the search & filter criteria