{ "openapi": "3.0.1", "info": { "title": "Home Depot Scraper: Prices, Products, Stock & Special Buys", "description": "Get Home Depot products with the price at your store, was price, Special Buy and savings, stock count at that store, aisle and bay, delivery options, model, internet number, brand, rating and reviews. By search, category or product link and ZIP. About $0.005 per product. No login.", "version": "1.0", "x-build-id": "Sj6GXojBg4Nk32fcX" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/moggedhq~home-depot-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-moggedhq-home-depot-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/moggedhq~home-depot-scraper/runs": { "post": { "operationId": "runs-sync-moggedhq-home-depot-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/moggedhq~home-depot-scraper/run-sync": { "post": { "operationId": "run-sync-moggedhq-home-depot-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": { "searchTerms": { "title": "Search terms", "type": "array", "description": "Home Depot searches, such as hammer, cordless drill or kitchen faucet. Retailer category redirects are followed.", "items": { "type": "string" } }, "startUrls": { "title": "Category, deals or product URLs", "type": "array", "description": "Public HTTPS homedepot.com category, search, Special Buy or product links.", "items": { "type": "string" } }, "productIds": { "title": "Product IDs", "type": "array", "description": "Home Depot internet item numbers, such as 317987598. These are not store SKU numbers or UPCs.", "items": { "type": "string" } }, "locations": { "title": "ZIP codes", "type": "array", "description": "US ZIP codes, such as 30339 or 10001. Uses the nearest store for each ZIP. Empty selects the site default Cumberland store 0121.", "items": { "type": "string" } }, "storeIds": { "title": "Store IDs", "type": "array", "description": "Exact numeric Home Depot store numbers, such as 0121 or 6175. Store IDs take precedence over ZIP codes. Retired or invalid stores are rejected.", "items": { "type": "string" } }, "maxItemsPerSearch": { "title": "Maximum products per search and store", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Maximum new product rows from each term, category or deals source at one store. Duplicates are free.", "default": 20 }, "maxItems": { "title": "Maximum products in this run", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Maximum delivered product/store rows in the whole run. About $0.005 per product: 20 products cost about $0.10 plus the small start charge.", "default": 20 }, "dealsOnly": { "title": "Deals only", "type": "boolean", "description": "Return products with a lower price, clearance, Special Buy or another public promotion. Promotion conditions remain in the output.", "default": false }, "includeDetails": { "title": "Include product details", "type": "boolean", "description": "Include optional descriptions and specification groups. Store prices, stock, model, SKU, UPC, aisle and bay are always requested. No extra product fee.", "default": false }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Default datacenter proxy with a kept anonymous HTTP session. US residential is used only after refused datacenter attempts. Custom proxy settings are respected.", "default": { "useApifyProxy": true } } } }, "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 } } } } } } } } } }