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
﻿
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
https://api.bigboxapi.com/request?api_key=demo&type=search&search_term=lawn+mower&sort_by=best_seller
https://api.bigboxapi.com/request?api_key=demo&type=search&search_term=lawn+mower&sort_by=best_seller
﻿
﻿
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:
best_seller 
Sort results by best selling products first.
﻿
most_popular 
Sort results by most popular products first.
﻿
price_high_to_low 
Sort results by highest to lowest priced.
﻿
price_low_to_high 
Sort results by lowest to highest priced.
﻿
highest_rating 
Sort results by highest rated first.
﻿
﻿
﻿
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﻿

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: best_seller Sort results by best selling products first. most_popular Sort results by most popular products first. price_high_to_low Sort results by highest to lowest priced. price_low_to_high Sort results by lowest to highest priced. highest_rating Sort results by highest rated first.
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.

Updated 07 Aug 2024

Did this page help you?

Common