Category

3min

Category Parameters
﻿GET  /request
The Category Parameters are applicable when making a request with  type=category  to retrieve category results from Home Depot. The category is specified in the  category_id  parameter. The parameters should be appended as querystring parameters to the Home Depot Product Data API GET HTTP request.
Category results are retrieved from the Category results page on Home Depot.
Category Results Page
﻿
For example, to request category results for the  category_id  of  N-5yc1vZbm92 , the request would be:
HTTP
Curl
Node.js
Python
https://api.bigboxapi.com/request?api_key=demo&type=category&category_id=N-5yc1vZbm92
https://api.bigboxapi.com/request?api_key=demo&type=category&category_id=N-5yc1vZbm92
﻿
﻿
Category Parameters
The following parameters are available for all requests made when  type=category .
Parameter
Required
Description
category_id 

required 

category ID to retrieve results from. You may supply any arbitary value in the  category_id  parameter however we recommend using a category ID returned from the Categories API as these are known-good category IDs from Home Depot.

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 category 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
     Category Results﻿

Parameter	Required	Description
category_id	required	category ID to retrieve results from. You may supply any arbitary value in the category_id parameter however we recommend using a category ID returned from the Categories API as these are known-good category IDs from Home Depot.
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 category 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?

Product