{ "openapi": "3.0.1", "info": { "title": "Home Depot Prices Scraper", "description": "Give Home Depot item ids, product URLs, search terms or category URLs, and a store or ZIP; get one row per product: store price, was-price, clearance price, store stock and quantity, rating, UPC, brand and model. $5 per 1,000 products.", "version": "0.1", "x-build-id": "yGwballY2uNve12Hv" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/1mp~home-depot-prices/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-1mp-home-depot-prices", "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/1mp~home-depot-prices/runs": { "post": { "operationId": "runs-sync-1mp-home-depot-prices", "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/1mp~home-depot-prices/run-sync": { "post": { "operationId": "run-sync-1mp-home-depot-prices", "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": { "productIds": { "title": "Item ids", "type": "array", "description": "Home Depot item ids, the number at the end of a product URL, e.g. 204373168. One row per id, priced for the chosen store, through Home Depot's own product lookup. Ids Home Depot does not show are skipped and not billed.", "items": { "type": "string" } }, "startUrls": { "title": "Home Depot URLs", "type": "array", "description": "homedepot.com pages: a product (/p/.../204373168), a search (/s/...) or a category (/b/.../N-...). A product URL returns that one product; a search or category is paged until maxResults. A category is known by the N-... code in its URL; filters in the URL's query string are not applied.", "items": { "type": "string" } }, "searchTerms": { "title": "Search terms", "type": "array", "description": "What to search on homedepot.com, e.g. \"cordless drill\". Each term is searched separately, in Home Depot's best-match order, and paged until maxResults is reached.", "items": { "type": "string" } }, "storeId": { "title": "Store number", "type": "string", "description": "The Home Depot store whose prices and stock you want, e.g. 121 or 6612. It is on the store's page at homedepot.com/l/. Overrides zipCode. Blank and no zipCode: store 121." }, "zipCode": { "title": "ZIP code", "type": "string", "description": "A 5-digit US ZIP code. The Actor uses the Home Depot store nearest to it and logs which one. Ignored when storeId is set." }, "maxResults": { "title": "Maximum products per target", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Stop each search term or URL after this many unique products. Each product returned is one billed result. Pages hold 24 products. Item ids are not capped by this.", "default": 100 }, "dealsOnly": { "title": "Deals only", "type": "boolean", "description": "On: return only products with a was-price or a clearance price at the store.", "default": false }, "clearanceOnly": { "title": "Clearance only", "type": "boolean", "description": "On: return only products Home Depot marks as clearance at the store.", "default": false }, "inStockOnly": { "title": "In stock only", "type": "boolean", "description": "On: skip products with no stock for pickup or delivery. Products with no price are always skipped and never billed.", "default": false }, "requestTimeoutSecs": { "title": "Request timeout (seconds)", "minimum": 5, "maximum": 120, "type": "integer", "description": "Timeout for one request. A failed request is tried again, up to six times.", "default": 30 }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "The fallback route. Each request goes first from Apify's own servers, which Home Depot answered most often (tested 2026-10-03); every third try goes through this proxy. RESIDENTIAL, country US, by default. Apify's data-centre proxy got no data in that test.", "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 } } } } } } } } } }