Core APIs
...
Parameters
Customer Feedback
Reviews
3 min
reviews parameters get get /request the reviews parameters are applicable when making a request with type=reviews to retrieve customer reviews for a single product on home depot the product is specified using either the item id or url parameter (where the url parameter contains a link to a home depot product page) the parameters should be appended as querystring parameters to the home depot product data api get http request reviews are retrieved from the customer reviews page https //www homedepot com/p/317061059 for a single product on home depot for example, to request reviews sorted by most helpful ( sort by=most helpful ), for the item id 317061059 , the request would be http https //api bigboxapi com/request?api key=demo\&type=reviews\&item id=317061059\&sort by=most helpfulcurl l get https //api bigboxapi com/request d api key="demo" d type="reviews" d item id="317061059" d sort by="most helpful"const axios = require('axios'); // set up the request parameters const params = { api key "demo", type "reviews", item id "317061059", sort by "most helpful" } // make the http get request to bigbox api axios get('https //api bigboxapi com/request', { params }) then(response => { // print the json response from bigbox api console log(json stringify(response data, 0, 2)); }) catch(error => { // catch and print the error console log(error); })import requests import json \# set up the request parameters params = { 'api key' 'demo', 'type' 'reviews', 'item id' '317061059', 'sort by' 'most helpful' } \# make the http get request to bigbox api api result = requests get('https //api bigboxapi com/request', params) \# print the json response from bigbox api print(json dumps(api result json()))\<?php \# set up the request parameters $querystring = http build query(\[ 'api key' => 'demo', 'type' 'reviews', 'item id' '317061059', 'sort by' 'most helpful' ]); \# make the http get request to bigbox api $ch = curl init(sprintf('%s?%s', 'https //api bigboxapi com/request', $querystring)); curl setopt($ch, curlopt returntransfer, true); curl setopt($ch, curlopt followlocation, true); \# the following options are required if you're using an outdated openssl version \# more details https //www openssl org/blog/blog/2021/09/13/letsencryptrootcertexpire/ curl setopt($ch, curlopt ssl verifyhost, false); curl setopt($ch, curlopt ssl verifypeer, false); curl setopt($ch, curlopt timeout, 180); $api result = curl exec($ch); curl close($ch); \# print the json response from bigbox api echo $api result; ?> reviews parameters the following parameters are available for all requests made when type=reviews in addition to the common parameters parameter required description item id required the home depot item id to retrieve reviews for note if the item id parameter is supplied then the url parameter is ignored gtin optional the gtin/isbn/upc code to look up a matching product on home depot for to retrieve reviews for if the gtin parameter is supplied then the item id parameter is ignored gtin based requests work by looking up the gtin/isbn/upc on home depot first, then retrieving the reviews for the first matching item id url optional the home depot reviews page url to retrieve reviews from sort by optional determines the sort order of reviews to return valid values are photo reviews returns reviews with photos first most helpful returns reviews with the most helpful reviews first newest to oldest returns reviews ordered from newest to oldest oldest to newest returns reviews ordered from oldest to newest high to low rating returns reviews ordered highest to lowest rating low to high rating returns reviews ordered lowest to highest rating search term optional search term to use to search reviews reviewer type optional the type of reviewer to retrieve reviews from valid values are verified purchase include reviews by verified purchasers only all include all reviews, regardless of whether they are from verified purchasers or not five star optional set to true to filter to only reviews that give the product a 5 star rating four star optional set to true to filter to only reviews that give the product a 4 star rating three star optional set to true to filter to only reviews that give the product a 3 star rating two star optional set to true to filter to only reviews that give the product a 2 star rating one star optional set to true to filter to only reviews that give the product a 1 star rating page optional the current page of reviews to retrieve inspect the pagination total pages property in the reviews results https //docs trajectdata com/bigboxapi/homedepot product data api/results/reviews to see how many pages of reviews are available note the maximum number of reviews per page is 10 (this is a home depot limit) 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 https //docs trajectdata com/bigboxapi/homedepot product data api/pagination docs for more information next steps reviews results https //docs trajectdata com/bigboxapi/homedepot product data api/results/reviews