{ "openapi": "3.0.1", "info": { "title": "Home Depot Category Products Scraper", "description": "Extract Home Depot products by Category ID at scale. Get real-time pricing, stock status, ratings, SKUs, images & store inventory. Fast, reliable & easy export to CSV/JSON!", "version": "1.0", "x-build-id": "D73ay3inIPkocEA7i" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/burbn~home-depot-category-products/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-burbn-home-depot-category-products", "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/burbn~home-depot-category-products/runs": { "post": { "operationId": "runs-sync-burbn-home-depot-category-products", "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/burbn~home-depot-category-products/run-sync": { "post": { "operationId": "run-sync-burbn-home-depot-category-products", "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", "required": [ "categoryId" ], "properties": { "categoryId": { "title": "📂 Category ID", "minLength": 1, "maxLength": 500, "type": "string", "description": "💬 Enter the Home Depot category ID (navigation parameter). This is the N-... segment from Home Depot category page URLs (e.g., 5yc1vZc2bp, 5yc1vZc28b). Alternatively, search products using [Home Depot Search Scraper](https://apify.com/burbn/home-depot-search-scraper) to find category IDs.", "default": "5yc1vZc2bp" }, "sortBy": { "title": "📊 Sort Order", "enum": [ "best_match", "top_sellers", "top_rated", "price_low_to_high", "price_high_to_low", "newest" ], "type": "string", "description": "🔄 Choose how to sort the category results.", "default": "best_match" }, "brand": { "title": "🏷️ Brand Filter", "type": "string", "description": "🔍 Only return products of a specific brand (e.g., DEWALT, Milwaukee, RYOBI). Leave empty for all brands." }, "minPrice": { "title": "💵 Minimum Price ($)", "minimum": 0, "type": "number", "description": "💰 Only return products with a price greater than or equal to this value (in USD)." }, "maxPrice": { "title": "💎 Maximum Price ($)", "minimum": 0, "type": "number", "description": "💰 Only return products with a price less than or equal to this value (in USD)." }, "inStock": { "title": "📦 In Stock Only", "type": "boolean", "description": "✅ Only return products that are currently in stock / fulfillable." }, "storeId": { "title": "🏬 Store ID", "type": "string", "description": "📍 Home Depot store number used to localize pricing, inventory, and pickup availability (e.g., 121)." }, "zipcode": { "title": "📮 Zip Code", "pattern": "^[0-9]{5}$", "type": "string", "description": "🗺️ 5-digit US zip code used to localize delivery options and pricing (e.g., 30301)." }, "itemsPerPage": { "title": "📦 Items Per Page", "minimum": 1, "maximum": 48, "type": "integer", "description": "📊 Number of products to return per page (1-48). Default is 24.", "default": 24 }, "maxPages": { "title": "📄 Maximum Pages", "minimum": 1, "maximum": 30, "type": "integer", "description": "📊 Number of result pages to scrape (1-30). More pages = more results but longer runtime. Each page uses one API call.", "default": 1 } } }, "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 } } } } } } } } } }