Core APIs
...
Results
Core Requests

Category

2min

Category Results

When making a request with the type parameter set to type=category BigBox API will return category results from Home Depot.

Category results are retrieved from the category results page on Home Depot.

Category Results Page
Category Results Page


An example of the JSON object returned from a Category request is shown below:

JSON


BigBox API returns the following properties for Category requests:

Property

Type

Description

category_results

array

An array of Category Result objects, containing each of the product results shown on the Category Results page. The Category Result object has the following properties:

  • position
  • number
  • The position of the result on the category results page.



Product Object The product object contains details about the product within the category result. The product object has the following properties:

  • title
  • string
  • The product title.



  • link
  • string
  • The URL to the product page.



  • brand
  • string
  • The brand name of the product, if shown.



  • item_id
  • string
  • The product item id. Pass the item_id into a type=product request to get product-level data about the product.



  • store_sku
  • string
  • The product store SKU ID.



  • model_number
  • string
  • The model number of the product, if shown.



  • is_bestseller
  • boolean
  • Set to true if the product is flagged as a Bestseller.



  • is_top_rated
  • boolean
  • Set to true if the product is flagged as a Top Rated product.



  • is_exclusive
  • boolean
  • Set to true if the product is flagged as an Exclusive product.



  • primary_image
  • string
  • The primary image URL associated with the product.



  • images
  • array
  • An array of image URLs for the product.



  • sponsored
  • boolean
  • Set to true when the search result is sponsored.



  • rating
  • number
  • The customer rating of this product, out of 5.



  • ratings_total
  • number
  • The total number of customer ratings this product has received.



  • favorite_count