# Home Depot Product Scraper (`crawlerbros/homedepot-scraper`) Actor Scrape product listings from homedepot.com by keyword or direct URL. Returns product ID, title, brand, price, rating, reviews, image, and URL. - **URL**: https://apify.com/crawlerbros/homedepot-scraper.md - **Developed by:** [Crawler Bros](https://apify.com/crawlerbros) (community) - **Categories:** E-commerce, Automation, Developer tools - **Stats:** 1 total users, 0 monthly users, 96.9% runs succeeded, 9 bookmarks - **User rating**: 5.00 out of 5 stars ## Pricing from $1.00 / 1,000 results This Actor is paid per event and usage. You are charged both the fixed price for specific events and for Apify platform usage. Since this Actor supports Apify Store discounts, the price gets lower the higher subscription plan you have. Learn more: https://docs.apify.com/platform/actors/running/actors-in-store#pay-per-event ## What's an Apify Actor? Actors are a software tools running on the Apify platform, for all kinds of web data extraction and automation use cases. 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. In JavaScript/TypeScript projects, use official [JavaScript/TypeScript client](https://docs.apify.com/api/client/js.md): ```bash npm install apify-client ``` In Python projects, use official [Python client library](https://docs.apify.com/api/client/python.md): ```bash pip install apify-client ``` In shell scripts, use [Apify CLI](https://docs.apify.com/cli/docs.md): ````bash # MacOS / Linux curl -fsSL https://apify.com/install-cli.sh | bash # Windows irm https://apify.com/install-cli.ps1 | iex ```bash In AI frameworks, you might use the [Apify MCP server](https://docs.apify.com/platform/integrations/mcp.md). If your project is in a different language, use 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 ## Home Depot Product Scraper Scrape product listings from **[homedepot.com](https://www.homedepot.com)** by keyword or direct URL. Returns product ID, title, brand, price, original price, rating, reviews, image, and URL. ### What it does - Scrapes `www.homedepot.com/s/` search results - Parses `data-testid="product-pod"` cards for product metadata - Solves Home Depot's Akamai Bot Manager behavioral challenge with **patchright stealth Chromium** - Hardcoded **RESIDENTIAL/US** proxy (required — Home Depot geo-gates to US-only and blocks non-US IPs) - Clean, non-null output — empty fields are omitted from records - Up to 3 retries per URL on Akamai challenge failures ### Input | Field | Type | Default | Description | |---|---|---|---| | `searchQuery` | string | `"drill"` | Free-text keyword. Required unless `startUrls` is set. | | `priceMin` | number | — | Minimum price in USD | | `priceMax` | number | — | Maximum price in USD | | `sortBy` | enum | `relevance` | `relevance`, `top_sellers`, `price_low_to_high`, `price_high_to_low`, `top_rated`, `newest` | | `startUrls` | array | — | Direct Home Depot **search** URLs (`/s/`). Category (`/b/...`) URLs are less reliable and may trigger Akamai differently. | | `maxItems` | integer | `50` | Maximum products to return (1–500) | #### Example input ```json { "searchQuery": "cordless drill", "priceMin": 50, "priceMax": 300, "sortBy": "top_sellers", "maxItems": 20 } ```` ### Output Each product is a JSON record with the following fields (missing fields are omitted, never `null`): | Field | Type | Always present | Description | |---|---|---|---| | `itemId` | string | ✓ | Home Depot internal product ID | | `url` | string | ✓ | Full product URL | | `title` | string | ✓ | Product label (brand stripped) | | `scrapedAt` | string | ✓ | UTC ISO 8601 scrape timestamp | | `brand` | string | — | Brand name (DEWALT, RYOBI, etc.) | | `price` | number | — | Current price in USD | | `originalPrice` | number | — | "Was" / strikethrough price if on sale | | `currency` | string | — | Always `"USD"` when price is set | | `rating` | number | — | Average star rating (0–5) | | `reviewCount` | number | — | Number of customer reviews | | `imageUrl` | string | — | Product thumbnail URL | | `modelNumber` | string | — | Manufacturer model number | #### Sample output ```json { "itemId": "204279858", "url": "https://www.homedepot.com/p/DEWALT-20V-MAX-Cordless-1-2-in-Drill-Driver.../204279858", "title": "20V MAX Cordless 1/2 in. Drill/Driver, (2) 20V 1.3Ah Batteries, Charger and Bag", "brand": "DEWALT", "price": 99.00, "originalPrice": 179.00, "currency": "USD", "imageUrl": "https://images.thdstatic.com/productImages/.../DCD771C2-64_1000.jpg", "scrapedAt": "2026-04-14T07:49:08Z" } ``` ### FAQ **Do I need a proxy?** No configuration needed — a **US residential proxy** is hardcoded and applied automatically. Home Depot uses Akamai Bot Manager with a JavaScript behavioral challenge that rejects datacenter IPs. The scraper launches patchright stealth Chromium under xvfb on Apify, waits for the challenge to clear (2–30 seconds typical), and only then extracts content. **Why does the scraper occasionally retry?** Akamai's challenge can stick on unlucky sessions. The scraper retries up to 3 times per URL with fresh residential sessions before failing. In the 10-run stability test all runs succeeded on the first or second attempt. **Does it support category (`/b/...`) URLs?** Best-effort. Category pages use a different React component and the Akamai challenge there is harder to clear reliably from this scraper. For best results, use **search URLs** (`/s/?...`) which are fully supported. If you paste a `/b/...` URL into `startUrls` and the scraper fails, switch to a search query for the same topic. **How many results can I get per run?** Up to 500 items theoretically. Each search page returns ~24–50 cards. For larger sets, split your query into narrower keywords (e.g. by brand) and push multiple `startUrls`. **How fresh is the data?** Every run fetches live Home Depot HTML. Prices and availability are always current. ### Use cases - **Price monitoring** — daily runs on specific SKUs or keywords - **Competitive analysis** — compare prices vs Lowe's / Amazon / Menards - **Deal hunting** — filter on `originalPrice > price` to find active sales - **Catalog enrichment** — pull metadata for a list of Home Depot item IDs via `startUrls` ### Notes - Pricing is configured in the Apify UI (pay-per-result). - The daily Apify test run uses `searchQuery=drill`, `maxItems=5`. - Home Depot's HTML markup can change; if the scraper starts returning 0 items, re-inspect the `data-testid="price-simple"` and `data-testid="attribute-brandname-inline"` selectors in `src/main.py:parse_search_html`. # Actor input Schema ## `searchQuery` (type: `string`): Free-text keyword (e.g. 'drill', 'paint brush'). Required if startUrls is empty. ## `priceMin` (type: `number`): Minimum price in USD. ## `priceMax` (type: `number`): Maximum price in USD. ## `sortBy` (type: `string`): Sort the results (optional). ## `startUrls` (type: `array`): Direct Home Depot search or category URLs. Overrides `searchQuery` if set. ## `maxItems` (type: `integer`): Maximum products to return. ## Actor input object example ```json { "searchQuery": "drill", "sortBy": "relevance", "maxItems": 5 } ``` # 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 '' with your token const client = new ApifyClient({ token: '', }); // Prepare Actor input const input = { "searchQuery": "drill", "maxItems": 5 }; // Run the Actor and wait for it to finish const run = await client.actor("crawlerbros/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 '' with your token. client = ApifyClient("") # Prepare the Actor input run_input = { "searchQuery": "drill", "maxItems": 5, } # Run the Actor and wait for it to finish run = client.actor("crawlerbros/homedepot-scraper").call(run_input=run_input) # Fetch and print Actor results from the run's dataset (if there are any) print("💾 Check your data here: https://console.apify.com/storage/datasets/" + run["defaultDatasetId"]) for item in client.dataset(run["defaultDatasetId"]).iterate_items(): print(item) # 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/python/docs/quick-start ``` ## CLI example ```bash echo '{ "searchQuery": "drill", "maxItems": 5 }' | apify call crawlerbros/homedepot-scraper --silent --output-dataset ``` ## MCP server setup ```json { "mcpServers": { "apify": { "command": "npx", "args": [ "mcp-remote", "https://mcp.apify.com/?tools=crawlerbros/homedepot-scraper", "--header", "Authorization: Bearer " ] } } } ``` ## OpenAPI specification ```json { "openapi": "3.0.1", "info": { "title": "Home Depot Product Scraper", "description": "Scrape product listings from homedepot.com by keyword or direct URL. Returns product ID, title, brand, price, rating, reviews, image, and URL.", "version": "1.0", "x-build-id": "Kf4EegGkrMXhq6pd3" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/crawlerbros~homedepot-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-crawlerbros-homedepot-scraper", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } }, "/acts/crawlerbros~homedepot-scraper/runs": { "post": { "operationId": "runs-sync-crawlerbros-homedepot-scraper", "x-openai-isConsequential": false, "summary": "Executes an Actor and returns information about the initiated run in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runsResponseSchema" } } } } } } }, "/acts/crawlerbros~homedepot-scraper/run-sync": { "post": { "operationId": "run-sync-crawlerbros-homedepot-scraper", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } } }, "components": { "schemas": { "inputSchema": { "type": "object", "properties": { "searchQuery": { "title": "Search Query", "type": "string", "description": "Free-text keyword (e.g. 'drill', 'paint brush'). Required if startUrls is empty." }, "priceMin": { "title": "Min Price (USD)", "minimum": 0, "type": "number", "description": "Minimum price in USD." }, "priceMax": { "title": "Max Price (USD)", "minimum": 0, "type": "number", "description": "Maximum price in USD." }, "sortBy": { "title": "Sort Order", "enum": [ "relevance", "top_sellers", "price_low_to_high", "price_high_to_low", "top_rated", "newest" ], "type": "string", "description": "Sort the results (optional).", "default": "relevance" }, "startUrls": { "title": "Start URLs (optional)", "type": "array", "description": "Direct Home Depot search or category URLs. Overrides `searchQuery` if set.", "items": { "type": "string" } }, "maxItems": { "title": "Max Items", "minimum": 1, "maximum": 500, "type": "integer", "description": "Maximum products to return.", "default": 50 } } }, "runsResponseSchema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "actId": { "type": "string" }, "userId": { "type": "string" }, "startedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "finishedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "status": { "type": "string", "example": "READY" }, "meta": { "type": "object", "properties": { "origin": { "type": "string", "example": "API" }, "userAgent": { "type": "string" } } }, "stats": { "type": "object", "properties": { "inputBodyLen": { "type": "integer", "example": 2000 }, "rebootCount": { "type": "integer", "example": 0 }, "restartCount": { "type": "integer", "example": 0 }, "resurrectCount": { "type": "integer", "example": 0 }, "computeUnits": { "type": "integer", "example": 0 } } }, "options": { "type": "object", "properties": { "build": { "type": "string", "example": "latest" }, "timeoutSecs": { "type": "integer", "example": 300 }, "memoryMbytes": { "type": "integer", "example": 1024 }, "diskMbytes": { "type": "integer", "example": 2048 } } }, "buildId": { "type": "string" }, "defaultKeyValueStoreId": { "type": "string" }, "defaultDatasetId": { "type": "string" }, "defaultRequestQueueId": { "type": "string" }, "buildNumber": { "type": "string", "example": "1.0.0" }, "containerUrl": { "type": "string" }, "usage": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "integer", "example": 1 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 } } }, "usageTotalUsd": { "type": "number", "example": 0.00005 }, "usageUsd": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "number", "example": 0.00005 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 } } } } } } } } } } ```