Home Depot Product Reviews API

With a GET request to the /api/getter/?platform="homedepot_reviews" endpoint, we can scrape customer reviews for any product on Home Depot's online store in real-time.

Example

Here's an example showcasing how you can scrape customer reviews for any product on HomeDepot.com using its product URL and the page number we're interested in scraping reviews from.

The results are sorted by recency, so the most recent reviews are on page 1.

cURL

curl -v -L 'https://data.unwrangle.com/api/getter/?platform=homedepot_reviews&url=https%3A%2F%2Fwww.homedepot.com%2Fp%2F25-in-W-Black-Big-and-Tall-Fabric-Task-Chair-with-Swivel-Seat-B6106%2F301698235&api_key=API_KEY'

Note

When using curl, it is necessary to add the option -L to get the data back. This is because in some cases our server responds with a 301 and curl does not follow the redirect by default.

Query Parameters

As you can see in the example below, our endpoint needs the following query parameters:

Review Query

url

Required

Parameter defines the URL of the product listing for which you want to query reviews. Value of this parameter must be encoded.

page

Optional

Parameter defines the page number from which you want to query reviews. The default value is 1.

Other Required Parameters

platform

Required

Parameter specifies the scraping engine you want to invoke. For the Home Depot Reviews API, the value should be homedepot_reviews.

api_key

Required

Parameter defines your account's token. Get your API key for free here.

Note

The value of the query parameter url must be URL or percent encoded. If you're using Python, this can be done with the function urlencode.

Results

Each request returns up to 10 reviews. The response will include the following attirbutes for each review present in the response:

Attributes Returned	Data Type	Information Represented
id	string	Retailer ID of the review
date	string	Date when review was published
rating	int	Rating by reviewer
review_title	string	Review title by reviewer
review_text	string	Review's text content
author_name	string	Reviewer's name
meta_data	dict	Dict containing meta data like whether purchase is verified and user recommends product. For e.g. verified purchase status
lang_code	string	Country level language of review content

Response Example

Each request returns up to 10 results. Here's the response you can expect for the request showcased above:

{
    "success": true,
    "url": "https://www.homedepot.com/p/25-in-W-Black-Big-and-Tall-Fabric-Task-Chair-with-Swivel-Seat-B6106/301698235",
    "page": 1,
    "total_results": 139,
    "no_of_pages": 14,
    "result_count": 10,
    "reviews": [
        {
            "id": "258214745",
            "date": "2022-06-04",
            "rating": 1,
            "review_title": "Not remotely a \"big and tall\" chair",
            "review_text": "Smaller seat the described due to arms. My 7 year old fits perfect. If you truly need big and tall, this is jot the product.",
            "review_url": null,
            "author_name": "Shan",
            "author_url": null,
            "author_avatar": null,
            "meta_data": {
                "author_id": "h2xsujhwkwhnas30gg1i28efp",
                "verified_purchase": false,
                "helpful_vote_count": 0,
                "early_reviewer_incentive": false,
                "is_recommended": false,
                "photos": []
            },
            "lang_code": "en-US",
            "location": null,
            "response": null
        },
        ...
        {
            "id": "257012986",
            "date": "2022-04-27",
            "rating": 5,
            "review_title": "Easy to assemble and great chair for the price !...",
            "review_text": "Easy to assemble and great chair for the price ! meets my needs perfectly !",
            "review_url": null,
            "author_name": "MATTHEW",
            "author_url": null,
            "author_avatar": null,
            "meta_data": {
                "author_id": "041496984973F4900S",
                "verified_purchase": true,
                "helpful_vote_count": 0,
                "early_reviewer_incentive": false,
                "is_recommended": null,
                "photos": []
            },
            "lang_code": "en-US",
            "location": null,
            "response": null
        },
    ],
    "meta_data": {
        "product_id": "301698235",
        "product_rating": "4.3"
    }
}

Request Cost

Each request returns up to 10 reviews and costs 10 credits regardless of the number of reviews scraped.

Support

If you want to add a parameter to our response, or have any question or feedback, please write to us at support@unwrangle.com