{
  "openapi": "3.0.1",
  "info": {
    "title": "Home Depot Scraper - Products, Prices, Store Stock & Reviews",
    "description": "Scrape homedepot.com products from any search, category, product link or item id: price, was price, Special Buy and clearance, model, store SKU, rating, shelf stock and aisle/bay at your store. Add details (UPC, specs), stock at nearby stores, reviews and Q&A. $0.40 per 1,000 products.",
    "version": "0.1",
    "x-build-id": "pqQYOozuFtSMObaoG"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/topapi~home-depot-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-topapi-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/topapi~home-depot-scraper/runs": {
      "post": {
        "operationId": "runs-sync-topapi-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/topapi~home-depot-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-topapi-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": {
          "searchQueries": {
            "title": "Search keywords",
            "type": "array",
            "description": "Words you would type into homedepot.com's search box, one per line (for example: cordless drill, ceiling fan, kitchen faucet). A model number or a 9-digit item id works too.",
            "items": {
              "type": "string"
            }
          },
          "startUrls": {
            "title": "Home Depot links",
            "type": "array",
            "description": "homedepot.com links: category pages (/b/...N-...), search pages (/s/...) and product pages (/p/.../123456789). Paste them as they appear in your browser.",
            "items": {
              "type": "string"
            }
          },
          "productIds": {
            "title": "Item ids",
            "type": "array",
            "description": "Home Depot item ids (the 9-digit number at the end of a product link, also called Internet # or OMSID).",
            "items": {
              "type": "string"
            }
          },
          "navParams": {
            "title": "Category codes (advanced)",
            "type": "array",
            "description": "Home Depot category codes: the N-... part of a category link (for example N-5yc1vZc27f or 5yc1vZc27f). Same as pasting the category link.",
            "items": {
              "type": "string"
            }
          },
          "maxResultsPerQuery": {
            "title": "Max products per search or category",
            "minimum": 1,
            "maximum": 3000,
            "type": "integer",
            "description": "How many products to read for each keyword or category link. Home Depot shows 744 products per sort order; ask for more and the run reads the same search again in other orders (price low to high, high to low, top rated, newest), without repeats (2,832 distinct products from one 'ceiling fans' search in a test run).",
            "default": 100
          },
          "maxItems": {
            "title": "Max products in this run",
            "minimum": 1,
            "type": "integer",
            "description": "Stops the whole run after this many product rows (all searches, links and item ids together). Empty = no run-wide cap."
          },
          "sortBy": {
            "title": "Sort order",
            "enum": [
              "default",
              "best_match",
              "top_sellers",
              "price_low_to_high",
              "price_high_to_low",
              "top_rated",
              "newest",
              "most_popular",
              "brand"
            ],
            "type": "string",
            "description": "Home Depot's own sort, applied in its query. Default: Best Match for keywords, Top Sellers for categories.",
            "default": "default"
          },
          "zipCode": {
            "title": "ZIP code",
            "type": "string",
            "description": "A US ZIP code. Prices, stock and aisle/bay come from the Home Depot store nearest to it (unless you set a store number), and delivery dates for it. Default: 30339 (Atlanta, GA)."
          },
          "storeId": {
            "title": "Store number",
            "type": "string",
            "description": "A Home Depot store number (for example 121 or 6140), shown on the store's page. Prices, shelf stock and aisle/bay are read for this store. Default: 121 (Cumberland, Atlanta GA), or the store nearest your ZIP code."
          },
          "storeFilter": {
            "title": "Availability",
            "enum": [
              "all",
              "in_store",
              "online"
            ],
            "type": "string",
            "description": "Home Depot's own availability filter, applied in its query.",
            "default": "all"
          },
          "minPrice": {
            "title": "Minimum price ($)",
            "minimum": 0,
            "type": "number",
            "description": "Keep products at or above this price."
          },
          "maxPrice": {
            "title": "Maximum price ($)",
            "minimum": 0,
            "type": "number",
            "description": "Keep products at or below this price."
          },
          "brand": {
            "title": "Brand",
            "type": "string",
            "description": "Keep only these brands (comma-separated, for example: DEWALT, Milwaukee, RYOBI)."
          },
          "minRating": {
            "title": "Minimum rating",
            "minimum": 0,
            "maximum": 5,
            "type": "number",
            "description": "Keep products rated at least this many stars (1-5)."
          },
          "onlyOnSale": {
            "title": "Only products on sale",
            "type": "boolean",
            "description": "Keep products with a lower price, a promotion, clearance or a Special Buy.",
            "default": false
          },
          "minDiscountPercent": {
            "title": "Minimum discount (%)",
            "minimum": 0,
            "maximum": 100,
            "type": "integer",
            "description": "Keep products at least this many percent off (regular or clearance price)."
          },
          "onlyInStock": {
            "title": "Only in stock at the store",
            "type": "boolean",
            "description": "Keep products the chosen store has on its shelf now.",
            "default": false
          },
          "onlyClearance": {
            "title": "Only clearance",
            "type": "boolean",
            "description": "Keep products with a clearance price at the chosen store.",
            "default": false
          },
          "onlySpecialBuy": {
            "title": "Only Special Buys",
            "type": "boolean",
            "description": "Keep Home Depot Special Buy deals.",
            "default": false
          },
          "includeDetails": {
            "title": "Add product details",
            "type": "boolean",
            "description": "Adds the description, highlights, bullet points, full specifications, UPC / GTIN-13, every image, videos, manuals and guides, breadcrumb links and Subscribe & Save terms to each product row. Charged per product row that gets details.",
            "default": false
          },
          "includeStoreAvailability": {
            "title": "Add stock at nearby stores",
            "type": "boolean",
            "description": "Adds a storeAvailability list to each product: the nearest Home Depot stores to your ZIP code, each with its price, shelf quantity, in-stock flag and aisle/bay. Charged per store entry.",
            "default": false
          },
          "maxStores": {
            "title": "Nearby stores per product",
            "minimum": 1,
            "maximum": 25,
            "type": "integer",
            "description": "How many nearby stores to check for each product (with Add stock at nearby stores).",
            "default": 5
          },
          "radiusMiles": {
            "title": "Store search radius (miles)",
            "minimum": 1,
            "maximum": 250,
            "type": "integer",
            "description": "How far from your ZIP code to look for stores.",
            "default": 25
          },
          "inStockStoresOnly": {
            "title": "Only stores that have it",
            "type": "boolean",
            "description": "List only the nearby stores with the product in stock (stores without it are not charged).",
            "default": false
          },
          "storeIds": {
            "title": "Store numbers to check",
            "type": "array",
            "description": "With Add stock at nearby stores: check these Home Depot store numbers instead of the stores nearest the ZIP code (up to 25).",
            "items": {
              "type": "string"
            }
          },
          "includeReviews": {
            "title": "Add customer reviews",
            "type": "boolean",
            "description": "Adds review rows for each product (rating, title, text, date, author, verified purchase, helpful votes, photos, Home Depot's or the brand's reply). Charged per review row.",
            "default": false
          },
          "maxReviewsPerProduct": {
            "title": "Max reviews per product",
            "minimum": 1,
            "type": "integer",
            "description": "Review rows per product.",
            "default": 20
          },
          "reviewsSort": {
            "title": "Review order",
            "enum": [
              "newest",
              "oldest",
              "most_helpful",
              "highest_rating",
              "lowest_rating",
              "photos"
            ],
            "type": "string",
            "description": "Home Depot's own review order.",
            "default": "newest"
          },
          "reviewsVerifiedOnly": {
            "title": "Only verified purchases",
            "type": "boolean",
            "description": "Reviews from verified purchasers only (Home Depot's own filter).",
            "default": false
          },
          "reviewStars": {
            "title": "Only these star ratings",
            "type": "array",
            "description": "Reviews with these star ratings only, for example 1 and 2 (Home Depot's own filter).",
            "items": {
              "type": "string"
            }
          },
          "reviewsNewerThan": {
            "title": "Reviews newer than",
            "type": "string",
            "description": "Only reviews posted after this date (YYYY-MM-DD)."
          },
          "reviewsSearchTerm": {
            "title": "Reviews mentioning",
            "type": "string",
            "description": "Only reviews that mention this word (Home Depot's own review search)."
          },
          "reviewsWithPhotosOnly": {
            "title": "Only reviews with photos",
            "type": "boolean",
            "description": "Keep reviews that carry customer photos.",
            "default": false
          },
          "minHelpfulVotes": {
            "title": "Minimum helpful votes",
            "minimum": 0,
            "type": "integer",
            "description": "Keep reviews with at least this many helpful votes.",
            "default": 0
          },
          "includeQuestions": {
            "title": "Add questions & answers",
            "type": "boolean",
            "description": "Adds question rows for each product, each with its answers (text, author, brand answer flag, helpful votes). Charged per question row.",
            "default": false
          },
          "maxQuestionsPerProduct": {
            "title": "Max questions per product",
            "minimum": 1,
            "type": "integer",
            "description": "Question rows per product.",
            "default": 10
          },
          "includeFacets": {
            "title": "Add the search filters (free)",
            "type": "boolean",
            "description": "Adds one row per search or category (recordType facets, not charged) with Home Depot's own filter groups (brands, price ranges, ratings, features), each value with its product count and link, and the related searches Home Depot shows for a category.",
            "default": false
          },
          "monitorMode": {
            "title": "Only new or changed products (monitor)",
            "type": "boolean",
            "description": "Remembers what this input returned last time and delivers only products that are new or whose price, regular price or in-stock state changed (and, with a minimum stock change set, shelf quantity). Unchanged products are not delivered or charged. Each row carries changeType, changedFields and previousValues.",
            "default": false
          },
          "monitorName": {
            "title": "Monitor name",
            "type": "string",
            "description": "Keeps separate memories for separate monitors of the same input.",
            "default": "home-depot"
          },
          "minQuantityChange": {
            "title": "Report stock changes of at least",
            "minimum": 0,
            "type": "integer",
            "description": "Monitor only: also report a product when the store's shelf quantity moved by at least this many units. 0 = quantity changes alone are not reported.",
            "default": 0
          },
          "resetMonitor": {
            "title": "Reset the monitor memory",
            "type": "boolean",
            "description": "Forget what earlier runs of this monitor saw (the next run delivers everything once).",
            "default": false
          },
          "webhookUrl": {
            "title": "Webhook URL",
            "type": "string",
            "description": "Optional: a URL that receives a JSON POST with the delivered products (up to 200) when the run ends."
          },
          "proxyConfiguration": {
            "title": "Proxy",
            "type": "object",
            "description": "Optional. The run reads Home Depot directly and moves to Apify datacenter, then US residential proxies, by itself when it is refused. Set your own proxy here to use it first."
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}