{ "openapi": "3.0.1", "info": { "title": "Home Depot Scraper - Price, Store Stock & Specs", "description": "Scrape Home Depot products by URL, item ID, keyword or category: price, was-price, promotion, in-store stock & quantity by store, delivery dates, rating, review count, UPC, model, specs, images. Clean JSON for price monitoring and AI agents. $4.50/1,000 + $0.05/run.", "version": "0.1", "x-build-id": "gJl9bwCMV54gBmDmd" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/pathready~homedepot-product-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-pathready-homedepot-product-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/pathready~homedepot-product-scraper/runs": { "post": { "operationId": "runs-sync-pathready-homedepot-product-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/pathready~homedepot-product-scraper/run-sync": { "post": { "operationId": "run-sync-pathready-homedepot-product-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": { "productUrls": { "title": "Product URLs", "type": "array", "description": "Home Depot product page URLs, e.g. https://www.homedepot.com/p/.../342705642 (the 9-digit number at the end is the item ID). Fastest and most reliable input. One dataset item per product.", "default": [ { "url": "https://www.homedepot.com/p/343493170" } ], "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "itemIds": { "title": "Item IDs", "type": "array", "description": "Home Depot 9-digit item IDs (Internet #), e.g. 342705642. Same output as product URLs.", "default": [], "items": { "type": "string" } }, "searchQueries": { "title": "Search keywords", "type": "array", "description": "Keywords as typed in the homedepot.com search box, e.g. \"cordless drill\" or \"french door refrigerator\". Each keyword returns up to 'Max results per search' full product records (sorted by Top Sellers).", "default": [], "items": { "type": "string" } }, "categoryUrls": { "title": "Category / search page URLs", "type": "array", "description": "Home Depot listing URLs (https://www.homedepot.com/b/... or /s/...), including filtered ones. Products are collected in page order up to 'Max results per search'.", "default": [], "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "maxResultsPerSearch": { "title": "Max results per search / category", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Maximum products collected for each keyword or category URL (24 per page). You pay per product returned.", "default": 24 }, "storeId": { "title": "Store ID (for store price & stock)", "type": "string", "description": "Home Depot store number (e.g. 121 = Atlanta Cumberland, 6542 = Austin). Price, pickup availability and in-store quantity are returned for this store. Leave empty to use the store the site picks for the proxy location.", "default": "" }, "zipCode": { "title": "Delivery ZIP code", "type": "string", "description": "US ZIP code used for ship-to-home / delivery dates. Leave empty to use the site's automatic ZIP.", "default": "" }, "includeDetails": { "title": "Include specifications, highlights & description", "type": "boolean", "description": "Adds the full specification table, bullet highlights and description to each product. Same price either way.", "default": true }, "maxRetries": { "title": "Max session attempts", "minimum": 1, "maximum": 15, "type": "integer", "description": "Each attempt opens a fresh browser session on a new US residential IP; attempts that Home Depot does not trust are dropped within ~100 s.", "default": 6 }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Residential US proxy is required (Home Depot blocks datacenter IPs). Proxy cost is included in the price.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ], "apifyProxyCountry": "US" } } } }, "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 }, "PROXY_UNBLOCKER_UNITS": { "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 }, "PROXY_UNBLOCKER_UNITS": { "type": "integer", "example": 0 } } } } } } } } } }