The Home Depot Filtering API
SerpApi's Home Depot Filtering API enables you to refine your search according to product details and provides structured data, eliminating the need for complicated web scraping processes or tools. The filters contain various options depending on the product data, which also appear on the left side of the HTML. These filters can be used to extract data with specific product information such as warranty conditions, durability, certifications, brands, etc., to empower your e-commerce projects with the power of data scraping.
For The Home Depot Canada, the filter parameter is filter, and the filters are divided by a dash (-).
For The Home Depot US, the filter token is hd_filter_tokens, and the filters are separated by a comma (,).
By leveraging SerpApi's Home Depot Filtering API, you can easily obtain targeted and structured product data to enhance your e-commerce projects and strategies.
API Parameters
hd_filter_tokens
Optional
Used to pass filter tokens divided by comma. Filter tokens can be obtained from API response
filter
Optional
Used to pass filter tokens divided by dash (-) in Home Depot Canada. Filter tokens can be obtained from API response
API Examples
Results for: table (the Home Depot US)
{
"filters": {
"brand": [
{
"name": "StyleWell",
"value": "n4x"
},
{
"name": "Lifetime",
"value": "42x"
},
{
"name": "International Concepts",
"value": "cws"
},
...
],
...
"product_depth_in": [
{
"name": "Less than 5",
"value": "2bcudr"
},
{
"name": "10 - 15",
"value": "2bcudt"
},
{
"name": "15 - 20",
"value": "2bcudu"
},
...
],
"product_width_in": [
{
"name": "15 - 20",
"value": "2bcue0"
},
{
"name": "Less than 15 in.",
"value": "1z1bdoe"
},
{
"name": "20 - 25",
"value": "2bcud1"
},
...
],
...
}
}
Example results for q: table and hd_filter_tokens: cws,2bcue1 (the Home Depot US)
Using the filtering tokens from previous we can refine search to brand "International Concepts" cws and product width "25 - 30" 2bcue1. All tokens should be separated by comma in US Searches.
{
"products": [
{
"thumbnail": "https://images.homedepot-static.com/productImages/e696fa53-1f8e-403b-9431-0d9d84d461ec/svn/unfinished-wood-international-concepts-chest-of-drawers-bd-8005-64_400.jpg",
"title": "Brooklyn 5-Drawer Unfinished Wood Chest",
"brand": "International Concepts",
"rating": 3.8,
"reviews": 17,
"price": "$333.81",
"link": "https://www.homedepot.com/p/International-Concepts-Brooklyn-5-Drawer-Unfinished-Wood-Chest-BD-8005/205977944",
"product_id": "205977944",
"serpapi_link": "https://serpapi.com/search.json?engine=home_depot_product&product_id=205977944",
"delivery": "Free delivery"
},
{
"thumbnail": "https://images.homedepot-static.com/productImages/82a71e52-242b-49a5-93d4-ba0816219cce/svn/unfinished-international-concepts-tv-stands-tv-28-64_400.jpg",
"title": "Unfinished Storage Entertainment Center",
"brand": "International Concepts",
"rating": 4.3,
"reviews": 4,
"price": "$113.03",
"link": "https://www.homedepot.com/p/International-Concepts-Unfinished-Storage-Entertainment-Center-TV-28/204735801",
"product_id": "204735801",
"serpapi_link": "https://serpapi.com/search.json?engine=home_depot_product&product_id=204735801",
"delivery": "Free delivery"
}
],
"filters": {
"availability": [
{
"name": "In Stock Only",
"value": "bwo5s"
}
],
"color": [
{
"name": "Multi-Colored",
"value": "1z0u7jh"
}
],
"brand": [
{
"name": "International Concepts",
"value": "cws"
},
{
"name": "Safavieh",
"value": "4kx"
},
{
"name": "Winsome Wood",
"value": "251"
},
...
],
...
}
}
Example results for country: ca, q: Table and filter:26ie-26if(the Home Depot Canada)
Using the filtering tokens from previous we can refine search to "Free Shipping" 26ie, and "Express Delivery" 26if. All tokens should be separated by dashes.
{
...
"products": [
{
"position": 1,
"product_id": "1000119829",
"title": "4 ft. Length Folding Plastic Foldable Table in White with Black Metal Frame",
"thumbnails": [
[
"https://images.homedepot.ca/productimages/p_1000119829.jpg?product-images=s",
"https://images.homedepot.ca/productimages/p_1000119829.jpg?product-images=m",
"https://images.homedepot.ca/productimages/p_1000119829.jpg?product-images=l"
]
],
"link": "https://www.homedepot.ca/product/hdx-4-ft-length-folding-plastic-foldable-table-in-white-with-black-metal-frame/1000119829",
"model_number": "2448B-003",
"brand": "HDX",
"rating": 4.5942,
"reviews": 138,
"price": 59.98,
"currency": "CAD",
"aisle": "LA",
"add_to_cart": true,
"pickup": {
"pick_up_at_store": true
},
"delivery": {
"free": true,
"free_delivery_threshold": false,
"schedule_delivery": true
},
"stock_information": {
"general_stock": 122,
"general_stock_status": "In Stock",
"store_stock": 13,
"store_stock_status": "In Stock"
}
},
{
"position": 2,
"product_id": "1001154278",
"title": "4 Ft. Fold-In-Half One Hand Adjustable Height Table",
"thumbnails": [
[
"https://images.homedepot.ca/productimages/p_1001154278.jpg?product-images=s",
"https://images.homedepot.ca/productimages/p_1001154278.jpg?product-images=m",
"https://images.homedepot.ca/productimages/p_1001154278.jpg?product-images=l"
]
],
"link": "https://www.homedepot.ca/product/lifetime-4-ft-fold-in-half-one-hand-adjustable-height-table/1001154278",
"model_number": "80726",
"brand": "Lifetime",
"rating": 4.637,
"reviews": 4055,
"price": 69.98,
"currency": "CAD",
"aisle": "LA",
"add_to_cart": true,
"pickup": {
"pick_up_at_store": true
},
"delivery": {
"free": true,
"free_delivery_threshold": false,
"schedule_delivery": true
},
"stock_information": {
"general_stock": 216,
"general_stock_status": "In Stock",
"store_stock": 14,
"store_stock_status": "In Stock"
}
},
{
"position": 3,
"product_id": "1000401834",
"title": "6 ft. Length Centre Folding Plastic Foldable Table in White",
"thumbnails": [
[
"https://images.homedepot.ca/productimages/p_1000401834.jpg?product-images=s",
"https://images.homedepot.ca/productimages/p_1000401834.jpg?product-images=m",
"https://images.homedepot.ca/productimages/p_1000401834.jpg?product-images=l"
]
],
"link": "https://www.homedepot.ca/product/hdx-6-ft-length-centre-folding-plastic-foldable-table-in-white/1000401834",
"model_number": "3072F-001",
"brand": "HDX",
"rating": 4.0042,
"reviews": 237,
"price": 89.98,
"currency": "CAD",
"aisle": "LA",
"add_to_cart": true,
"pickup": {
"pick_up_at_store": true
},
"delivery": {
"free": true,
"free_delivery_threshold": false,
"schedule_delivery": true
},
"stock_information": {
"general_stock": 290,
"general_stock_status": "In Stock",
"store_stock": 34,
"store_stock_status": "In Stock"
}
},
...
],
"filters": [
{
"key": "Delivery & Pick-Up",
"code": "deliverySpeed",
"value": [
{
"name": "FREE Ship to Store",
"count": 6019,
"value": "26ig",
"link": "https://www.homedepot.ca"
},
{
"name": "FREE Shipping",
"count": 5398,
"value": "26ie",
"selected": true,
"link": "https://www.homedepot.ca"
},
{
"name": "Express Delivery",
"count": 209,
"value": "26if",
"selected": true,
"link": "https://www.homedepot.ca"
},
...
]
},
...
],
...
}