# Home Depot Browser (`jupri/homedepot`) Actor

💫 All-in-One Homedepot.com Scraper

- **URL**: https://apify.com/jupri/homedepot.md
- **Developed by:** [cat](https://apify.com/jupri) (community)
- **Categories:** E-commerce
- **Stats:** 279 total users, 6 monthly users, 99.9% runs succeeded, 15 bookmarks
- **User rating**: 5.00 out of 5 stars

## Pricing

$30.00/month + usage

To use this Actor, you pay a monthly rental fee to the developer. The rent is subtracted from your prepaid usage every month after the free trial period. You also pay for the Apify platform usage, which gets cheaper the higher Apify subscription plan you have.

Learn more: https://docs.apify.com/actors/running/actors-in-store.md#rental-actors

## What's an Apify Actor?

Actors are web data automations that power AI and operations. They run on the Apify platform to scrape websites, process data, connect APIs, and automate workflows.
In Batch mode, an Actor accepts a well-defined JSON input, performs an action which can take anything from a few seconds to a few hours,
and optionally produces a well-defined JSON output, datasets with results, or files in key-value store.
In Standby mode, an Actor provides a web server which can be used as a website, API, or an MCP server.
Actors are written with capital "A".

## How to integrate an Actor?

If asked about integration, you help developers integrate Actors into their projects.
You adapt to their stack and deliver integrations that are safe, well-documented, and production-ready.
The best way to integrate Actors is as follows.

- **AI agents and MCP clients** — the [Apify MCP server](https://docs.apify.com/integrations/mcp.md) at `https://mcp.apify.com` (remote, streamable HTTP, OAuth on first use).
- **Agentic workflows and local Actor development** — [Agent Skills](https://apify.com/.well-known/agent-skills/index.json) with the [Apify CLI](https://docs.apify.com/cli/docs.md): `npm install -g apify-cli`, then `apify login`.
- **JavaScript/TypeScript projects** — the official [JS/TS client](https://docs.apify.com/api/client/js/docs.md): `npm install apify-client`.
- **Python projects** — the official [Python client](https://docs.apify.com/api/client/python/docs.md): `pip install apify-client`.
- **Any other language** — the [REST API](https://docs.apify.com/api/v2.md).

For usage examples, see the [API](#api) section below.

For more details, see Apify documentation as [Markdown index](https://docs.apify.com/llms.txt) and [Markdown full-text](https://docs.apify.com/llms-full.txt).

# README

## Welcome to Home Depot Browser

<img height="32" src="https://apify.com/actor-badge?actor=jupri~homedepot&ts=0" align="right">

![dont be sad readme is here](https://raw.githubusercontent.com/JupriGH/resources/main/cats/catframe.png)

### About Homedepot.com

**The Home Depot, Inc.**, is an American [multinational](https://en.wikipedia.org/wiki/Multinational_corporation "Multinational corporation")  [home improvement](https://en.wikipedia.org/wiki/Home_improvement "Home improvement") retail corporation that sells [tools](https://en.wikipedia.org/wiki/Tool "Tool"), [construction](https://en.wikipedia.org/wiki/Construction "Construction") products, appliances, and services. Home Depot is the largest home improvement retailer in the United States.[\[3\]](https://en.wikipedia.org/wiki/The_Home_Depot#cite_note-3) In 2021, the company had 490,600 employees and more than $151 billion in revenue. The company is headquartered in incorporated [Cobb County, Georgia](https://en.wikipedia.org/wiki/Cobb_County,_Georgia "Cobb County, Georgia"), with an [Atlanta](https://en.wikipedia.org/wiki/Atlanta "Atlanta") mailing address.[\[4\]](https://en.wikipedia.org/wiki/The_Home_Depot#cite_note-4)

![enter image description here](https://upload.wikimedia.org/wikipedia/commons/d/dd/Home_Depot_aerial.jpg)

### 🛒 About This Actor

Scrape Homedepot.com for Product Info, Reviews, Questions & Answers, etc.

![enter image description here](https://image.shutterstock.com/image-vector/vector-illustration-under-construction-sign-260nw-1665084250.jpg)

### 🛒 Disclaimer

- 👉 *Free Trial limited to maximum **5** queries*
- 👉 *Free Trial limited to first **100** results*
- 👉 *Maximum number of results for Product Search is **786***
- 👉  ***US** (United States) Proxy is required*

### 🛒 Tutorial

#### 🧺 Parameters

| Name | Type |  Description |
|-|-|-|
| `query` | ***string array*** | List of Query, or Search Terms or Start URL |
| `limit` | ***integer*** | Number of results (per-query)|

#### 🧺 Basic Usage

Searching product

```yaml
{ "query": ["cat litter"], "limit": 40 }
```

#### 🧺 Advanced Usage

##### HomeDepot Query Language (`HDQL`)

```html
[ <COMMAND:> | # | @ ] [ <NAME> | <ID> | <KEYWORD> | <URL> ] [ /<SECTION> ]  
```

##### Possible `QUERY`  values

| Format | Example | Description |
|-|-|-|
| **<*KEYWORDS*>** | `search terms` |***Search Anything***|
| `stores:<KEYWORDS>` | `stores:washington` | Search for stores |
| **<*NAVIGATION\_ID*>** | `N-5yc1vZcgy4` | ***Browse Category***
| **<*PRODUCT\_ID*>** | `312406434` |***Product Data*** |
| `/info` | `312406434/info` | Product info |
| `/reviews` | `312406434/reviews` | Product reviews |
| `/images` | `312406434/photos` |  User submitted images |
| `/questions` | `312406434/questions` | Questions & answers |
| **store:<*STORE\_ID*>** | `store:2406` | **Store Data** |
| `/info` | `store:2406/info` | Store info |
| `/content` | `store:2406/content` | Store content |
| `/services` | `store:2406/services` | Store services |
| `/reviews` | `store:2406/reviews` | Store reviews |
| **collection:<*NAME*>** | `collection:id-41002` | **Collection Data**  |
| `/info` | `collection:id-41002/info` | Collection info
| `/products` | `collection:id-41002/products` | Collection products
| **https:<*URL*>** | `https://www.homedepot.com` |***Start URL*** |
|  | `https://www.homedepot.com/s/...` | Search page |
|  | `https://www.homedepot.com/p/...` | Product page |
|  | `https://www.homedepot.com/b/...` | Category page |
|  | `https://www.homedepot.com/l/...` | Store page |
|  | `https://www.homedepot.com/collection/...` | Collection page |
|  | `https://www.homedepot.com/room/...` | Shop By Room |

### 🛒 Support

⚡️ Feel free to [reach out](https://console.apify.com/actors/dGvcjskBBjOux4Iw9/issues) to the developer for any issues or suggestions for improvement.

<img src="https://apify-uploads-prod.s3.us-east-1.amazonaws.com/5SxZhwYwpknFk8ek9-cat.gif" width="240">

# Actor input Schema

## `prompt` (type: `string`):

No description

## `query` (type: `array`):

💡 QUERY, Search Terms or URL (consult README for more details)

## `example` (type: `string`):

💡Query Examples

## `operation` (type: `string`):

No description

## `limit` (type: `integer`):

Number of results <code>(max=768)</code>

## `map_viewer` (type: `boolean`):

No description

## `include_details` (type: `boolean`):

💡 Crawl for products detail info.

## `store_id` (type: `string`):

💡 Store Location: Zip Code, City, State, Store ID or <code>LATITUDE,LONGITUDE</code>

## `store_features` (type: `array`):

💡 Store Filters

## `zip_code` (type: `string`):

Delivery Location

## `sort` (type: `string`):

No description

## `rating` (type: `string`):

No description

## `min_price` (type: `integer`):

No description

## `max_price` (type: `integer`):

No description

## `style` (type: `array`):

No description

## `color` (type: `array`):

No description

## `room` (type: `array`):

No description

## `review_sort` (type: `string`):

💡 Reviews sorting

## `review_search` (type: `string`):

💡 Review search

## `review_stars` (type: `array`):

💡 Star ratings

## `review_verified` (type: `boolean`):

No description

## `review_profile` (type: `array`):

💡 \[Store Reviews] Home Improvement Profile

## `review_gender` (type: `array`):

💡 \[Store Reviews] Gender

## `review_age` (type: `array`):

💡 \[Store Reviews] Age Range

## `dev_proxy_config` (type: `object`):

💡 <b>Supported protocol:</b><br><br><b>HTTP(S), SOCKS5</b><br><code>{http|socks5}://{user:pass}@{hostname|ip-address}:port</code><br><br><b>Example</b>: <code>socks5://example.com:9000</code>

## `dev_custom_headers` (type: `array`):

💡 Additional HTTP Headers

## `dev_custom_cookies` (type: `array`):

💡 Additional HTTP Cookies

## `dev_transform_fields` (type: `array`):

💡 <b>Transform the resulting output. Select only needed fields.</b><br><br>For nested object use <b>DOT</b>. For example: <pre>address.streetAddress</pre><br>For nested array use <b>NUMBER</b> <i>(index of array element starting from index=0)</i>. For example: <pre>images.0.url</pre>

## `dev_dataset_name` (type: `string`):

💡 <b>Save results into custom named Dataset, use mask to customize dataset name</b><br><br><code>{ACTOR} = actor name<br>{DATE} = date (YYYYMMDD)<br>{TIME} = time (HHMMSS)</code><br><br>This masks can be used to autogenerate Dataset Name.<br><br>example: <i><code>data-{DATE}</code></i><br>Depending on today date the dataset name will be: <code>data-20230603</code><i><br><br>default: <code>data-{ACTOR}-{DATE}-{TIME}</code></i>

## `dev_dataset_clear` (type: `boolean`):

Clear Dataset before insert/update.

## `dev_no_strip` (type: `boolean`):

💡 Keep/Save empty values <i><code>(NULL, FALSE, empty ARRAY, empty OBJECT, empty STRING)</code></i>

## Actor input object example

```json
{
  "query": [
    "Indomie"
  ],
  "limit": 5,
  "dev_proxy_config": {
    "useApifyProxy": true,
    "apifyProxyGroups": [
      "RESIDENTIAL"
    ],
    "apifyProxyCountry": "US"
  }
}
```

# Actor output Schema

## `overview` (type: `string`):

No description

## `results` (type: `string`):

No description

## `mapViewer` (type: `string`):

No description

# API

You can run this Actor programmatically using our API. Below are code examples in JavaScript, Python, and CLI, as well as the OpenAPI specification and MCP server setup.

## JavaScript example

```javascript
import { ApifyClient } from 'apify-client';

// Initialize the ApifyClient with your Apify API token
// Replace the '<YOUR_API_TOKEN>' with your token
const client = new ApifyClient({
    token: '<YOUR_API_TOKEN>',
});

// Prepare Actor input
const input = {
    "query": [
        "Indomie"
    ],
    "limit": 5,
    "dev_proxy_config": {
        "useApifyProxy": true,
        "apifyProxyGroups": [
            "RESIDENTIAL"
        ],
        "apifyProxyCountry": "US"
    }
};

// Run the Actor and wait for it to finish
const run = await client.actor("jupri/homedepot").call(input);

// Fetch and print Actor results from the run's dataset (if any)
console.log('Results from dataset');
console.log(`💾 Check your data here: https://console.apify.com/storage/datasets/${run.defaultDatasetId}`);
const { items } = await client.dataset(run.defaultDatasetId).listItems();
items.forEach((item) => {
    console.dir(item);
});

// 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/js/docs

```

## Python example

```python
from apify_client import ApifyClient

# Initialize the ApifyClient with your Apify API token
# Replace '<YOUR_API_TOKEN>' with your token.
client = ApifyClient("<YOUR_API_TOKEN>")

# Prepare the Actor input
run_input = {
    "query": ["Indomie"],
    "limit": 5,
    "dev_proxy_config": {
        "useApifyProxy": True,
        "apifyProxyGroups": ["RESIDENTIAL"],
        "apifyProxyCountry": "US",
    },
}

# Run the Actor and wait for it to finish
run = client.actor("jupri/homedepot").call(run_input=run_input)

# Fetch and print Actor results from the run's dataset (if there are any)
print(f"💾 Check your data here: https://console.apify.com/storage/datasets/{run.default_dataset_id}")
for item in client.dataset(run.default_dataset_id).iterate_items():
    print(item)

# 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/python/docs/quick-start

```

## CLI example

```bash
echo '{
  "query": [
    "Indomie"
  ],
  "limit": 5,
  "dev_proxy_config": {
    "useApifyProxy": true,
    "apifyProxyGroups": [
      "RESIDENTIAL"
    ],
    "apifyProxyCountry": "US"
  }
}' |
apify call jupri/homedepot --silent --output-dataset

```

## MCP server setup

```json
{
    "mcpServers": {
        "apify": {
            "type": "http",
            "url": "https://mcp.apify.com/?tools=fetch-actor-details,jupri/homedepot"
        }
    }
}

```

The hosted server signs you in with OAuth on first connect, so no API token belongs in this config. Clients without OAuth support can send an `Authorization: Bearer <APIFY_API_TOKEN>` header instead, using a token from API & Integrations in Apify Console (https://console.apify.com/settings/integrations).

## OpenAPI specification

Download the OpenAPI definition: https://api.apify.com/v2/actors/dGvcjskBBjOux4Iw9/builds/DLmNBoBbGtJwHURdr/openapi.json
