Home Depot Search API (Async)

The Home Depot Search API endpoint returns a list of Home Depot products based on a search term.

Single Query Request

cURL

curl -X POST \
	-H "Content-Type: application/json" \
	-d '{
			"apiKey": "API_KEY",
			"search_term": "SEARCH_TERM",
			"page": "PAGE",
			"sort_by": "SORT_BY",
			"callback": {
				"type": "webhook",
				"url": "YYYYY"
			}
		}' \
"https://async.scraperapi.com/structured/homedepot/search"

Python

import requests

url = "https://async.scraperapi.com/structured/homedepot/search"
headers = {
    "Content-Type": "application/json"
}
data = {
    "apiKey": "API_KEY",
    "search_term": "SEARCH_TERM",
    "page": "PAGE",
    "sort_by": "SORT_BY",
    "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',
    search_term: 'SEARCH_TERM',
    page: 'PAGE',
    sort_by: 'SORT_BY',
    callback: {
            type: 'webhook',
            url: 'YYYYY' }}),
  headers: {
    'Content-Type': 'application/json',
  },
}

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

PHP

<?php
$curl = curl_init();
$data = json_encode(array(
    'apiKey' => 'API_KEY',
    'search_term' => 'SEARCH_TERM',
    'page' => 'PAGE',
    'sort_by' => 'SORT_BY',
    'callback' => array(
        'type' => 'webhook',
        'url' => 'YYYYY'
    )
));
curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://async.scraperapi.com/structured/homedepot/search',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'POST',
  CURLOPT_POSTFIELDS => $data,
  CURLOPT_HTTPHEADER => array(
    'Content-Type: application/json'
  ),
));
$response = curl_exec($curl);
if (curl_errno($curl)) {
    echo 'Error:' . curl_error($curl);
} else {
    echo $response;
}
curl_close($curl);
?>

Ruby

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

uri = URI('https://async.scraperapi.com/structured/homedepot/search')
request = Net::HTTP::Post.new(uri, 'Content-Type' => 'application/json')
request.body = {
  apiKey: 'API_KEY',
  search_term: 'SEARCH_TERM',
  page: 'PAGE',
  sort_by: 'SORT_BY',
  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 + "\", "
                + "\"search_term\": \"SEARCH_TERM\", "
                + "\"page\": \"PAGE\", "
                + "\"sort_by\": \"SORT_BY\", "
                + "\"callback\": {"
                + "    \"type\": \"webhook\", "
                + "    \"url\": \"YYYYY\""
                + "}}";

            URL url = new URL("https://async.scraperapi.com/structured/homedepot/search");
            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 Queries Request

cURL

curl -X POST \
	-H "Content-Type: application/json" \
	-d '{
			"apiKey": "API_KEY",
			"search_terms": ["SEARCH_TERM1", "SEARCH_TERM2"],
			"sort_by": "SORT_BY",
			"callback": {
				"type": "webhook",
				"url": "YYYYY"
			}
		}' \
"https://async.scraperapi.com/structured/homedepot/search"

Python

import requests

url = "https://async.scraperapi.com/structured/homedepot/search"
headers = {
    "Content-Type": "application/json"
}
data = {
    "apiKey": "API_KEY",
    "search_terms": ["SEARCH_TERM1", "SEARCH_TERM2"],
    "sort_by": "SORT_BY",
    "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',
    search_terms: ['SEARCH_TERM1', 'SEARCH_TERM2'],
    sort_by: 'SORT_BY',
    callback: {
            type: 'webhook',
            url: 'YYYYY' }}),
  headers: {
    'Content-Type': 'application/json',
  },
}

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

PHP

<?php
$curl = curl_init();
$data = json_encode(array(
    'apiKey' => 'API_KEY',
    'search_terms' => ['SEARCH_TERM1', 'SEARCH_TERM2'],
    'sort_by' => 'SORT_BY',
    'callback' => array(
        'type' => 'webhook',
        'url' => 'YYYYY'
    )
));
curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://async.scraperapi.com/structured/homedepot/search',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'POST',
  CURLOPT_POSTFIELDS => $data,
  CURLOPT_HTTPHEADER => array(
    'Content-Type: application/json'
  ),
));
$response = curl_exec($curl);
if (curl_errno($curl)) {
    echo 'Error:' . curl_error($curl);
} else {
    echo $response;
}
curl_close($curl);

Ruby

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

uri = URI('https://async.scraperapi.com/structured/homedepot/search')
request = Net::HTTP::Post.new(uri, 'Content-Type' => 'application/json')
request.body = {
  apiKey: 'API_KEY',
  search_terms: ['SEARCH_TERM1', 'SEARCH_TERM2'],
  sort_by: 'SORT_BY',
  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 + "\", "
                + "\"search_terms\": [\"SEARCH_TERM1\", \"SEARCH_TERM2\"], "
                + "\"sort_by\": \"SORT_BY\", "
                + "\"callback\": {"
                + "    \"type\": \"webhook\", "
                + "    \"url\": \"YYYYY\""
                + "}}";

            URL url = new URL("https://async.scraperapi.com/structured/homedepot/search");
            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.
SEARCH_TERM (required)	Search term. Required unless URL is provided. Example: milwaukee cordless drill To submit several searches in one request, send them as an array in search_terms instead. Each search term creates its own job.
URL	A Home Depot search results URL, used instead of SEARCH_TERM. Both /s/ (keyword search) and /b/ (category browse) URLs are accepted. Example: https://www.homedepot.com/s/milwaukee%20cordless%20drill?Nao=24 Note: When URL is provided, PAGE, SORT_BY, MIN_PRICE and MAX_PRICE are ignored. Paginate or refine by changing the URL itself, or follow pagination.next.link.
PAGE	Page number, sent as a string (e.g. "2"). Each page contains up to 24 results. Defaults to "1".
SORT_BY	Instructs the API to sort the results. Supported values: best_seller most_popular price_low_to_high price_high_to_low highest_rating
MIN_PRICE	Minimum product price in USD, sent as a string (e.g. "100").
MAX_PRICE	Maximum product price in USD, sent as a string (e.g. "500").
OUTPUT_FORMAT	This endpoint returns JSON output only. CSV is not supported. Options: • json (default)

Home Depot's result ranking can change between requests, so the same product may appear on more than one page. Use item_id to deduplicate results when paginating.

Results are localized to a default Home Depot store (returned in location_info). Selecting a specific store or ZIP code is not currently supported, so fulfillment data (pickup, ship-to-store, stock levels) reflects that default store only.

Sample Response

Single Query Request

{
  "id": "f58ca422-f145-49a4-9a1f-e7b516ec2efe",
  "attempts": 0,
  "status": "running",
  "statusUrl": "https://async.scraperapi.com/jobs/f58ca422-f145-49a4-9a1f-e7b516ec2efe",
  "search_term": "milwaukee cordless drill",
  "sort_by": "price_low_to_high"
}

Multiple Queries Request

[
  {
    "id": "34e9b812-1ca4-422f-bb05-abc8ff88a648",
    "attempts": 0,
    "status": "running",
    "statusUrl": "https://async.scraperapi.com/jobs/34e9b812-1ca4-422f-bb05-abc8ff88a648",
    "search_term": "milwaukee cordless drill",
    "sort_by": "price_low_to_high"
  },
  {
    "id": "db125fe4-968a-49f3-b128-14fd2260ab45",
    "attempts": 0,
    "status": "running",
    "statusUrl": "https://async.scraperapi.com/jobs/db125fe4-968a-49f3-b128-14fd2260ab45",
    "search_term": "dewalt cordless drill",
    "sort_by": "price_low_to_high"
  }
]

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.