Core APIs
...
Parameters
Core Requests

Search

3min

Search Parameters

GET /request

The Search Parameters are applicable when making a request with type=search to retrieve search results from Home Depot. The search term is specified in the search_term parameter. The parameters should be appended as querystring parameters to the Home Depot Product Data API GET HTTP request.

Search results are retrieved from the Search results page on Home Depot.

Search Results Page
Search Results Page


For example, to request search results for the search term lawn mower , sorted by "best selling products", the request would be:

HTTP
Curl
Node.js
Python
PHP



Search Parameters

The following parameters are available for all requests made when type=search .

Parameter

Required

Description

search_term

required

search term to use to search for Home Depot items. Either the search_term or url parameter must be supplied.

sort_by

optional

Determines how the results are sorted. Valid values are:

  1. best_seller
  2. Sort results by best selling products first.



  1. most_popular
  2. Sort results by most popular products first.



  1. price_high_to_low
  2. Sort results by highest to lowest priced.



  1. price_low_to_high
  2. Sort results by lowest to highest priced.



  1. highest_rating
  2. Sort results by highest rated first.



  • 

    Document image
    

min_price

optional

Determines the minimum price of results to return, expressed in dollars and cents (i.e. min_price=2.99 for $2.99).

max_price

optional

Determines the maximum price of results to return, expressed in dollars and cents (i.e. min_price=39.99 for $39.99).

page

optional

The current page of results to retrieve. Inspect the pagination results property for details on the number of pages available.

max_page

optional

Use the max_page parameter to get multiple pages of results in one request. The API will automatically paginate through pages and concatenate the results into one response. See the Pagination docs for more information.

url

optional

The Home Depot search results page to retrieve results from. Note : If the url parameter is supplied then all other parameters are ignored as they are overriden be those specified in the url parameter.



Next Steps      Search Results

Updated 07 Aug 2024
Did this page help you?