The Home Depot Search API Filtering

/ Home / The Home Depot Search API / The Home Depot Filtering

API returns filters which can be used to refine a search. Let's start with a search for table and than use filter tokens in the next search below.

Example with q:"table" parameter

Example with q:"table" parameter

JSON Example

{
  "search_metadata": {
    "id": "5e870e1b59603d1198f5c552",
    "status": "Success",
    "json_endpoint": "https://serpapi.com/searches/ef24182ef218e588/5e870e1b59603d1198f5c552.json",
    "created_at": "2020-04-03 10:21:15 UTC",
    "processed_at": "2020-04-03 10:21:15 UTC",
    "home_depot_url": "https://www.homedepot.com/b/N-5yc1v/Ntt-table?",
    "raw_html_file": "https://serpapi.com/searches/ef24182ef218e588/5e870e1b59603d1198f5c552.html",
    "total_time_taken": 6.9
  },
  "search_parameters": {
    "q": "table",
    "device": "desktop"
  },
  "search_information": {
    "results_state": "Results for exact spelling",
    "query_displayed": "table",
    "total_results": 7300
  },
  "filters": {
    ...
    "brand": [
      {
        "name": "StyleWell",
        "value": "n4x"
      },
      {
        "name": "Lifetime",
        "value": "42x"
      },
      {
        "name": "International Concepts",
        "value": "cws"
      },
      {
        "name": "ORE International",
        "value": "9vx"
      },
      ...
    ],
    ...
    "product_depth_in": [
      {
        "name": "Less than 5",
        "value": "2bcudr"
      },
      {
        "name": "10 - 15",
        "value": "2bcudt"
      },
      {
        "name": "15 - 20",
        "value": "2bcudu"
      },
      {
        "name": "20 - 25",
        "value": "2bcudv"
      },
      {
        "name": "25 or Greater",
        "value": "2bcudw"
      },
      {
        "name": "Others",
        "value": "2bcudx"
      }
    ],
    "product_width_in": [
      {
        "name": "15 - 20",
        "value": "2bcue0"
      },
      {
        "name": "Less than 15 in.",
        "value": "1z1bdoe"
      },
      {
        "name": "20 - 25",
        "value": "2bcud1"
      },
      {
        "name": "25 - 30",
        "value": "2bcue1"
      },
      {
        "name": "30 - 35",
        "value": "2bcue2"
      },
      {
        "name": "35 - 40",
        "value": "2bcue3"
      },
      ...
    ],
    ...
  }
}

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.

Example with q:"table" and hd_filter_tokens:"cws,2bcue1"

Example with q:"table" and hd_filter_tokens:"cws,2bcue1"

JSON Example

{
  "search_metadata": {
    "id": "5ea94c1959603da64ce10161",
    "status": "Success",
    "json_endpoint": "https://serpapi.com/searches/37ddec0ec528aab2/5ea94c1959603da64ce10161.json",
    "created_at": "2020-04-29 09:42:49 UTC",
    "processed_at": "2020-04-29 09:42:49 UTC",
    "home_depot_url": "https://www.homedepot.com/b/N-5yc1vZcwsZ2bcue1/Ntt-table?",
    "raw_html_file": "https://serpapi.com/searches/37ddec0ec528aab2/5ea94c1959603da64ce10161.html",
    "total_time_taken": 9.61
  },
  "search_parameters": {
    "q": "table",
    "hd_filter_tokens": "cws,2bcue1",
    "engine": "home_depot"
  },
  "search_information": {
    "results_state": "Results for exact spelling",
    "query_displayed": "table",
    "total_results": 2
  },
  "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"
      },
      {
        "name": "HOMESTYLES",
        "value": "lrl"
      },
      {
        "name": "Baxton Studio",
        "value": "fib"
      },
      {
        "name": "Trademark",
        "value": "96z"
      },
      {
        "name": "Lumisource",
        "value": "6of"
      },
      {
        "name": "Trademark Global",
        "value": "8le"
      },
      {
        "name": "AmeriHome",
        "value": "ae5"
      },
      {
        "name": "Ford",
        "value": "evj"
      },
      {
        "name": "Carnegy Avenue",
        "value": "ocr"
      },
      {
        "name": "EcoDecors",
        "value": "mb2"
      },
      {
        "name": "Mod Made",
        "value": "nxm"
      },
      {
        "name": "Zinus",
        "value": "gde"
      },
      {
        "name": "Benzara",
        "value": "lus"
      },
      {
        "name": "Coastal Vogue",
        "value": "mot"
      },
      {
        "name": "IMAX",
        "value": "9fg"
      }
    ],
    "category": [
      {
        "name": "Living Room Furniture",
        "value": "c7p3"
      },
      {
        "name": "Bedroom Furniture",
        "value": "c7pe"
      }
    ],
    "price": [
      {
        "name": "$100 - $150",
        "value": "12l3"
      },
      {
        "name": "$300 - $400",
        "value": "12l7"
      }
    ],
    "product_width_in": [
      {
        "name": "20 - 25",
        "value": "2bcud1"
      },
      {
        "name": "25 - 30",
        "value": "2bcue1"
      },
      {
        "name": "30 - 35",
        "value": "2bcue2"
      },
      {
        "name": "35 - 40",
        "value": "2bcue3"
      },
      {
        "name": "40 - 45",
        "value": "2bcue4"
      },
      {
        "name": "45 - 50",
        "value": "2bcue5"
      },
      {
        "name": "60 - 65",
        "value": "1z1bdlz"
      }
    ],
    "review_rating": [
      {
        "name": "4 & Up",
        "value": "bwo5o"
      },
      {
        "name": "3 & Up",
        "value": "bwo5n"
      },
      {
        "name": "2 & Up",
        "value": "bwo5m"
      },
      {
        "name": "1 & Up",
        "value": "bwo5l"
      }
    ]
  }
}