Boom and Bucket - Market Report API

Number of APIs: 1

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 or false) 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.
• 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.
• auctionMaxPriceInCents: The maximum reasonable auction comparable value iu 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 of application/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:

1. Variability in Equipment Condition: Valuations are based on standard equipment conditions and may not reflect variations in actual conditions.
2. Data Accuracy: The accuracy of the valuation is dependent on the correctness of the input parameters (make, model, year, and meter reading).
3. Market Fluctuations: Equipment values can fluctuate due to market conditions, which may not be immediately reflected in the estimates.
4. 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.
5. 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.

API Rate Limiting Policy

Our API is designed to provide a consistent and reliable service to all users. To ensure this, we have implemented a rate limiting policy that allows a maximum of 10 requests per second.

Rate Limits

The rate limit for our API is 10 requests per second (RPS). This rate limit applies per API key, not per user or application.

How It Works

Every API request you make subtracts from your remaining request quota. If you exceed the limit of 10 requests per second, you will receive a 429 Too Many Requests HTTP status code.

Response Headers (Coming soon)

Every API response includes three headers to help you understand your current rate limit status:

• X-RateLimit-Limit: The maximum number of requests you can make per second.
• X-RateLimit-Remaining: The number of requests left for the current window.
• X-RateLimit-Reset: The time when the rate limit will reset, in UTC epoch seconds.

Exceeding The Rate Limit

When you exceed the rate limit, the API responds with HTTP status 429 Too Many Requests. You should design your application to handle this possibility and implement a backoff strategy. For example, you could wait until the rate limit resets (as specified in the X-RateLimit-Reset header) before making additional requests.

---

The information provided by this API should be used in conjunction with professional advice and market knowledge to make informed decisions about equipment valuation.

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.

1. GetMarketReport GET https://api.boomandbucket.com/valuationservice/valuation/iron-insight/summarized?make=Caterpillar&model=259D&year=2019&meter=4000&taxonomizedSubCategorySlug=skid-steer-loaders&downloadReport=false