Get Market Report
Description
This API endpoint retrieves summarized valuation insights for heavy equipment based on specific criteria including make, model, year, meter reading, and an option to download a detailed report. It is particularly useful for quickly accessing a summarized view of both retail and auction value estimates for a given piece of equipment.
Request Parameters
The endpoint accepts the following parameters in the query string:
make
: The manufacturer of the equipment.model
: The specific model of the equipment.year
: The year of manufacture of the equipment.meter
: The meter reading (in hours or miles) indicating usage of the equipment.taxonomizedSubCategorySlug
(optional): provide one of the subcategories that match for this equipment, this enables precision search to match exactly, this is particularly helpful for on-highway equipment.downloadReport
: A boolean parameter (true
orfalse
) indicating whether to download a detailed Excel report instead of a JSON version of the valuation summary.
Response Object
The API returns a JSON object containing valuation details with the following fields:
retailConfidenceIntervalHighPriceInCents
: The upper limit of the retail price estimate in cents.retailConfidenceIntervalLowPriceInCents
: The lower limit of the retail price estimate in cents.auctionConfidenceIntervalHighPriceInCents
: The upper limit of the auction price estimate in cents.auctionConfidenceIntervalLowPriceInCents
: The lower limit of the auction price estimate in cents.retailConfidencePercentage
: The confidence level of the retail price estimate expressed as a percentage.retailConfidenceScore
: The confidence level of the retail estimate, expressed in text.auctionConfidencePercentage
: The confidence level of the auction price estimate expressed as a percentage.auctionConfidenceScore
: The confidence level of the retail estimate, expressed in text.retailComparableCount
: The number of comparable equipment pieces used to determine the retail valuation.auctionComparableCount
: The number of comparable equipment pieces used to determine the auction valuation.retailMinPriceInCents
: The minimum reasonable retail comparable value in cents.retailMaxPriceInCents
: The maximum reasonable retail comparable value in cents.auctionMinPriceInCents
: The minimum reasonable auction comparable value in cents.
Response Headers
When the downloadReport
request parameter is set to true
, the response will contain the generated report file with the following headers:
Content-Type
: with a value ofapplication/octet-stream
Content-Disposition
: with a value of the file name
Disclaimer for Estimations
While this API aims to provide accurate and up-to-date valuation insights, the following factors should be considered:
- Variability in Equipment Condition: Valuations are based on standard equipment conditions and may not reflect variations in actual conditions.
- Data Accuracy: The accuracy of the valuation is dependent on the correctness of the input parameters (make, model, year, and meter reading).
- Market Fluctuations: Equipment values can fluctuate due to market conditions, which may not be immediately reflected in the estimates.
- Comparative Data Limitations: The number of comparable equipment pieces affects the confidence level of the valuation. Limited data points can impact the accuracy of the estimate.
- Use for Guidance: These valuations should be used as a guide and not as the sole basis for investment or transaction decisions. For a more detailed and personalized valuation, consulting with a Boom and Bucket fleet advisor is recommended.
Precision Search (optional)
The default valuation endpoints are very good at matching equipment, and if it can not find exact matches it uses a fuzzy search to find like makes and models to generate the market report.
We have an optional taxonomizedSubCategorySlug
parameter which will ensure that the fuzzy match will only match exclusively to that subcategory.
taxonomizedSubCategorySlug |
---|
mini-excavators |
excavators |
long-reach-excavators |
wheel-excavators |
specialty-excavators |
dozers |
wheel-dozers |
wheel-loaders |
track-loaders |
backhoe-loaders |
skip-loaders |
skid-steer-loaders |
compact-track-loaders |
motor-graders |
road-reclaimers |
track-cold-planers |
wheel-cold-planers |
track-asphalt-pavers |
wheel-asphalt-pavers |
screeds |
motor-scrapers |
pull-scrapers |
single-drum-vibratory-rollers |
double-drum-vibratory-rollers |
smooth-rollers |
pneumatic-tire-rollers |
sheepsfoot-rollers |
self-propelled-roller |
telehandlers |
forklifts |
aerial-work-platforms |
boom-lifts |
scissor-lifts |
vertical-mast-lifts |
pipelayers |
trenchers |
foundation--piling-drills |
directional-drills |
blasthole-drills |
articulated-trucks |
rigid-haul-trucks |
hydraulic-shovels |
power-shovels |
draglines |
generators |
mounted-boom-truck-cranes |
mounted-knuckle-boom-cranes |
fuel-trucks |
water-trucks |
vacuum-trucks |
service-trucks |
single-axle-dump-trucks |
multi-axle-dump-trucks |
flatbed-dump-trucks |
flatbed-trucks |
stake-trucks |
dry-van-trucks |
moving-van-trucks |
reefer-trucks |
mixer-trucks |
conventional-day-cab-trucks |
conventional-trucks-with-sleeper |
cabover-trucks-with-sleeper |
chipper-trucks |
curtain-side-trucks |
digger-derrick-trucks |
grapple-trucks |
hooklift-trucks |
logging-trucks |
winch-trucks |
yard-spotter-trucks |
concrete-pump-trucks |
expeditor-trucks |
grain-trucks |
plow-trucks |
sweeper-trucks |
dry-cargo-trucks |
moving-trucks |
reefer-trucks |
pickup-trucks |
cargo-vans |
service-utility-vans |
reefer-vans |
double-drop-trailers |
drop-deck-trailers |
drop-frame-van-trailers |
dry-van-trailers |
dump-trailers |
flatbed-trailers |
grain-trailers |
log-trailers |
lowboy-trailers |
oilfied-trailers |
reefer-trailers |
roll-off-trailers |
crude-oil-trailers |
fuel-tank-trailers |
vacuum-tank-trailers |
water-tank-trailers |
utility-trailers |
light-towers |
bucket-trucks |
all-terrain-cranes |
carry-deck-cranes |
crawler-cranes |
overhead-cranes |
rough-terrain-cranes |
tower-cranes |
telescopic-cranes |
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
make | string | The make or manufacturer of the equipment. | |
model | string | The model of the equipment, ensure that special characters that are not URL friendly are encoded correctly. | |
year | number | The year the equipment was manufactured. | |
meter | number | The hours or miles the equipment has on its primary meter, some equipment may have several meters, use the primary meter for that model. | |
taxonomizedSubCategorySlug | string | If provided, this will enable precision search to refine the comparables to determine the estimation. | |
downloadReport | boolean | If true, will download a Excel file with the comparables and detailed analytics. If false, will return a summary of the estimation. |
RESPONSES
status: OK
{"retailConfidenceIntervalHighPriceInCents":10775700,"retailConfidenceIntervalLowPriceInCents":9270900,"auctionConfidenceIntervalHighPriceInCents":7196900,"auctionConfidenceIntervalLowPriceInCents":5034400,"retailConfidencePercentage":15.05552776388194,"auctionConfidencePercentage":35.92610436429485,"retailComparableCount":87,"auctionComparableCount":26,"retailConfidenceScore":"Medium","auctionConfidenceScore":"Low"}