{
  "openapi": "3.0.1",
  "info": {
    "title": "Home Depot Canada Scraper — Store Price, Stock & Aisle",
    "description": "Scrape homedepot.ca by keyword, category, URL or product ID: store-level CAD price, exact in-store stock, aisle and bay, online stock, sale and bulk prices, ratings, optional specs and reviews. Compare stores near any postal code. English or French. No login.",
    "version": "0.1",
    "x-build-id": "RjyjaffjjDIPUTzA1"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/yugenox~home-depot-canada-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-yugenox-home-depot-canada-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/yugenox~home-depot-canada-scraper/runs": {
      "post": {
        "operationId": "runs-sync-yugenox-home-depot-canada-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/yugenox~home-depot-canada-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-yugenox-home-depot-canada-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": "Keywords to search on homedepot.ca, e.g. \"cordless drill\", \"paint\", \"led bulb\". Each term is scraped separately.",
            "items": {
              "type": "string"
            }
          },
          "categories": {
            "title": "🗂️ Categories",
            "type": "array",
            "description": "Category page URLs (e.g. https://www.homedepot.ca/en/home/categories/tools/power-tools/drills.html) or category codes (e.g. category-drills, l1-tools, l1-bath). Whole departments work too.",
            "items": {
              "type": "string"
            }
          },
          "startUrls": {
            "title": "🔗 homedepot.ca URLs",
            "type": "array",
            "description": "Any homedepot.ca product, search or category page (English or French). Search filters in the URL are kept.",
            "items": {
              "type": "object",
              "required": [
                "url"
              ],
              "properties": {
                "url": {
                  "type": "string",
                  "title": "URL of a web page",
                  "format": "uri"
                }
              }
            }
          },
          "productIds": {
            "title": "🏷️ Product IDs",
            "type": "array",
            "description": "Home Depot Canada product IDs (the 10-digit number at the end of a product URL, e.g. 1001686659) or product URLs. Ideal for tracking price and stock on a fixed list of products.",
            "items": {
              "type": "string"
            }
          },
          "storeIds": {
            "title": "🏬 Store IDs",
            "type": "array",
            "description": "4-digit Home Depot store numbers, e.g. 7001 (Scarborough), 7042 (Vancouver), 7128 (Montreal St-Henri). The first store is used for search results; the same products are then priced at every other store. Leave empty and use a postal code instead if you don't know the numbers.",
            "items": {
              "type": "string"
            }
          },
          "nearLocation": {
            "title": "📍 Stores near (postal code or city)",
            "type": "string",
            "description": "A postal code, city or address, e.g. \"M5V 2T6\", \"Calgary\" or \"H4C 1A1\". Adds the nearest store(s) to the selection."
          },
          "nearestStores": {
            "title": "Number of nearest stores",
            "minimum": 1,
            "maximum": 50,
            "type": "integer",
            "description": "How many stores near the location above to include (1–50).",
            "default": 1
          },
          "provinces": {
            "title": "🍁 Every store in these provinces",
            "type": "array",
            "description": "Adds all Home Depot stores in the selected provinces.",
            "items": {
              "type": "string",
              "enum": [
                "AB",
                "BC",
                "MB",
                "NB",
                "NL",
                "NS",
                "ON",
                "PE",
                "QC",
                "SK"
              ],
              "enumTitles": [
                "Alberta",
                "British Columbia",
                "Manitoba",
                "New Brunswick",
                "Newfoundland and Labrador",
                "Nova Scotia",
                "Ontario",
                "Prince Edward Island",
                "Quebec",
                "Saskatchewan"
              ]
            }
          },
          "allStores": {
            "title": "All stores in Canada",
            "type": "boolean",
            "description": "Price and stock the products at every Home Depot store in Canada (182 stores). Rows = products × stores, so keep the product count modest.",
            "default": false
          },
          "searchEachStore": {
            "title": "Run the search separately at each store",
            "type": "boolean",
            "description": "Off (default): search once at the first store, then check the same products at the other stores — fast and cheap. On: every store gets its own search, so each store's own assortment is listed.",
            "default": false
          },
          "includeStoreRows": {
            "title": "Also save the selected stores",
            "type": "boolean",
            "description": "Adds one row per selected store: address, phone, coordinates, distance and opening hours.",
            "default": false
          },
          "language": {
            "title": "🗣️ Language",
            "enum": [
              "en",
              "fr"
            ],
            "type": "string",
            "description": "Language of product names, descriptions, specs and URLs.",
            "default": "en"
          },
          "sort": {
            "title": "↕️ Sort",
            "enum": [
              "relevance",
              "price-asc",
              "price-desc",
              "rating"
            ],
            "type": "string",
            "description": "Order of search and category results.",
            "default": "relevance"
          },
          "maxItemsPerQuery": {
            "title": "🔢 Max products per search / category",
            "minimum": 0,
            "type": "integer",
            "description": "Products to collect for each search term, category or URL (counted at the first store). 0 = everything.",
            "default": 200
          },
          "maxItems": {
            "title": "Max rows (total)",
            "minimum": 0,
            "type": "integer",
            "description": "Hard cap on rows for the whole run, all stores included. 0 = no cap.",
            "default": 0
          },
          "inStockOnly": {
            "title": "In stock at the store only",
            "type": "boolean",
            "description": "Only keep products with at least one unit in stock at the store.",
            "default": false
          },
          "includeDetails": {
            "title": "Include product details",
            "type": "boolean",
            "description": "Adds description, highlights, full specifications, breadcrumbs, warranty, country of origin, package size, all images, manuals/PDFs and the top reviews. One extra request per product.",
            "default": false
          },
          "maxConcurrency": {
            "title": "Concurrency",
            "minimum": 1,
            "maximum": 20,
            "type": "integer",
            "description": "Parallel connections. The default is a good balance of speed and reliability.",
            "default": 6
          },
          "proxyConfiguration": {
            "title": "Proxy",
            "type": "object",
            "description": "Residential proxies in Canada are required for reliable results (the default).",
            "default": {
              "useApifyProxy": true,
              "apifyProxyGroups": [
                "RESIDENTIAL"
              ],
              "apifyProxyCountry": "CA"
            }
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}