Home Depot Product Data API
A GET request to our /api/getter/?platform="homedepot_detail" endpoint allows you to scrape product data for any product listing URL on HomeDepot.com in real-time.
Example
Here's an example showcasing how you can scrape product data for any product on HomeDepot.com using its URL. For this example, we use the URL of this product.
1 | |
Query Parameters
As you can see in the example above, our endpoint needs the following query parameters:
Product URL
url
Required
Product listing's URL on HomeDepot.com. Remove unnecessary query parameters and encode the URL.
item_id
Optional
Item ID can be used in place of the url parameter. It can be found in the trailing end of the product listing's URL.
store_no
Optional
HomeDepot store number. You can find a list of all store numbers here.
zipcode
Optional
Corresponding zipcode of the store. This parameter is required for fetching details local to a store_no. The zipcode can also be found in the same file linked above.
Other Required Parameters
platform
Required
Specifies the scraping engine you wish to invoke. In this case, the value should be homedepot_detail.
api_key
Required
Your account's token—which can be obtained by signing up here.
Note
The value of the query parameter url must be URL or percent encoded. If you're using Python, this can be done with the function urlencode.
Results
The response will include the following attirbutes for the product:
| Attributes Returned | Data Type | Information Represented |
|---|---|---|
| name | string | Name of product listing |
| brand | string | Product's brand name |
| images | list | List containing URLs of the product images |
| description | string | Description of product listing |
| price | float | Price of product |
| price_reduced | float/null | Discounted price of product, if any |
| currency | string | Currency of the price |
| currency_symbol | string | Symbol of the currency |
| rating | float | Average rating of product |
| total_reviews | int | No. of reviews received |
| categories | list | List of categories the product belongs to |
| specifications | list | Product's specifications |
| highlights | list | Product highlights |
| features | list | Product's features |
| dimensions | null | Product's dimensions |
| brand_link | string | Brand's URL on HomeDepot.com |
| model_no | string | Manufacturer's model no. of product listing |
| upc | string | Manufacturer's universal product code |
| retail_id | string | Retailer's ID of the product |
| sku_id | string | Home Depot's SKU ID of product listing |
| in_stock | bool | Whether product is in stock or not |
| store_no | string | Store number where the product is available |
| store_name | string | Name of the store where the product is available |
| store_phone | null | Phone number of the store |
| inventory_quantity | int | Quantity of the product in stock |
| delivery_charge | null | Delivery charge for the product |
| delivery_date_range | object | Delivery date range for the product |
Response Example
Here's the response you can expect to receive for the request showcased above:
{
"success": true,
"item_id": "306248639",
"store_no": "2414",
"zipcode": "04401",
"result_count": 1,
"detail": {
"name": "10.5 ft. Fabric Cotton Double Brazilian Hammock with Stand Combo in Beach Oasis",
"brand": "Sunnydaze",
"images": [
"https://images.thdstatic.com/productImages/a51bb0e0-9ce1-42e0-add2-09d834b220e9/svn/sunnydaze-fabric-hammocks-db-combo-oasis-64_1000.jpg",
"https://images.thdstatic.com/productImages/7375a8af-f8ee-48a2-b2e7-96c8366e9cd2/svn/sunnydaze-fabric-hammocks-db-combo-oasis-66_1000.jpg",
"https://images.thdstatic.com/productImages/21302bd7-a23d-4ac6-8025-34262a4642ef/svn/sunnydaze-fabric-hammocks-db-combo-oasis-c3_1000.jpg",
"https://images.thdstatic.com/productImages/3dc34e70-68d2-4db3-825e-515b7f080416/svn/sunnydaze-fabric-hammocks-db-combo-oasis-4f_1000.jpg",
"https://images.thdstatic.com/productImages/6dda3c1b-5e0d-4f73-bf78-30f21b16432b/svn/sunnydaze-fabric-hammocks-db-combo-oasis-1f_1000.jpg",
"https://images.thdstatic.com/productImages/69eae421-2ee4-4922-8d73-f0c650185526/svn/sunnydaze-fabric-hammocks-db-combo-oasis-44_1000.jpg",
"https://images.thdstatic.com/productImages/1c788eee-5cae-4967-be5f-bbcd5545a04d/svn/sunnydaze-fabric-hammocks-db-combo-oasis-fa_1000.jpg",
"https://images.thdstatic.com/productImages/dd42a8dd-5eaa-4526-9112-4a64e3f476c5/svn/sunnydaze-fabric-hammocks-db-combo-oasis-76_1000.jpg",
"https://images.thdstatic.com/productImages/e4133c2e-73b4-4f33-9ac7-f0ff17480efb/svn/sunnydaze-fabric-hammocks-db-combo-oasis-31_1000.jpg"
],
"description": "Complete hammock set includes tight woven fabric (cotton) Brazilian hammock with carrying case and stand. No trees needed! Enjoy this hammock with a weight limit of 400 lbs. The perfect hammock and space saving stand combo for the patio, backyard or even at the lake.",
"price": 81.78,
"price_reduced": null,
"currency": "USD",
"currency_symbol": "$",
"rating": 4.6596,
"total_reviews": 47,
"categories": [
{
"name": "Outdoors",
"url": "https://www.homedepot.com/b/Outdoors/N-5yc1vZbx82"
},
{
"name": "Patio Furniture",
"url": "https://www.homedepot.com/b/Outdoors-Patio-Furniture/N-5yc1vZbx4o"
},
{
"name": "Hammocks",
"url": "https://www.homedepot.com/b/Outdoors-Patio-Furniture-Hammocks/N-5yc1vZbxa7"
},
{
"name": "Fabric Hammocks",
"url": "https://www.homedepot.com/b/Outdoors-Patio-Furniture-Hammocks-Fabric-Hammocks/N-5yc1vZcfih"
}
],
"specifications": [
{
"name": "Assembly Required",
"value": "Yes"
},
{
"name": "Capacity (number of people accommodated)",
"value": "2"
},
{
"name": "Color",
"value": "Beach Oasis"
},
{
"name": "Color Family",
"value": "Assorted Colors"
},
{
"name": "Hammock Fabric Material",
"value": "Cotton"
},
{
"name": "Hammock Type",
"value": "Hammock Bed"
},
{
"name": "Included",
"value": "Hanging Hardware Included,With Stand"
},
{
"name": "Patio Furniture Features",
"value": "No Additional Features"
},
{
"name": "Returnable",
"value": "90-Day"
},
{
"name": "Stand Material",
"value": "Stainless Steel"
},
{
"name": "Stand type",
"value": "Tri-beam"
},
{
"name": "Stand weight (lb.)",
"value": "30"
},
{
"name": "Style",
"value": "Classic,Southwestern"
},
{
"name": "Surface type",
"value": "Fabric"
},
{
"name": "Weight Capacity (lb.)",
"value": "400 lb"
},
{
"name": "Manufacturer Warranty",
"value": "1 Year Manufacturer's Warranty"
},
{
"name": "Assembled Depth (in.)",
"value": "108 in"
},
{
"name": "Assembled Height (in.)",
"value": "42 in"
},
{
"name": "Assembled Width (in.)",
"value": "40 in"
},
{
"name": "Hammock length (in.)",
"value": "125"
},
{
"name": "Stand width (in.)",
"value": "40"
}
],
"highlights": [
"2-person Brazilian hammock comes with a stand for easy relaxation",
"Hammock is made from a soft, durable cotton for extra comfort",
"Set the hammock on the patio, deck, or backyard to enjoy outdoors"
],
"features": [
"Cotton",
"Stainless Steel",
"With Stand",
"Tri-beam",
"Hanging Hardware Included"
],
"dimensions": null,
"brand_link": "https://www.homedepot.com/b/Outdoors-Patio-Furniture-Hammocks-Fabric-Hammocks/Sunnydaze/N-5yc1vZcfihZzi7",
"model_no": "DB Combo-Oasis",
"upc": "819804014805",
"retail_id": "1003421217",
"sku_id": "306248639",
"in_stock": true,
"store_no": "2414",
"store_name": "Bangor",
"store_phone": null,
"inventory_quantity": 54,
"delivery_charge": null,
"delivery_date_range": {
"start": "2024-08-22",
"end": "2024-08-23"
}
},
"remaining_credits": 593630
}
Request Cost
1 credit 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