Core APIs
...
Home Depot Product Data API
Parameters

Common

4min

Common Parameters

GET /request

The following parameters are used to configure your request to the Home Depot Product Data API. They should be appended as querystring parameters to a GET HTTP request to the /request endpoint.

For example, to request search results, for the search term highlighter pens , sorted by best_seller , on homedepot.com the request would be:

HTTP
Curl
Node.js
Python
PHP


Request-Specific Parameters Additional parameters are available depending on the type of request being made (as-determined by the type parameter). For example, if you make a request with type=reviews then additional Reviews Parameters, specific to reviews requests, are available.



Common Parameters

The following common parameters are required for all requests to the Home Depot Product Data API.

Parameter

Required

Description

api_key

required

The API key for your BigBox API account.

type

required

The type of Home Depot data to retrieve. The value of the type parameter determines which additional parameters are available. For example, if you make a request with type=search then additional Search Parameters , specific to search requests, are available.

Valid values for type are:

  1. search
  2. Request search results for a search_term or Home Depot search results page url . See additional Search Parameters .



  1. category
  2. Request category-listing results for a category_id or Home Depot search results page url . See additional Category Parameters .



  1. product
  2. Request data from a Home Depot product page via an item_id or Home Depot product page url . See additional Product Parameters .



  1. reviews
  2. Request customer reviews for an item_id or Home Depot product page url . See additional Reviews Parameters .



  1. questions
  2. Request customer questions & answers for an item_id or Home Depot product page url . See additional Questions Parameters .

customer_zipcode

optional

Determines the specific customer zipcode location of the request. This is useful to see in-store pricing for a particular location.

To use the customer_zipcode parameter you must first setup the zipcode in the zipcodes section of the Dashboard.

For more information please see the Customer Zipcode Reference .

output

optional

Determines the format in which results are returned. Can be set to json (default) to get the results as structured JSON, html to get the raw html retrieved or csv to return the results in CSV format. When using csv you can also use the csv_fields parameter to specify which fields to return in the CSV.

csv_fields

optional

Determines the fields that are returned when returning in csv mode (i.e. when the output parameter is set to csv ). Should be specified as a comma seperated list of fields (in nested field, dot notation, format). For more information on the csv_fields parameter please see the CSV Fields Reference .

include_fields

optional

A comma-seperated list JSON field names to include in the JSON object the API returns. You can specify the field names in dot notation - i.e.

include_fields=pagination will only include the the pagination property in the response JSON. Use include_fields if you only want to include specific fields in the API's JSON response.

exclude_fields

optional

A comma-seperated list of JSON field names to exclude from the JSON object the API returns. You can specify the field names in dot notation - i.e. exclude_fields=pagination will remove the pagination property from the response JSON. Use exclude_fields if there are specific fields you wish to exclude from the API's JSON response.



Next Steps      Search Parameters      Category Parameters      Product Parameters      Reviews Parameters

Updated 07 Aug 2024
Did this page help you?