Core APIs
Home Depot Product Data API

Getting Started

7min

Getting Started

BigBox API is an API to retrieve public-domain data from Home Depot in real-time. You can use BigBox API to retrieve products, reviews, questions, search results and category listings from Home Depot.

BigBox API returns clean, structured JSON or CSV results. You can achieve fine-grained control over your request using the request parameters.



Retrieving Search Results for Products on Home Depot

GET /request

Getting search result Home Depot data with BigBox API is as simple as making an HTTP GET request to the request endpoint. The only required parameters are api_key (sign up for free to get an API key) and type (which defines the type of Home Depot data you'd like to retrieve).

For example, to retrieve search results ( type=search ) for the search term lawn mower , ordered by best selling products ( sort_by=best_seller ) the BigBox API request would be:

HTTP
Curl
Node.js
Python
PHP


To view BigBox API JSON results clearly in your browser we recommend these extensions for Chrome and Firefox

The search results are shown below within the search_results array. For full documentation on the search results response see the Search Results docs.

JSON


Response Times & Concurrency BigBox API gathers data in real-time and will typically return a result in 1-6 seconds. Please inspect the HTTP Response Code and update your app accordingly.

If you need to run large volumes of requests consider using the Collections API. Collections allow you to enqueue up to 15,000 requests, run them manually or on a schedule and execute them concurrently on BigBox API's infrastructure.



Getting Data for an Individual Product

GET /request

Lets say we want to change our query to request a different type of data - information on a specific product, in this case the product with Item ID 317061059 . Here's the BigBox API request to achieve that:

HTTP
Curl
Node.js
Python
PHP


The result of the Product request is shown below. For full documentation on Product results see the Product Results docs.

JSON


Localizing Results to a Zipcode BigBox API allows you to retrieve results as they would be seen by a user in a given zipcode by specifying the zipcode or postal code in the customer_zipcode request parameter.

For example, to request results as they would be seen by a user in US zipcode 77001 you should append the customer_zipcode=77001 request parameter.


Updated 07 Aug 2024
Did this page help you?