Home Depot Reviews API
Overview
This API endpoint allows you to retrieve reviews from Home Depot. Here are some important things to know:
- The Homedepot API returns 10 reviews per request.
- The order in which reviews are returned is by descending date(from newest to oldest).
- You can get all reviews from a single product by using the
offset
parameter.
Endpoint
GET https://wextractor.com/api/v1/reviews/homedepot
Parameters
Parameter | Required | Description | Example |
---|---|---|---|
auth_token | Required | Your API token for authentication. Once you register to Wextractor you can extract this key from your account's setting page. | - |
id | Required | A textual identifier that uniquely identifies a product in Homedepot. This identifier can be taken from the url of the product in Homedepot. For example, if the url for the product in Homedepot is https://www.homedepot.com/p/RoomMates-4-in-x-16-74-in-16-Piece-Multi-Color-Distressed-Barn-Wood-Plank-Peel-and-Stick-Wall-Decals-RMK3695GM/303352661 the identifier is 303352661
|
303352661 |
offset | Optional | This parameter defines the result offset. It skips the given number of reviews. It's used for pagination. (e.g., 0 (default) is the first page of results, 10 is the 2nd page of results, 20 is the 3rd page of results, etc.). | 10 |
Example Request
https://wextractor.com/api/v1/reviews/homedepot?id=303352661&auth_token=your_auth_token&offset=0
Example Response
{
"totals": {
"review_count": 143
},
"reviews": [
{
"id": "254552976",
"is_recommended": false,
"is_verified_purchase": true,
"datetime": "2022-02-09T15:19:37.000+00:00",
"rating": "5",
"text": "These are very easy to work with and they look great.",
"title": "These are very easy to work with and they look...",
"reviewer": "JACQUELINE"
},
{
"id": "254529467",
"is_recommended": false,
"is_verified_purchase": true,
"datetime": "2022-02-08T23:52:32.000+00:00",
"rating": "5",
"text": null,
"title": null,
"reviewer": "MICHAEL"
},
{
"id": "254065393",
"is_recommended": false,
"is_verified_purchase": false,
"datetime": "2022-01-25T16:51:50.000+00:00",
"rating": "5",
"text": "Perfect for a splash of color under my bar area.",
"title": "Perfect for a splash of color under my bar area....",
"reviewer": "DEE DEE S"
},
{
"id": "251755894",
"is_recommended": false,
"is_verified_purchase": false,
"datetime": "2021-11-17T15:40:47.000+00:00",
"rating": "5",
"text": null,
"title": null,
"reviewer": "Sanz"
},
{
"id": "251246548",
"is_recommended": true,
"is_verified_purchase": true,
"datetime": "2021-11-02T14:19:51.000+00:00",
"rating": "5",
"text": "Transforms the wall completely. Even the little bumps in the wall become a \"feature\" giving it depth. Sticks and stays put until removed.",
"title": "Easy to Use",
"reviewer": "NorthCountryMama"
},
{
"id": "250910061",
"is_recommended": true,
"is_verified_purchase": true,
"datetime": "2021-10-23T16:04:21.000+00:00",
"rating": "5",
"text": "Easy to use. Nice project aid.",
"title": "Easy to use",
"reviewer": "klotzmom3"
},
{
"id": "250675162",
"is_recommended": false,
"is_verified_purchase": false,
"datetime": "2021-10-16T07:59:08.000+00:00",
"rating": "5",
"text": null,
"title": null,
"reviewer": "HomeDepotCustomer"
},
{
"id": "250367248",
"is_recommended": false,
"is_verified_purchase": false,
"datetime": "2021-10-06T01:26:20.000+00:00",
"rating": "5",
"text": null,
"title": null,
"reviewer": "Edgar"
},
{
"id": "249979576",
"is_recommended": false,
"is_verified_purchase": false,
"datetime": "2021-09-22T08:03:33.000+00:00",
"rating": "5",
"text": "Rating provided by a verified purchaser",
"title": "Rating provided by a verified purchaser...",
"reviewer": "LEON"
},
{
"id": "248918937",
"is_recommended": false,
"is_verified_purchase": false,
"datetime": "2021-08-14T11:54:39.000+00:00",
"rating": "5",
"text": "I love this product!",
"title": "I love this product!...",
"reviewer": "TERRI"
}
]
}
Error Codes
Status Code | Error Type | Description |
---|---|---|
400 | InvalidRequest | The request parameters are invalid or missing |
401 | Unauthorized | Invalid or missing API key |
403 | Forbidden | Your account is out of credits |
429 | RateLimitExceeded | You've exceeded the API rate limit(10 requests per second) |
500 | ServerError | An unexpected error occurred on our servers. In these cases we recommend to retry the request for a couple of times. If the error subsists you can reach us to open a ticket. |