{
  "openapi": "3.0.1",
  "info": {
    "title": "Homedepot Reviews Scraper | Customer Reviews and Ratings",
    "description": "Home Depot reviews scraper: turn a product page, item id or keyword into one row per customer review. 100 reviews in 2 seconds, 29 fields each: rating, text, verified buyer, helpful votes, sub-ratings, photos, brand reply, variant bought, model, UPC. Filter by stars, date or words. No login.",
    "version": "1.0",
    "x-build-id": "q5t4PiuMdnKbF3RR2"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/silentflow~homedepot-reviews-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-silentflow-homedepot-reviews-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/silentflow~homedepot-reviews-scraper/runs": {
      "post": {
        "operationId": "runs-sync-silentflow-homedepot-reviews-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/silentflow~homedepot-reviews-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-silentflow-homedepot-reviews-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": {
          "startUrls": {
            "title": "🔗 Home Depot product pages",
            "type": "array",
            "description": "Product pages copied from homedepot.com: <code>https://www.homedepot.com/p/DEWALT-20V-MAX-Cordless-Drill-Impact-Combo-Kit-and-Black-and-Gold-Drill-Bit-Set-21-Piece-DCK240C2W1181/316930365</code>. The page of a product's reviews (<code>/p/reviews/.../316930365/1</code>) works too, and a search page (<code>https://www.homedepot.com/s/cordless%20drill</code>) is read as a keyword.",
            "items": {
              "type": "object",
              "required": [
                "url"
              ],
              "properties": {
                "url": {
                  "type": "string",
                  "title": "URL of a web page",
                  "format": "uri"
                }
              }
            }
          },
          "itemIds": {
            "title": "🔢 Item ids",
            "type": "array",
            "description": "No page at hand? Type the item id, the <b>Internet #</b> shown under the product title on homedepot.com, one per line: <code>316930365</code>, <code>202634188</code>. Faster than pasting addresses for a list of products from your catalog or a spreadsheet.",
            "items": {
              "type": "string"
            }
          },
          "keywords": {
            "title": "🔎 Product keywords",
            "type": "array",
            "description": "Type what a shopper would search, one per line: <code>cordless drill</code>, <code>ryobi leaf blower</code>, <code>samsung refrigerator</code>. Each keyword gives the reviews of the most reviewed Home Depot products whose name, brand or model holds every word, as many products as <b>Products per keyword</b>.",
            "items": {
              "type": "string"
            }
          },
          "maxReviews": {
            "title": "🔢 Max reviews per product",
            "minimum": 1,
            "type": "integer",
            "description": "How many reviews to save for each product, each one a row. Best sellers have thousands (over 16,000 for some paints and toilets); 100 reviews take about a second. Set the number you actually need.",
            "default": 100
          },
          "maxProducts": {
            "title": "📦 Products per keyword",
            "minimum": 1,
            "type": "integer",
            "description": "For each keyword, how many products to take the reviews of, most reviewed first. A run reads up to this number times <b>Max reviews per product</b>. Has no effect on product pages and item ids.",
            "default": 5
          },
          "sortBy": {
            "title": "🔽 Sort reviews by",
            "enum": [
              "newest",
              "oldest",
              "highest_rating",
              "lowest_rating",
              "most_helpful"
            ],
            "type": "string",
            "description": "<b>Newest first</b> is the order to schedule for monitoring. The two rating orders start with the best or the worst reviews; <b>Most helpful</b> starts with the reviews other shoppers voted up.",
            "default": "newest"
          },
          "cutoffDate": {
            "title": "📅 Reviews since",
            "type": "string",
            "description": "Only keep the reviews published on or after this date: <code>2026-01-01</code>, or an age such as <code>30 days</code> for a monthly schedule. Leave empty for every review."
          },
          "starRatings": {
            "title": "⭐ Star ratings",
            "type": "array",
            "description": "Keep only these star ratings. Pick 1 and 2 stars to read what buyers complain about. Leave empty for every rating.",
            "items": {
              "type": "string",
              "enum": [
                "1",
                "2",
                "3",
                "4",
                "5"
              ],
              "enumTitles": [
                "1 star",
                "2 stars",
                "3 stars",
                "4 stars",
                "5 stars"
              ]
            }
          },
          "reviewType": {
            "title": "📝 Review type",
            "enum": [
              "with_text",
              "all",
              "with_photos",
              "verified_purchasers"
            ],
            "type": "string",
            "description": "Many Home Depot buyers leave a star rating without a word. <b>Written reviews</b> (the default) keeps the ones with text; <b>All reviews</b> adds the star-only ratings, with <code>text</code> empty, to match the review count of the product page. <b>With photos</b> keeps the reviews that carry customer photos, returned in the <code>photos</code> column; <b>Verified buyers</b> keeps the reviews of confirmed purchasers.",
            "default": "with_text"
          },
          "reviewSearch": {
            "title": "🔤 Reviews mentioning",
            "type": "string",
            "description": "Keep the reviews that mention these words: <code>battery</code>, <code>leak</code>, <code>delivery</code>. Leave empty for every review."
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}