The Home Depot Item Number Lookup API
A GET request to our endpoint /api/getter/?platform="homedepot_item_lookup"
will allow you to lookup a product's info on HomeDepot.com in real-time using its item number.
Example
Here's an example showcasing how you can scrape search results from HomeDepot.com for the keyword of your choice. For our example, we have chosen the keyword, "chair". When you search this keyword on HomeDepot you are redirected to the URL https://www.homedepot.com/b/Furniture-Living-Room-Furniture-Chairs/N-5yc1vZc7py
. Our API needs the path starting with /
to bring you the results in JSON.
1 |
|
Query Parameters
As you can see in the example above, our endpoint needs the following query parameters:
Search Query
search
Required
Parameter defines the search query you want to search. You can use anything that a user may use in a regular search while shopping on HomeDepot.com.
page
Optional
Parameter defines the page number for which you want the results. Default value is 1.
Other Required Parameters
platform
Required
Parameter specifies the scraping engine you wish to invoke. In this case, the value should be homedepot_search_path.
api_key
Required
Your account's token—which can be obtained by signing up here.
Note
Be sure to replace select the correct path for the search results page. The path should start with /
and end with the search query. For example, /b/Furniture-Living-Room-Furniture-Chairs/N-5yc1vZc7py
is the path for the search query "chair".
Results
The response will include up to 24 product results for every query. Our scraper grabs the following attributes for every product in Home Depot's search results:
Attributes Returned | Data Type | Information Represented |
---|---|---|
id | string | Retailer ID of product lisitng |
name | string | Name of product lisitng |
model_no | string | Manufacturer's model no. of product lisitng |
brand | string | Product's brand name |
url | string | URL of product listing |
thumbnails | list | List containing URLs of product's thumbnails |
price | string | Price of product |
price_reduced | string | Price of product |
rating | float | Average rating of product |
total_reviews | int | No. of user reviews received by product |
favorite_count | int | No. of times product has been favorited |
Response Example
Here's the response you can expect to receive for the request showcased above:
{
"success": true,
"search": "sofa",
"page": 1,
"total_results": 1996,
"no_of_pages": 84,
"result_count": 26,
"results": [
{
"id": "304602853",
"name": "Harvard 31.5 in. Dark Grey Microfiber 4-Seater Tuxedo Sofa with Round Arms",
"model_no": "CCHRFKS3M26DGRA",
"url": "https://www.homedepot.com/p/Lifestyle-Solutions-Harvard-31-5-in-Dark-Grey-Microfiber-4-Seater-Tuxedo-Sofa-with-Round-Arms-CCHRFKS3M26DGRA/304602853",
"brand": "Lifestyle Solutions",
"thumbnails": [
"https://images.thdstatic.com/productImages/1acdb165-c055-478b-96eb-9e5fbf7e28bc/svn/dark-grey-lifestyle-solutions-sofas-cchrfks3m26dgra-64_1000.jpg"
],
"price": "$342.18",
"price_reduced": null,
"rating": 3.37,
"total_reviews": 426,
"favorite_count": 1920
},
...
{
"id": "320306494",
"name": "Impart 70.5 in. W Square Arm Genuine Leather Modern Straight Sofa in Tan (Seats 2)",
"model_no": "EEI-5553-TAN",
"url": "https://www.homedepot.com/p/MODWAY-Impart-70-5-in-W-Square-Arm-Genuine-Leather-Modern-Straight-Sofa-in-Tan-Seats-2-EEI-5553-TAN/320306494",
"brand": "MODWAY",
"thumbnails": [
"https://images.thdstatic.com/productImages/f0cb4276-60f3-4ce4-bb8a-50983ba15f62/svn/tan-modway-sofas-eei-5553-tan-64_1000.jpg"
],
"price": "$964.96",
"price_reduced": null,
"rating": 0.0,
"total_reviews": 0,
"favorite_count": null
},
{
"id": "320959676",
"name": "Brescia Prov 82 in. Round Arm Linen Mid-Century Rectangle Sofa Set in Laguna Green",
"model_no": "VPR-F6914",
"url": "https://www.homedepot.com/p/Venetian-Worldwide-Brescia-Prov-82-in-Round-Arm-Linen-Mid-Century-Rectangle-Sofa-Set-in-Laguna-Green-VPR-F6914/320959676",
"brand": "Venetian Worldwide",
"thumbnails": [
"https://images.thdstatic.com/productImages/adffc5d1-707f-476d-b179-081bdbb4eb5b/svn/laguna-green-venetian-worldwide-sofas-vpr-f6914-64_1000.jpg"
],
"price": "$1423.99",
"price_reduced": "$886.61",
"rating": 0.0,
"total_reviews": 0,
"favorite_count": null
}
],
"meta_data": {}
}
Request Cost
Each request to this endpoint costs 1 credit per result returned and a minimum of 10 credits per request.
Support
If you want to add a parameter to our response, or have any question or feedback, please write to us at support@unwrangle.com