Home Depot Reviews API (Async)

The Home Depot Reviews API endpoint returns customer reviews for a single Home Depot product.

Single Product Request

cURL

curl -X POST \
	-H "Content-Type: application/json" \
	-d '{
			"apiKey": "API_KEY",
			"item_id": "ITEM_ID",
			"callback": {
				"type": "webhook",
				"url": "YYYYY"
			}
		}' \
"https://async.scraperapi.com/structured/homedepot/reviews"

Python

import requests

url = "https://async.scraperapi.com/structured/homedepot/reviews"
headers = {
    "Content-Type": "application/json"
}
data = {
    "apiKey": "API_KEY",
    "item_id": "ITEM_ID",
    "callback": {
        "type": "webhook",
        "url": "YYYYY"
    }
}

response = requests.post(url, json=data, headers=headers)
print(response.text)

NodeJS

import fetch from 'node-fetch';

const options = {
  method: 'POST',
  body: JSON.stringify({
    apiKey: 'API_KEY',
    item_id: 'ITEM_ID',
    callback: {
            type: 'webhook',
            url: 'YYYYY' }}),
  headers: {
    'Content-Type': 'application/json',
  },
}

fetch('https://async.scraperapi.com/structured/homedepot/reviews', options)
  .then(response => {
    response.text().then(text => console.log(text));
  })
  .catch(error => {
    console.log(error)
  })

PHP

<?php
$data = json_encode(array(
    'apiKey' => 'API_KEY',
    'item_id' => 'ITEM_ID',
    'callback' => array('type' => 'webhook','url' => 'YYYYY')
));
$ch = curl_init('https://async.scraperapi.com/structured/homedepot/reviews');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, $data);
curl_setopt($ch, CURLOPT_HTTPHEADER, array('Content-Type: application/json'));
$response = curl_exec($ch);
if (curl_errno($ch)) { echo 'Error:' . curl_error($ch); } else { echo $response; }
curl_close($ch);

Ruby

require 'net/http'
require 'json'
require 'uri'

uri = URI('https://async.scraperapi.com/structured/homedepot/reviews')
request = Net::HTTP::Post.new(uri, 'Content-Type' => 'application/json')
request.body = {
  apiKey: 'API_KEY',
  item_id: 'ITEM_ID',
  callback: {
    type: 'webhook',
    url: 'YYYYY'
  }
}.to_json
begin
  response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) do |http|
    http.request(request)
  end
  puts response.body
rescue => e
  puts "Error: #{e.message}"
end

Java

import java.io.BufferedReader;
import java.io.InputStreamReader;
import java.io.OutputStream;
import java.net.HttpURLConnection;
import javax.net.ssl.HttpsURLConnection;
import java.net.URL;
import java.nio.charset.StandardCharsets;

public class Main {
    public static void main(String[] args) {
        try {
            String apiKey = "API_KEY";
            String jsonInputString = "{"
                + "\"apiKey\": \"" + apiKey + "\", "
                + "\"item_id\": \"ITEM_ID\", "
                + "\"callback\": {"
                + "    \"type\": \"webhook\", "
                + "    \"url\": \"YYYYY\""
                + "}}";

            URL url = new URL("https://async.scraperapi.com/structured/homedepot/reviews");
            HttpsURLConnection connection = (HttpsURLConnection) url.openConnection();
            connection.setRequestMethod("POST");
            connection.setRequestProperty("Content-Type", "application/json");
            connection.setRequestProperty("Accept", "*/*");
            connection.setDoOutput(true);
            try (OutputStream os = connection.getOutputStream()) {
                byte[] input = jsonInputString.getBytes(StandardCharsets.UTF_8);
                os.write(input, 0, input.length);
            }
            int responseCode = connection.getResponseCode();
            StringBuilder response = new StringBuilder();
            BufferedReader in = new BufferedReader(new InputStreamReader(connection.getInputStream()));
            String readLine;
            while ((readLine = in.readLine()) != null) {
                response.append(readLine);
            }
            in.close();
            if (responseCode == HttpURLConnection.HTTP_OK) {
                System.out.println("Response: " + response.toString());
            } else {
                throw new Exception("Error in API Call: Response code " + responseCode + "\nbody: " + response.toString());
            }
        } catch (Exception ex) {
            ex.printStackTrace();
        }
    }
}

Multiple Products Request

cURL

curl -X POST \
	-H "Content-Type: application/json" \
	-d '{
			"apiKey": "API_KEY",
			"item_ids": ["ITEM_ID1", "ITEM_ID2"],
			"callback": {
				"type": "webhook",
				"url": "YYYYY"
			}
		}' \
"https://async.scraperapi.com/structured/homedepot/reviews"

Python

import requests

url = "https://async.scraperapi.com/structured/homedepot/reviews"
headers = {
    "Content-Type": "application/json"
}
data = {
    "apiKey": "API_KEY",
    "item_ids": ["ITEM_ID1", "ITEM_ID2"],
    "callback": {
        "type": "webhook",
        "url": "YYYYY"
    }
}

response = requests.post(url, json=data, headers=headers)
print(response.text)

NodeJS

import fetch from 'node-fetch';

const options = {
  method: 'POST',
  body: JSON.stringify({
    apiKey: 'API_KEY',
    item_ids: ['ITEM_ID1', 'ITEM_ID2'],
    callback: {
            type: 'webhook',
            url: 'YYYYY' }}),
  headers: {
    'Content-Type': 'application/json',
  },
}

fetch('https://async.scraperapi.com/structured/homedepot/reviews', options)
  .then(response => {
    response.text().then(text => console.log(text));
  })
  .catch(error => {
    console.log(error)
  })

PHP

<?php
$data = json_encode(array(
    'apiKey' => 'API_KEY',
    'item_ids' => ['ITEM_ID1', 'ITEM_ID2'],
    'callback' => array('type' => 'webhook','url' => 'YYYYY')
));
$ch = curl_init('https://async.scraperapi.com/structured/homedepot/reviews');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, $data);
curl_setopt($ch, CURLOPT_HTTPHEADER, array('Content-Type: application/json'));
$response = curl_exec($ch);
if (curl_errno($ch)) { echo 'Error:' . curl_error($ch); } else { echo $response; }
curl_close($ch);

Ruby

require 'net/http'
require 'json'
require 'uri'

uri = URI('https://async.scraperapi.com/structured/homedepot/reviews')
request = Net::HTTP::Post.new(uri, 'Content-Type' => 'application/json')
request.body = {
  apiKey: 'API_KEY',
  item_ids: ['ITEM_ID1', 'ITEM_ID2'],
  callback: {
    type: 'webhook',
    url: 'YYYYY'
  }
}.to_json
begin
  response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) do |http|
    http.request(request)
  end
  puts response.body
rescue => e
  puts "Error: #{e.message}"
end

Java

import java.io.BufferedReader;
import java.io.InputStreamReader;
import java.io.OutputStream;
import java.net.HttpURLConnection;
import javax.net.ssl.HttpsURLConnection;
import java.net.URL;
import java.nio.charset.StandardCharsets;

public class Main {
    public static void main(String[] args) {
        try {
            String apiKey = "API_KEY";
            String jsonInputString = "{"
                + "\"apiKey\": \"" + apiKey + "\", "
                + "\"item_ids\": [\"ITEM_ID1\", \"ITEM_ID2\"], "
                + "\"callback\": {"
                + "    \"type\": \"webhook\", "
                + "    \"url\": \"YYYYY\""
                + "}}";

            URL url = new URL("https://async.scraperapi.com/structured/homedepot/reviews");
            HttpsURLConnection connection = (HttpsURLConnection) url.openConnection();
            connection.setRequestMethod("POST");
            connection.setRequestProperty("Content-Type", "application/json");
            connection.setRequestProperty("Accept", "*/*");
            connection.setDoOutput(true);
            try (OutputStream os = connection.getOutputStream()) {
                byte[] input = jsonInputString.getBytes(StandardCharsets.UTF_8);
                os.write(input, 0, input.length);
            }
            int responseCode = connection.getResponseCode();
            StringBuilder response = new StringBuilder();
            BufferedReader in = new BufferedReader(new InputStreamReader(connection.getInputStream()));
            String readLine;
            while ((readLine = in.readLine()) != null) {
                response.append(readLine);
            }
            in.close();
            if (responseCode == HttpURLConnection.HTTP_OK) {
                System.out.println("Response: " + response.toString());
            } else {
                throw new Exception("Error in API Call: Response code " + responseCode + "\nbody: " + response.toString());
            }
        } catch (Exception ex) {
            ex.printStackTrace();
        }
    }
}

Supported Parameters

Parameters	Details
API_KEY (required)	Your API Key.
ITEM_ID (required)	Home Depot Internet number, the number at the end of the product URL. Required unless GTIN or URL is provided. Example: 320326855 To submit several products in one request, send them as an array in item_ids instead. Each item ID creates its own job.
PAGE	Reviews page number, sent as a string (e.g. "2"). Each page contains up to 30 reviews. Defaults to "1". Used only with ITEM_ID.
GTIN	Product barcode (UPC, EAN or GTIN), used instead of ITEM_ID. Example: 045242637720 Note: Returns the 1st page with 10 reviews only. The barcode must match exactly one Home Depot product.
URL	A Home Depot product page or reviews page URL, used instead of ITEM_ID. Product page (e.g. https://www.homedepot.com/p/320326855): returns the first 10 reviews only. Reviews page (e.g. https://www.homedepot.com/p/reviews/x/320326855/3): returns that page, up to 30 reviews.
OUTPUT_FORMAT	This endpoint returns JSON output only. CSV is not supported. Options: json (default)

Only one product identifier is used per request. If you send more than one, URL takes priority, then GTIN, then ITEM_ID. To page through all reviews, use ITEM_ID with PAGE.

Sample Response

Single Product Request

{
  "id": "TODO_JOB_ID",
  "attempts": 0,
  "status": "running",
  "statusUrl": "https://async.scraperapi.com/jobs/TODO_JOB_ID",
  "item_id": "320326855"
}

Multiple Products Request

[
  {
    "id": "TODO_JOB_ID_1",
    "attempts": 0,
    "status": "running",
    "statusUrl": "https://async.scraperapi.com/jobs/TODO_JOB_ID_1",
    "item_id": "320326855"
  },
  {
    "id": "TODO_JOB_ID_2",
    "attempts": 0,
    "status": "running",
    "statusUrl": "https://async.scraperapi.com/jobs/TODO_JOB_ID_2",
    "item_id": "302190765"
  }
]

After the job(s) finish, you will find the result under the response key in the response JSON object. The structure is the same as in the corresponding SYNC data endpoint.