# HomeDepot Scraper (`datascrapers/homedepot-scraper`) Actor

Extract product data from homedepot.com with just a collection URL and deliveryZip. Get product names, prices, images, stock levels, brand names, and more — perfect for price monitoring, inventory tracking, or market research. Use it for $3/1000 Products.

- **URL**: https://apify.com/datascrapers/homedepot-scraper.md
- **Developed by:** [Data Scrapers](https://apify.com/datascrapers) (community)
- **Categories:** E-commerce, News, Integrations
- **Features:** Limited permissions
- **Stats:** 14 total users, 7 monthly users, 100.0% runs succeeded, 0 bookmarks
- **User rating**: No ratings yet

## Pricing

$17.33 / 1,000 products

This Actor is paid per event. You are not charged for the Apify platform usage, but only a fixed price for specific events.

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

## What's an Apify Actor?

An Actor is a serverless cloud program that runs on the Apify platform. It has two run modes.
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.

Apify vocabulary and the platform model are defined once, in the agent quickstart at https://apify.com/agents.md.

## 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.

Do not guess an integration path. Every one of them is in the agent quickstart at https://apify.com/agents.md: the Apify MCP server, Agent Skills with the Apify CLI, the JavaScript and Python clients, the REST API, and the account-free path for an agent with no human to sign in. It also carries the rule on stating cost before the first paid run.

For examples already wired to this Actor's own input schema, see the [API](#api) section below.

Each client library has reference documentation the quickstart does not restate: [JavaScript/TypeScript](https://docs.apify.com/api/client/js/docs.md) (`npm install apify-client`) and [Python](https://docs.apify.com/api/client/python/docs.md) (`pip install apify-client`).

# README

**Home Depot Scraper** creates a structured dataset of Home Depot product records collected from category, brand, and search result pages. Each dataset item can include the product name, brand, model and SKU numbers, price and discount fields, rating and review counts, images, category hierarchy, and location-specific availability. Query the source using start URLs or search terms, control the result limit with `maxItems`, and retrieve records through the Apify Dataset API or export them as JSON, CSV, Excel, or XML.

### Dataset at a glance

| Property | Value |
|---|---|
| Source | homedepot.com |
| Record unit | One product |
| Input methods | Start URLs, search queries, store ID, delivery ZIP |
| Main identifiers | `itemId`, `url`, `modelNumber` |
| Delivery | Apify Dataset and API |
| Export formats | JSON, CSV, Excel, XML |
| Update model | Fresh records per Actor run |
| Pricing | Pay per event, $15 per 1,000 products |

### Coverage and available records

The Actor collects product records from:

- **Category and brand pages** passed as `startUrls`.
- **Search result pages** from `searchQueries`, with an optional `sort` order.

Records include pricing and fulfillment information that varies by store and delivery ZIP. Setting `storeId` pins a store number for pricing and stock; otherwise the nearest store is used. `deliveryZip` supplies a ZIP for delivery estimates. `includeRawData` optionally attaches the full unprocessed source object under `rawData`. Home Depot blocks non-US and datacenter traffic, so a US residential proxy is required.

### Data dictionary

| Field | Type | Nullable | Description | Example |
|---|---:|---|---|---|
| `itemId` | string | No | Home Depot item identifier | `203672257` |
| `parentId` | string | Yes | Parent product identifier | `334489230` |
| `name` | string | No | Product name | `5 in. ... Caster Wheel` |
| `url` | string | No | Product page URL | `https://www.homedepot.com/p/...` |
| `brand` | string | Yes | Brand name | `Everbilt` |
| `modelNumber` | string | Yes | Manufacturer model number | `4120945EB` |
| `storeSkuNumber` | string | Yes | Store SKU number | `194925` |
| `productType` | string | Yes | Source product type | `MERCHANDISE` |
| `hasVariants` | boolean | No | Whether the product has variants | `true` |
| `variantCount` | integer | Yes | Number of variants | `6` |
| `price` | number | Yes | Current price | `20.97` |
| `originalPrice` | number | Yes | List price | `20.97` |
| `currency` | string | No | Currency code | `USD` |
| `discountAmount` | number | Yes | Discount amount | `2.0` |
| `discountPercent` | number | Yes | Discount percentage | `10` |
| `unitOfMeasure` | string | Yes | Unit of measure | `each` |
| `priceMessage` | string | Yes | Price message text | — |
| `promotionName` | string | Yes | Active promotion name | `Buy More Save More` |
| `isSpecialBuy` | boolean | No | Special buy flag | `false` |
| `clearancePrice` | number | Yes | Clearance price | — |
| `rating` | number | Yes | Average rating | `4.61` |
| `reviewsCount` | integer | Yes | Total review count | `495` |
| `imageUrl` | string | No | Primary image URL | `https://images.thdstatic.com/...` |
| `images` | array | No | List of image URLs | `[...]` |
| `category` | string | Yes | Category name | `Casters` |
| `categoryHierarchy` | array | No | Category breadcrumb path | `["Furniture", ...]` |
| `department` | string | Yes | Department name | `Casters` |
| `collectionName` | string | Yes | Collection name | — |
| `badges` | array | No | Product badges | `["bestsellerv1"]` |
| `isSponsored` | boolean | No | Sponsored flag | `false` |
| `returnPolicy` | string | Yes | Return policy | `30-Day` |
| `quantityLimit` | integer | Yes | Purchase quantity limit | `0` |
| `hasSubscription` | boolean | No | Subscription flag | `false` |
| `availabilityType` | string | Yes | Availability type | `Shared` |
| `buyable` | boolean | Yes | Whether the item is buyable | `false` |
| `discontinued` | boolean | Yes | Discontinued flag | `false` |
| `fulfillment` | object | No | Fulfillment options and inventory | `{...}` |
| `rawData` | object | Yes | Full unprocessed source object (when `includeRawData` is on) | `{...}` |

### Example dataset record

```json
{
  "itemId": "203672257",
  "parentId": "334489230",
  "name": "5 in. Red Polyurethane and Steel Swivel Plate Locking Caster Wheel with 330 lb. Load Rating",
  "url": "https://www.homedepot.com/p/.../203672257",
  "brand": "Everbilt",
  "modelNumber": "4120945EB",
  "storeSkuNumber": "194925",
  "price": 20.97,
  "originalPrice": 20.97,
  "currency": "USD",
  "rating": 4.6141,
  "reviewsCount": 495,
  "category": "Casters",
  "categoryHierarchy": ["Furniture", "Furniture Accessories & Replacement Parts", "Casters"],
  "hasVariants": true,
  "isSpecialBuy": false,
  "availabilityType": "Shared"
}
```

The record above was produced by a search for `cordless drill` with a US residential proxy.

### Query and input reference

| Input | Type | Required | Default | Accepted values | Description |
|---|---:|---|---|---|---|
| `startUrls` | array | No | `[]` | Home Depot category/brand/search URLs | URLs to scrape |
| `searchQueries` | array | No | `[]` | Search terms | Search terms to look up |
| `maxItems` | integer | No | `48` | `0` = all | Maximum products across all inputs |
| `sort` | string | No | `topsellers` | `topsellers`, `relevance`, `price_asc`, `price_desc`, `rating` | Result sort order |
| `storeId` | string | No | — | Store number | Store used for pricing and stock |
| `deliveryZip` | string | No | — | US ZIP code | ZIP used for delivery estimates |
| `includeRawData` | boolean | No | `false` | `true` / `false` | Attach the full source object under `rawData` |
| `proxyConfiguration` | object | No | US residential | Apify proxy settings | Proxy configuration |

Minimal request:

```json
{
  "searchQueries": ["cordless drill"],
  "maxItems": 48
}
```

Advanced request:

```json
{
  "startUrls": [
    { "url": "https://www.homedepot.com/b/Tools-Hand-Tools-Hammers/N-5yc1vZc98g" }
  ],
  "searchQueries": ["cordless drill"],
  "sort": "topsellers",
  "storeId": "1402",
  "deliveryZip": "30339",
  "maxItems": 200,
  "proxyConfiguration": {
    "useApifyProxy": true,
    "apifyProxyGroups": ["RESIDENTIAL"],
    "apifyProxyCountry": "US"
  }
}
```

### Retrieve the data through the API

1. Start the Actor with a JSON input containing `startUrls` and/or `searchQueries`.
2. Wait for the run to finish.
3. Read records from the run's default dataset.
4. Paginate or export the dataset.

```python
from apify_client import ApifyClient

client = ApifyClient("YOUR_API_TOKEN")
run = client.actor("datascrapers/homedepot-scraper").call(
    run_input={
        "searchQueries": ["cordless drill"],
        "maxItems": 48,
        "proxyConfiguration": {"useApifyProxy": True, "apifyProxyGroups": ["RESIDENTIAL"]},
    }
)
for item in client.dataset(run["defaultDatasetId"]).iterate_items():
    print(item["itemId"], item["name"], item.get("price"))
```

Apify's generated API tab documents the equivalent calls for other languages.

### Data quality and record handling

- **Completeness** — most fields are nullable; `itemId`, `name`, and `url` are always present.
- **Location dependence** — `price`, `promotionName`, and availability fields vary by store and delivery ZIP.
- **Deduplication** — the Actor does not deduplicate across runs; use `itemId` as the stable key for downstream deduplication.
- **Retry/error behavior** — products that cannot be resolved are skipped; the run continues.
- **Normalization** — prices are numbers in USD; ratings are numeric averages.

### Export and pipeline examples

| Destination | Recommended method | Typical use |
|---|---|---|
| PostgreSQL/Supabase | Dataset API or webhook consumer | Product and price history |
| Google Sheets | Apify integration | Competitive price tracking |
| S3/cloud storage | Scheduled export or integration | Catalog snapshots |

### Pricing and cost examples

Billing is **pay per event**: each product record pushed to the dataset is one charge. Platform compute is included in the actor usage fee.

| Records | Estimated base cost |
|---:|---:|
| 1,000 | $15.00 |
| 10,000 | $150.00 |
| 100,000 | $1,500.00 |

Estimates depend on the verified pricing model and the number of products you request.

### Limitations and responsible data use

- Only publicly accessible Home Depot product data is returned.
- Pricing and stock are location-specific and can change between stores and ZIP codes.
- Fields may be missing or conditional depending on the product.
- No historical snapshots are stored unless you keep them yourself.
- You are responsible for complying with Home Depot's terms and applicable laws.

### Dataset questions

#### What does one dataset item represent?

One Home Depot product record.

#### Which field should I use as a unique identifier?

Use `itemId`, the Home Depot item identifier.

#### Are fields nullable or conditional?

Yes. Only `itemId`, `name`, and `url` are always present; pricing, ratings, and availability fields are conditional.

#### Can I retrieve the records as CSV or JSON?

Yes. Export the default dataset as JSON, CSV, Excel, or XML, or read it through the Apify Dataset API.

#### How do I paginate large datasets?

Set `maxItems` to cap output, or paginate the dataset through the Dataset API.

#### What counts as a billable result?

Each product record pushed to the dataset is one event charge.

### Related datasets from Data Scrapers

- **[Amazon Scraper](https://apify.com/datascrapers/amazon-scraper)** — general merchandise product records for cross-retailer price monitoring.
- **[Walmart Scraper](https://apify.com/datascrapers/walmart-scraper)** — big-box retail product records that join with Home Depot data for home-goods comparisons.
- **[Target Scraper](https://apify.com/datascrapers/target-scraper)** — retail product records for the same home and tools categories.
- **[IKEA Scraper](https://apify.com/datascrapers/ikea-scraper)** — home furnishing records for adjacent assortment analysis.
- **[Best Buy Scraper](https://apify.com/datascrapers/best-buy-scraper)** — electronics product records for complementary price datasets.

### Data Scrapers support

Need an additional field, record type, or export workflow? Contact Data Scrapers at stardustspotlight@gmail.com. Include a sample source URL, required fields, expected record volume, and preferred delivery format.

# Actor input Schema

## `startUrls` (type: `array`):

Home Depot category, brand or search result URLs to scrape, for example https://www.homedepot.com/b/Tools-Hand-Tools-Hammers/N-5yc1vZc98g

## `searchQueries` (type: `array`):

Search terms to look up on Home Depot. Can be used instead of, or together with, start URLs.

## `maxItems` (type: `integer`):

Maximum number of products to scrape across all inputs. Set to 0 to scrape every result.

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

Order in which products are returned.

## `storeId` (type: `string`):

Home Depot store number used for pricing and stock, for example 1402. Leave empty to use the store nearest to the proxy location.

## `deliveryZip` (type: `string`):

US ZIP code used for delivery estimates, for example 30339. Leave empty to use the ZIP derived from the proxy location.

## `includeRawData` (type: `boolean`):

Attach the complete unprocessed product object from Home Depot under the rawData field. Produces much larger dataset items.

## `proxyConfiguration` (type: `object`):

Home Depot blocks non-US and datacenter traffic, so US residential proxies are required.

## Actor input object example

```json
{
  "startUrls": [
    {
      "url": "https://www.homedepot.com/b/Tools-Hand-Tools-Hammers/N-5yc1vZc98g"
    }
  ],
  "searchQueries": [
    "cordless drill"
  ],
  "maxItems": 48,
  "sort": "topsellers",
  "includeRawData": false,
  "proxyConfiguration": {
    "useApifyProxy": true,
    "apifyProxyGroups": [
      "RESIDENTIAL"
    ],
    "apifyProxyCountry": "US"
  }
}
```

# Actor output Schema

## `products` (type: `string`):

All scraped product records

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

Product table view

## `runStats` (type: `string`):

Record counts and run timestamps

## `datasetId` (type: `string`):

No description

## `run` (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 = {
    "startUrls": [
        {
            "url": "https://www.homedepot.com/b/Tools-Hand-Tools-Hammers/N-5yc1vZc98g"
        }
    ],
    "searchQueries": [
        "cordless drill"
    ],
    "maxItems": 48,
    "proxyConfiguration": {
        "useApifyProxy": true,
        "apifyProxyGroups": [
            "RESIDENTIAL"
        ],
        "apifyProxyCountry": "US"
    }
};

// Run the Actor and wait for it to finish
const run = await client.actor("datascrapers/homedepot-scraper").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 = {
    "startUrls": [{ "url": "https://www.homedepot.com/b/Tools-Hand-Tools-Hammers/N-5yc1vZc98g" }],
    "searchQueries": ["cordless drill"],
    "maxItems": 48,
    "proxyConfiguration": {
        "useApifyProxy": True,
        "apifyProxyGroups": ["RESIDENTIAL"],
        "apifyProxyCountry": "US",
    },
}

# Run the Actor and wait for it to finish
run = client.actor("datascrapers/homedepot-scraper").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 '{
  "startUrls": [
    {
      "url": "https://www.homedepot.com/b/Tools-Hand-Tools-Hammers/N-5yc1vZc98g"
    }
  ],
  "searchQueries": [
    "cordless drill"
  ],
  "maxItems": 48,
  "proxyConfiguration": {
    "useApifyProxy": true,
    "apifyProxyGroups": [
      "RESIDENTIAL"
    ],
    "apifyProxyCountry": "US"
  }
}' |
apify call datascrapers/homedepot-scraper --silent --output-dataset

```

## MCP server setup

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

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/X4ntVCS6fcOIuJFNA/builds/vhuIBZsZ8s3SZTFAn/openapi.json
