{
  "openapi": "3.0.1",
  "info": {
    "title": "Home Depot Search Results & Price Tracker",
    "description": "Turn a Home Depot keyword search or search URL into structured product data: price, original price, brand, rating, reviews, and image, with sponsored-result and keyword filtering.",
    "version": "1.0",
    "x-build-id": "wuFfPsyQX2r5dL5kR"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/dataspryva~home-depot-search-results-and-price-tracker/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-dataspryva-home-depot-search-results-and-price-tracker",
        "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/dataspryva~home-depot-search-results-and-price-tracker/runs": {
      "post": {
        "operationId": "runs-sync-dataspryva-home-depot-search-results-and-price-tracker",
        "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/dataspryva~home-depot-search-results-and-price-tracker/run-sync": {
      "post": {
        "operationId": "run-sync-dataspryva-home-depot-search-results-and-price-tracker",
        "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": [
          "mode"
        ],
        "properties": {
          "mode": {
            "title": "Mode",
            "enum": [
              "search",
              "category",
              "products"
            ],
            "type": "string",
            "description": "Choose what to scrape: a keyword search, a category browse page, or specific Home Depot item IDs.",
            "default": "search"
          },
          "searchQueries": {
            "title": "Search Queries",
            "type": "array",
            "description": "One keyword per line, for example 'cordless drill'. Used in search mode.",
            "items": {
              "type": "string"
            }
          },
          "categoryUrls": {
            "title": "Category URLs or Browse Codes",
            "type": "array",
            "description": "Home Depot category URLs (/b/...) or browse codes (N-...). Used in category mode.",
            "items": {
              "type": "string"
            }
          },
          "itemIds": {
            "title": "Item IDs or Product URLs",
            "type": "array",
            "description": "Home Depot item IDs or product URLs (/p/...). Used in products mode.",
            "items": {
              "type": "string"
            }
          },
          "storeId": {
            "title": "Store ID",
            "type": "string",
            "description": "Home Depot store number for store-local prices and pickup stock. 121 is Cumberland, GA.",
            "default": "121"
          },
          "zipCode": {
            "title": "ZIP Code (optional)",
            "type": "string",
            "description": "Used to find the nearest store when Store ID is empty, and for delivery estimates."
          },
          "sortBy": {
            "title": "Sort Order",
            "enum": [
              "relevance",
              "top_sellers",
              "price_low_to_high",
              "price_high_to_low",
              "top_rated",
              "newest"
            ],
            "type": "string",
            "description": "How to order the products in each search or category.",
            "default": "relevance"
          },
          "priceMin": {
            "title": "Minimum Price (USD)",
            "minimum": 0,
            "type": "number",
            "description": "Only keep products at or above this price."
          },
          "priceMax": {
            "title": "Maximum Price (USD)",
            "minimum": 0,
            "type": "number",
            "description": "Only keep products at or below this price."
          },
          "brand": {
            "title": "Brand (optional)",
            "type": "string",
            "description": "Keep only products whose brand contains this text, for example Milwaukee."
          },
          "minRating": {
            "title": "Minimum Rating",
            "minimum": 0,
            "maximum": 5,
            "type": "number",
            "description": "Drop products rated below this average, from 0 to 5."
          },
          "onlyOnSale": {
            "title": "Only Products On Sale",
            "type": "boolean",
            "description": "Keep only products with a real discount, promotion, special buy or clearance.",
            "default": false
          },
          "onlyClearance": {
            "title": "Only Clearance Products",
            "type": "boolean",
            "description": "Keep only products with a clearance price.",
            "default": false
          },
          "onlyInStock": {
            "title": "Only Products In Stock",
            "type": "boolean",
            "description": "Keep only products available for pickup at the selected store or for delivery.",
            "default": false
          },
          "includeSponsored": {
            "title": "Include Sponsored Products",
            "type": "boolean",
            "description": "Include paid product placements alongside organic results.",
            "default": false
          },
          "filterKeywords": {
            "title": "Title Keywords (optional)",
            "type": "string",
            "description": "Comma-separated words; keep only products whose title contains at least one, for example chainsaw,chain saw."
          },
          "maxItems": {
            "title": "Maximum Products",
            "minimum": 1,
            "maximum": 5000,
            "type": "integer",
            "description": "Overall maximum number of products to save.",
            "default": 100
          },
          "maxItemsPerQuery": {
            "title": "Maximum Products Per Query or Category",
            "minimum": 1,
            "maximum": 1000,
            "type": "integer",
            "description": "Maximum products to save from each search query or category.",
            "default": 100
          },
          "maxPages": {
            "title": "Maximum Pages Per Source",
            "minimum": 1,
            "maximum": 30,
            "type": "integer",
            "description": "Maximum result pages to read for each search or category. Home Depot returns up to 24 products per page and 30 pages per browse.",
            "default": 30
          },
          "includeDetails": {
            "title": "Include Product Details",
            "type": "boolean",
            "description": "Add description, specs, key features, UPC/GTIN, all images, videos and variants for every product.",
            "default": true
          },
          "includeReviews": {
            "title": "Include Reviews",
            "type": "boolean",
            "description": "Add customer reviews and the rating breakdown for every product.",
            "default": false
          },
          "maxReviewsPerProduct": {
            "title": "Maximum Reviews Per Product",
            "minimum": 0,
            "maximum": 100,
            "type": "integer",
            "description": "Review cap for each product when reviews are enabled.",
            "default": 20
          },
          "reviewsSort": {
            "title": "Review Order",
            "enum": [
              "most_recent",
              "most_helpful",
              "oldest",
              "highest_rating",
              "lowest_rating",
              "photos_first"
            ],
            "type": "string",
            "description": "How to order reviews when reviews are enabled.",
            "default": "most_recent"
          },
          "includeQuestions": {
            "title": "Include Questions & Answers",
            "type": "boolean",
            "description": "Add customer questions and their answers for every product.",
            "default": false
          },
          "maxQuestionsPerProduct": {
            "title": "Maximum Questions Per Product",
            "minimum": 0,
            "maximum": 50,
            "type": "integer",
            "description": "Question cap for each product when questions are enabled.",
            "default": 10
          },
          "includeStoreAvailability": {
            "title": "Include Store Availability",
            "type": "boolean",
            "description": "Add store-local pickup quantity, pickup/delivery split and delivery details.",
            "default": true
          },
          "includeAisleBay": {
            "title": "Include Aisle and Bay",
            "type": "boolean",
            "description": "Add the aisle and bay where the product sits at the selected store.",
            "default": false
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}