{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"27a479ed-1a7f-49be-ae77-21c82f6b2b93","name":"Boom and Bucket - Market Report API","description":"# Description\n\nThis 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.\n\n## Request Parameters\n\nThe endpoint accepts the following parameters in the query string:\n\n- `make`: The manufacturer of the equipment.\n- `model`: The specific model of the equipment.\n- `year`: The year of manufacture of the equipment.\n- `meter`: The meter reading (in hours or miles) indicating usage of the equipment.\n- `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.\n- `downloadReport`: A boolean parameter (`true` or `false`) indicating whether to download a detailed Excel report instead of a JSON version of the valuation summary.\n    \n\n## Response Object\n\nThe API returns a JSON object containing valuation details with the following fields:\n\n- `retailConfidenceIntervalHighPriceInCents`: The upper limit of the retail price estimate in cents.\n- `retailConfidenceIntervalLowPriceInCents`: The lower limit of the retail price estimate in cents.\n- `auctionConfidenceIntervalHighPriceInCents`: The upper limit of the auction price estimate in cents.\n- `auctionConfidenceIntervalLowPriceInCents`: The lower limit of the auction price estimate in cents.\n- `retailConfidencePercentage`: The confidence level of the retail price estimate expressed as a percentage.\n- `retailConfidenceScore`: The confidence level of the retail estimate, expressed in text.\n- `auctionConfidencePercentage`: The confidence level of the auction price estimate expressed as a percentage.\n- `auctionConfidenceScore`: The confidence level of the retail estimate, expressed in text.\n- `retailComparableCount`: The number of comparable equipment pieces used to determine the retail valuation.\n- `retailMinPriceInCents`: The minimum reasonable retail comparable value in cents.\n- `retailMaxPriceInCents`: The maximum reasonable retail comparable value in cents.\n- `auctionMinPriceInCents`: The minimum reasonable auction comparable value in cents.\n- `auctionMaxPriceInCents`: The maximum reasonable auction comparable value iu cents.\n    \n\n## Response Headers\n\nWhen the `downloadReport` request parameter is set to `true`, the response will contain the generated report file with the following headers:\n\n- `Content-Type`: with a value of `application/octet-stream`\n- `Content-Disposition`: with a value of the file name\n    \n\n# Disclaimer for Estimations\n\nWhile this API aims to provide accurate and up-to-date valuation insights, the following factors should be considered:\n\n1. **Variability in Equipment Condition**: Valuations are based on standard equipment conditions and may not reflect variations in actual conditions.\n2. **Data Accuracy**: The accuracy of the valuation is dependent on the correctness of the input parameters (make, model, year, and meter reading).\n3. **Market Fluctuations**: Equipment values can fluctuate due to market conditions, which may not be immediately reflected in the estimates.\n4. **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.\n5. **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.\n    \n\n# API Rate Limiting Policy\n\nOur 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.\n\n## Rate Limits\n\nThe rate limit for our API is 10 requests per second (RPS). This rate limit applies per API key, not per user or application.\n\n## How It Works\n\nEvery 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.\n\n## Response Headers (Coming soon)\n\nEvery API response includes three headers to help you understand your current rate limit status:\n\n- `X-RateLimit-Limit`: The maximum number of requests you can make per second.\n- `X-RateLimit-Remaining`: The number of requests left for the current window.\n- `X-RateLimit-Reset`: The time when the rate limit will reset, in UTC epoch seconds.\n    \n\n## Exceeding The Rate Limit\n\nWhen 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.\n\n---\n\nThe information provided by this API should be used in conjunction with professional advice and market knowledge to make informed decisions about equipment valuation.\n\n## Precision Search (optional)\n\nThe 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.\n\nWe have an optional `taxonomizedSubCategorySlug` parameter which will ensure that the fuzzy match will only match exclusively to that subcategory.\n\n| taxonomizedSubCategorySlug |\n| --- |\n| \"mini-excavators\" |\n| \"excavators\" |\n| \"long-reach-excavators\" |\n| \"wheel-excavators\" |\n| \"specialty-excavators\" |\n| \"dozers\" |\n| \"wheel-dozers\" |\n| \"wheel-loaders\" |\n| \"track-loaders\" |\n| \"backhoe-loaders\" |\n| \"skip-loaders\" |\n| \"skid-steer-loaders\" |\n| \"compact-track-loaders\" |\n| \"motor-graders\" |\n| \"road-reclaimers\" |\n| \"track-cold-planers\" |\n| \"wheel-cold-planers\" |\n| \"track-asphalt-pavers\" |\n| \"wheel-asphalt-pavers\" |\n| \"screeds\" |\n| \"motor-scrapers\" |\n| \"pull-scrapers\" |\n| \"single-drum-vibratory-rollers\" |\n| \"double-drum-vibratory-rollers\" |\n| \"smooth-rollers\" |\n| \"pneumatic-tire-rollers\" |\n| \"sheepsfoot-rollers\" |\n| \"self-propelled-roller\" |\n| \"telehandlers\" |\n| \"forklifts\" |\n| \"aerial-work-platforms\" |\n| \"boom-lifts\" |\n| \"scissor-lifts\" |\n| \"vertical-mast-lifts\" |\n| \"pipelayers\" |\n| \"trenchers\" |\n| \"foundation--piling-drills\" |\n| \"directional-drills\" |\n| \"blasthole-drills\" |\n| \"articulated-trucks\" |\n| \"rigid-haul-trucks\" |\n| \"hydraulic-shovels\" |\n| \"power-shovels\" |\n| \"draglines\" |\n| \"generators\" |\n| \"mounted-boom-truck-cranes\" |\n| \"mounted-knuckle-boom-cranes\" |\n| \"fuel-trucks\" |\n| \"water-trucks\" |\n| \"vacuum-trucks\" |\n| \"service-trucks\" |\n| \"single-axle-dump-trucks\" |\n| \"multi-axle-dump-trucks\" |\n| \"flatbed-dump-trucks\" |\n| \"flatbed-trucks\" |\n| \"stake-trucks\" |\n| \"dry-van-trucks\" |\n| \"moving-van-trucks\" |\n| \"reefer-trucks\" |\n| \"mixer-trucks\" |\n| \"conventional-day-cab-trucks\" |\n| \"conventional-trucks-with-sleeper\" |\n| \"cabover-trucks-with-sleeper\" |\n| \"chipper-trucks\" |\n| \"curtain-side-trucks\" |\n| \"digger-derrick-trucks\" |\n| \"grapple-trucks\" |\n| \"hooklift-trucks\" |\n| \"logging-trucks\" |\n| \"winch-trucks\" |\n| \"yard-spotter-trucks\" |\n| \"concrete-pump-trucks\" |\n| \"expeditor-trucks\" |\n| \"grain-trucks\" |\n| \"plow-trucks\" |\n| \"sweeper-trucks\" |\n| \"dry-cargo-trucks\" |\n| \"moving-trucks\" |\n| \"reefer-trucks\" |\n| \"pickup-trucks\" |\n| \"cargo-vans\" |\n| \"service-utility-vans\" |\n| \"reefer-vans\" |\n| \"double-drop-trailers\" |\n| \"drop-deck-trailers\" |\n| \"drop-frame-van-trailers\" |\n| \"dry-van-trailers\" |\n| \"dump-trailers\" |\n| \"flatbed-trailers\" |\n| \"grain-trailers\" |\n| \"log-trailers\" |\n| \"lowboy-trailers\" |\n| \"oilfied-trailers\" |\n| \"reefer-trailers\" |\n| \"roll-off-trailers\" |\n| \"crude-oil-trailers\" |\n| \"fuel-tank-trailers\" |\n| \"vacuum-tank-trailers\" |\n| \"water-tank-trailers\" |\n| \"utility-trailers\" |\n| \"light-towers\" |\n| \"bucket-trucks\" |\n| \"all-terrain-cranes\" |\n| \"carry-deck-cranes\" |\n| \"crawler-cranes\" |\n| \"overhead-cranes\" |\n| \"rough-terrain-cranes\" |\n| \"tower-cranes\" |\n| \"telescopic-cranes\" |","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":true,"owner":"19052377","team":2972059,"collectionId":"27a479ed-1a7f-49be-ae77-21c82f6b2b93","publishedId":"2s9Yyy9K1p","public":true,"publicUrl":"https://marketreportapi.boomandbucket.com","privateUrl":"https://go.postman.co/documentation/19052377-27a479ed-1a7f-49be-ae77-21c82f6b2b93","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"438EFF"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":""},{"name":"title","value":"Market Report API"}],"appearance":{"default":"light","themes":[{"name":"dark","logo":null,"colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"438EFF"}},{"name":"light","logo":null,"colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"438EFF"}}]}},"version":"8.10.1","publishDate":"2024-02-07T19:20:21.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"Market Report API","description":""},"logos":{"logoLight":null,"logoDark":null}},"statusCode":200},"environments":[],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/12abf3e4837c46b0817ef9605c7ca76dd214f37688660c770cb4820687068f58","favicon":"https://boomandbucket.com/favicon.ico"},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"}],"canonicalUrl":"https://marketreportapi.boomandbucket.com/view/metadata/2s9Yyy9K1p"}