Logo SearchApi

Home Depot Search API Documentation

GET   /api/v1/search?engine=home_depot_search
OpenAPI Initiative Download OpenAPI Spec

The Home Depot Search API returns the products Home Depot shows for a keyword or a category. Each result includes the product ID, title, brand, model number, price, rating, images and fulfillment. The response also includes the filters, categories, related searches and pages of the results. Use it to track prices, assortment and availability at Home Depot.

API Parameters

Search Query

  • Name
    q
    Required
    Optional
    Description

    The parameter specifies your search query. It accepts any term or phrase you'd typically input in a Home Depot search, up to 150 characters. Either q or category_id is required. Home Depot refuses keywords with some accented letters, such as á, ä, å, ø or ü.

  • Name
    category_id
    Required
    Optional
    Description

    This parameter restricts the search to a Home Depot category. Use it alone to browse the category, or with q to search inside it. Category IDs are returned in categories, in search_information.category_id and in the Category options of filters. You can also find one at the end of a category page URL.

    Example: https://www.homedepot.com/b/Lighting-Light-Bulbs-LED-Light-Bulbs/N-5yc1vZbm79 where 5yc1vZbm79 is the category ID.

Filters

  • Name
    filters
    Required
    Optional
    Description

    This parameter narrows the results with the filter_value tokens returned in the filters section, such as a brand, a price bucket, a rating or same-day pickup. Separate several tokens with a comma, for example zv,qy9. Two values of one filter, such as two brands, return products that match either.

  • Name
    sort_by
    Required
    Optional
    Description

    Parameter allows sorting search results by different criteria. Below is the list of available sorting options:

    • best_match - sort order based on relevance. Default with q
    • best_selling Default with category_id
    • most_popular
    • customer_rating
    • price_low_to_high
    • price_high_to_low
    • new_arrivals

  • Name
    price_min
    Required
    Optional
    Description

    This parameter controls the minimum price of the products returned, in US dollars. For instance - 10 value would return products with a minimum price of $10. Home Depot filters prices in whole dollars, so 19.99 is applied as 19.

  • Name
    price_max
    Required
    Optional
    Description

    This parameter controls the maximum price of the products returned, in US dollars. For instance - 50 value would return products with a maximum price of $50. Home Depot filters prices in whole dollars, so 49.50 is applied as 50.

  • Name
    store_id
    Required
    Optional
    Description

    This parameter pins the results to a specific Home Depot store by its store number, a number of 3 or 4 digits such as 121. The pickup store and its stock in each result come from this store. Without it, results have no pickup details. A store ID that Home Depot does not have returns an error in place of the results.

  • Name
    postal_code
    Required
    Optional
    Description

    This parameter specifies the 5-digit US ZIP code used for delivery options, such as 30339.

Pagination

  • Name
    page
    Required
    Optional
    Description

    The parameter determines the results page number. It defaults to 1. Each page holds 24 products, plus sponsored products on some pages, and Home Depot serves up to page 31. total_results is Home Depot's estimate, so a later page can come back with no products.

Engine

  • Name
    engine
    Required
    Required
    Description

    Parameter defines an engine that will be used to retrieve real-time data. It must be set to home_depot_search.

API key

  • Name
    api_key
    Required
    Required
    Description

    The api_key authenticates your requests. Use it as a query parameter (https://www.searchapi.io/api/v1/search?api_key=YOUR_API_KEY) or in the Authorization header (Bearer YOUR_API_KEY).

Zero Data Retention

  • Name
    zero_retention
    Enterprise Only
    Enterprise Only
    Required
    Optional
    Description

    Set this parameter to true to disable all logging and persistent storage. No request parameters, HTML, or JSON responses are stored or logged. Suitable for high-compliance use cases. Debugging and support may be limited while enabled.

API Examples

Full Response

Full Response
GET
https://www.searchapi.io/api/v1/search?engine=home_depot_search&q=paint+roller
Request
import requests

url = "https://www.searchapi.io/api/v1/search"
params = {
  "engine": "home_depot_search",
  "q": "paint roller"
}

response = requests.get(url, params=params)
print(response.text)
Response
{
  "search_metadata": {
    "id": "search_rWMBG04LgyPXTLvpb6NQzqD7",
    "status": "Success",
    "created_at": "2026-11-11T10:30:01Z",
    "request_time_taken": 2.52,
    "parsing_time_taken": 0.03,
    "total_time_taken": 2.56,
    "request_url": "https://www.homedepot.com/s/paint%20roller",
    "html_url": "https://www.searchapi.io/api/v1/searches/search_rWMBG04LgyPXTLvpb6NQzqD7.html",
    "json_url": "https://www.searchapi.io/api/v1/searches/search_rWMBG04LgyPXTLvpb6NQzqD7"
  },
  "search_parameters": {
    "engine": "home_depot_search",
    "q": "paint roller"
  },
  "search_information": {
    "total_results": 4029,
    "query_displayed": "paint roller"
  },
  "organic_results": [
    {
      "position": 1,
      "product_id": "100090787",
      "parent_product_id": "342630924",
      "title": "Better 9 in. x 3/8 in. High-Density Yellow Knit Paint Roller Cover (3-Pack)",
      "link": "https://www.homedepot.com/p/Better-9-in-x-3-8-in-High-Density-Yellow-Knit-Paint-Roller-Cover-3-Pack-RS-1433/100090787",
      "model_number": "RS 1433",
      "sku": "806179",
      "rating": 4.4738,
      "reviews": 4386,
      "price": "$9.98",
      "extracted_price": 9.98,
      "unit_of_measure": "each",
      "badges": [
        "Top Rated"
      ],
      "thumbnail": "https://images.thdstatic.com/productImages/8f2a3f94-96dc-4487-b95f-c33bb6b08fff/svn/paint-roller-covers-rs-1433-64_1000.jpg",
      "images": [
        {
          "link": "https://images.thdstatic.com/productImages/8f2a3f94-96dc-4487-b95f-c33bb6b08fff/svn/paint-roller-covers-rs-1433-64_1000.jpg"
        },
        ...
      ],
      "fulfillment": {
        "delivery": {
          "start_date": "2026-11-11",
          "end_date": "2026-11-11",
          "price": 0.0,
          "is_free_shipping": true,
          "stock": 311
        }
      },
      "return_policy": "90-Day"
    },
    ...
  ],
  "filters": [
    {
      "type": "Bundle/Single",
      "options": [
        {
          "text": "Single Product",
          "items": 5546,
          "filter_value": "bwo65",
          "link": "https://www.homedepot.com/b/Paint-Paint-Supplies/Single-Product/N-5yc1vZci1wZbwo65/Ntk-elasticplus/Ntt-paint%2Broller?NCNI-5"
        },
        ...
      ]
    },
    ...
  ],
  "categories": [
    {
      "title": "Paint",
      "category_id": "5yc1vZar2d",
      "link": "https://www.homedepot.com/b/Paint/N-5yc1vZar2d/Ntk-elasticplus/Ntt-paint%2Broller?NCNI-5"
    },
    ...
  ],
  "related_searches": [
    {
      "query": "paint brush",
      "link": "https://www.homedepot.com/s/paint%20brush"
    },
    ...
  ],
  "pagination": {
    "current": 1,
    "next": "https://www.homedepot.com/s/paint%20roller?Nao=24",
    "other_pages": {
      "2": "https://www.homedepot.com/s/paint%20roller?Nao=24",
      "3": "https://www.homedepot.com/s/paint%20roller?Nao=48",
      "4": "https://www.homedepot.com/s/paint%20roller?Nao=72"
    }
  }
}
Some keywords open a category

Home Depot shows a category page for some keywords, such as garden hose. The response then lists the products of that category, and search_information.category_id holds its ID.

Pickup needs a store

Without store_id, results have no pickup details. Set store_id to get the pickup store and its stock for each product.

Category at a Store

GET
https://www.searchapi.io/api/v1/search?category_id=5yc1vZbm79&engine=home_depot_search&store_id=121
Request
import requests

url = "https://www.searchapi.io/api/v1/search"
params = {
  "engine": "home_depot_search",
  "category_id": "5yc1vZbm79",
  "store_id": "121"
}

response = requests.get(url, params=params)
print(response.text)
Response
{
  "search_metadata": {
    "id": "search_J2OR1XvYom9LFYKoGra4w0Nn",
    "status": "Success",
    "created_at": "2026-11-11T10:30:04Z",
    "request_time_taken": 3.56,
    "parsing_time_taken": 0.01,
    "total_time_taken": 3.57,
    "request_url": "https://www.homedepot.com/b/N-5yc1vZbm79",
    "html_url": "https://www.searchapi.io/api/v1/searches/search_J2OR1XvYom9LFYKoGra4w0Nn.html",
    "json_url": "https://www.searchapi.io/api/v1/searches/search_J2OR1XvYom9LFYKoGra4w0Nn"
  },
  "search_parameters": {
    "engine": "home_depot_search",
    "category_id": "5yc1vZbm79",
    "store_id": "121"
  },
  "search_information": {
    "total_results": 3925,
    "store_id": "121",
    "store_name": "Cumberland"
  },
  "organic_results": [
    {
      "position": 1,
      "product_id": "332492272",
      "parent_product_id": "341764735",
      "title": "Universal Select 65/75/90-Watt Equivalent BR30 Dimmable LED Flood Light Bulb with Selectable Color Temperature (6-Pack)",
      "link": "https://www.homedepot.com/p/EcoSmart-Universal-Select-65-75-90-Watt-Equivalent-BR30-Dimmable-LED-Flood-Light-Bulb-with-Selectable-Color-Temperature-6-Pack-14BR303WS6CCT01/332492272",
      "brand": "EcoSmart",
      "model_number": "14BR303WS6CCT01",
      "sku": "1012776663",
      "rating": 4.5761,
      "reviews": 1203,
      "price": "$22.98",
      "extracted_price": 22.98,
      "unit_of_measure": "each",
      "badges": [
        "Best Seller",
        ...
      ],
      "thumbnail": "https://images.thdstatic.com/productImages/19defd21-4caa-4b9f-9504-77b6d951e02c/svn/ecosmart-flood-and-spot-light-bulbs-14br303ws6cct01-64_1000.jpg",
      "images": [
        {
          "link": "https://images.thdstatic.com/productImages/19defd21-4caa-4b9f-9504-77b6d951e02c/svn/ecosmart-flood-and-spot-light-bulbs-14br303ws6cct01-64_1000.jpg"
        },
        ...
      ],
      "fulfillment": {
        "pickup": {
          "store_id": "121",
          "store_name": "Cumberland",
          "stock": 182
        },
        "delivery": {
          "start_date": "2026-11-11",
          "end_date": "2026-11-11",
          "price": 0.0,
          "is_free_shipping": true,
          "stock": 1895
        },
        "express_delivery": {
          "store_id": "121",
          "start_date": "2026-11-11",
          "end_date": "2026-11-11",
          "price": 2.99
        }
      },
      "return_policy": "90-Day"
    },
    ...
  ],
  "filters": [
    {
      "type": "Get It Fast",
      "options": [
        {
          "text": "Pick Up Today",
          "items": 477,
          "filter_value": "1z175a5",
          "link": "https://www.homedepot.com/b/Lighting-Light-Bulbs-LED-Light-Bulbs/Pick-Up-Today/N-5yc1vZbm79Z1z175a5"
        },
        ...
      ]
    },
    ...
  ],
  "categories": [
    {
      "title": "Lighting",
      "category_id": "5yc1vZbvn5",
      "link": "https://www.homedepot.com/b/Lighting/N-5yc1vZbvn5"
    },
    ...
  ],
  "pagination": {
    "current": 1,
    "next": "https://www.homedepot.com/b/Lighting-Light-Bulbs-LED-Light-Bulbs/N-5yc1vZbm79?Nao=24",
    "other_pages": {
      "2": "https://www.homedepot.com/b/Lighting-Light-Bulbs-LED-Light-Bulbs/N-5yc1vZbm79?Nao=24",
      "3": "https://www.homedepot.com/b/Lighting-Light-Bulbs-LED-Light-Bulbs/N-5yc1vZbm79?Nao=48",
      "4": "https://www.homedepot.com/b/Lighting-Light-Bulbs-LED-Light-Bulbs/N-5yc1vZbm79?Nao=72"
    }
  }
}