Common
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:
https://api.bigboxapi.com/request?api_key=demo&type=search&search_term=lawn+mower&sort_by=best_sellerRequest-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:
|
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 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 . |