# Home Depot & Lowe's Price Tracker with Penny Detection (`pulsewatch/dealwatch-scraper`) Actor

Real-time price monitoring for Home Depot and Lowe's. Detects 30-90% off clearance, penny items (.02/.03 → .01), and inventory drops. Multi-ZIP support. Outputs clean JSON with product details, prices, discounts, and stock status.

- **URL**: https://apify.com/pulsewatch/dealwatch-scraper.md
- **Developed by:** [Niko W](https://apify.com/pulsewatch) (community)
- **Categories:** Developer tools, E-commerce, Automation
- **Stats:** 3 total users, 0 monthly users, 100.0% runs succeeded, NaN bookmarks
- **User rating**: No ratings yet

## Pricing

from $0.00005 / actor start

This Actor is paid per event. You are not charged for the Apify platform usage, but only a fixed price for specific events.

Learn more: https://docs.apify.com/platform/actors/running/actors-in-store#pay-per-event

## What's an Apify Actor?

Actors are a software tools running on the Apify platform, for all kinds of web data extraction and automation use cases.
In Batch mode, an Actor accepts a well-defined JSON input, performs an action which can take anything from a few seconds to a few hours,
and optionally produces a well-defined JSON output, datasets with results, or files in key-value store.
In Standby mode, an Actor provides a web server which can be used as a website, API, or an MCP server.
Actors are written with capital "A".

## How to integrate an Actor?

If asked about integration, you help developers integrate Actors into their projects.
You adapt to their stack and deliver integrations that are safe, well-documented, and production-ready.
The best way to integrate Actors is as follows.

In JavaScript/TypeScript projects, use official [JavaScript/TypeScript client](https://docs.apify.com/api/client/js.md):

```bash
npm install apify-client
```

In Python projects, use official [Python client library](https://docs.apify.com/api/client/python.md):

```bash
pip install apify-client
```

In shell scripts, use [Apify CLI](https://docs.apify.com/cli/docs.md):

````bash
# MacOS / Linux
curl -fsSL https://apify.com/install-cli.sh | bash
# Windows
irm https://apify.com/install-cli.ps1 | iex
```bash

In AI frameworks, you might use the [Apify MCP server](https://docs.apify.com/platform/integrations/mcp.md).

If your project is in a different language, use the [REST API](https://docs.apify.com/api/v2.md).

For usage examples, see the [API](#api) section below.

For more details, see Apify documentation as [Markdown index](https://docs.apify.com/llms.txt) and [Markdown full-text](https://docs.apify.com/llms-full.txt).


# README

## DealWatch

DealWatch scrapes product listings, stores results in SQLite, and can send alert messages.

This README covers local setup through running the scraper test script:
`app/scripts/test_scraper.py`.

### 1. Prerequisites

- Python 3.11+
- `uv` installed
- Linux desktop/headless environment capable of running Playwright/Camoufox

### 2. Clone And Enter Project

```bash
git clone <your-repo-url>
cd dealwatch
````

### 3. Set Python Module Path

Run commands from the project root and set:

```bash
export PYTHONPATH=.
```

If you prefer per-command usage, prefix commands like:

```bash
PYTHONPATH=. uv run python app/scripts/test_scraper.py
```

### 4. Configure Environment

Create `.env` in the project root:

```bash
cat > .env << 'EOF'
DB_PATH=sql.db
EOF
```

`DB_PATH` is the SQLite file used by the DAO layer.

### 5. Install Dependencies

```bash
uv sync
```

### 6. Install Browser Runtime

For the current Home Depot config (`app/configs/yaml/homedepot.com.yaml`), Camoufox is enabled, so fetch Camoufox:

```bash
uv run python -m camoufox fetch
```

Playwright browser install :

```bash
uv run python -m playwright install
```

### 7. Seed Required Database Records

`test_scraper.py` uses `domain_name="homedepot.com"` and keyword search.\
You must have:

- a `websites` row for `homedepot.com`
- at least one keyword in `keywords`

Add website:

```bash
uv run python app/scripts/add_website.py --domain-name homedepot.com
```

Add one keyword:

```bash
uv run python app/scripts/add_keyword.py --keyword screwdriver
```

Or bulk load from `keywords.txt`:

```bash
uv run python app/scripts/add_keyword_from_txt.py
```

### 8. Add Telegram Account Details

If you want alert delivery, add at least one Telegram bot account to the database.

Insert account:

```bash
uv run python app/scripts/add_account.py \
  --token "<telegram_bot_token>" \
  --chat-id "<telegram_chat_id>"
```

Send a test alert to all stored Telegram accounts:

```bash
uv run python app/services/telegram/alert.py "DealWatch setup test message"
```

If this command reports `sent=1` (or more), Telegram setup is working.

### 9. Run Scraper Test

```bash
uv run python app/scripts/test_scraper.py
```

The script will launch `ListingScraper`, run the configured Home Depot flow, and use stored Telegram account details for alert delivery.

### 10. Common Setup Errors

`ModuleNotFoundError: No module named 'app'`

- Run from repo root and set `PYTHONPATH=.`.

`Website with domain 'homedepot.com' not found in database.`

- Run the `add_website.py` command above.

`settings.use_camoufox=true but camoufox is not installed`

- Run `uv sync` and `uv run python -m camoufox fetch`.

Scraper starts but does nothing

- Add at least one keyword with `add_keyword.py` or `add_keyword_from_txt.py`.

### 11. Configuring Zip Codes

To scrape across multiple store locations, add a `zip_codes` list to the `search_module` section of the domain YAML and mark the zip code input action with `zip_code_input: true`:

```yaml
search_module:
  zip_codes:
    - "28546"
    - "90210"
  actions_before_search:
    - name: input_action
      selector: '[data-testid="zip-code-text-field"] input'
      zip_code_input: true
      submit: false
      loading_delay: 2
```

The scraper will run the full keyword search once per zip code. See `docs/setup_guide.md` for full details.

# Actor input Schema

## `zip_codes` (type: `array`):

List of ZIP codes to monitor (e.g., 28546, 90210)

## `store` (type: `string`):

Which store to scrape

## `keywords` (type: `array`):

Search keywords to find products

## Actor input object example

```json
{
  "zip_codes": [
    "28546"
  ],
  "store": "homedepot.com",
  "keywords": [
    "screwdriver",
    "drill",
    "generator",
    "grill"
  ]
}
```

# API

You can run this Actor programmatically using our API. Below are code examples in JavaScript, Python, and CLI, as well as the OpenAPI specification and MCP server setup.

## JavaScript example

```javascript
import { ApifyClient } from 'apify-client';

// Initialize the ApifyClient with your Apify API token
// Replace the '<YOUR_API_TOKEN>' with your token
const client = new ApifyClient({
    token: '<YOUR_API_TOKEN>',
});

// Prepare Actor input
const input = {
    "zip_codes": [
        "28546"
    ],
    "keywords": [
        "screwdriver",
        "drill",
        "generator",
        "grill"
    ]
};

// Run the Actor and wait for it to finish
const run = await client.actor("pulsewatch/dealwatch-scraper").call(input);

// Fetch and print Actor results from the run's dataset (if any)
console.log('Results from dataset');
console.log(`💾 Check your data here: https://console.apify.com/storage/datasets/${run.defaultDatasetId}`);
const { items } = await client.dataset(run.defaultDatasetId).listItems();
items.forEach((item) => {
    console.dir(item);
});

// 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/js/docs

```

## Python example

```python
from apify_client import ApifyClient

# Initialize the ApifyClient with your Apify API token
# Replace '<YOUR_API_TOKEN>' with your token.
client = ApifyClient("<YOUR_API_TOKEN>")

# Prepare the Actor input
run_input = {
    "zip_codes": ["28546"],
    "keywords": [
        "screwdriver",
        "drill",
        "generator",
        "grill",
    ],
}

# Run the Actor and wait for it to finish
run = client.actor("pulsewatch/dealwatch-scraper").call(run_input=run_input)

# Fetch and print Actor results from the run's dataset (if there are any)
print("💾 Check your data here: https://console.apify.com/storage/datasets/" + run["defaultDatasetId"])
for item in client.dataset(run["defaultDatasetId"]).iterate_items():
    print(item)

# 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/python/docs/quick-start

```

## CLI example

```bash
echo '{
  "zip_codes": [
    "28546"
  ],
  "keywords": [
    "screwdriver",
    "drill",
    "generator",
    "grill"
  ]
}' |
apify call pulsewatch/dealwatch-scraper --silent --output-dataset

```

## MCP server setup

```json
{
    "mcpServers": {
        "apify": {
            "command": "npx",
            "args": [
                "mcp-remote",
                "https://mcp.apify.com/?tools=pulsewatch/dealwatch-scraper",
                "--header",
                "Authorization: Bearer <YOUR_API_TOKEN>"
            ]
        }
    }
}

```

## OpenAPI specification

```json
{
    "openapi": "3.0.1",
    "info": {
        "title": "Home Depot & Lowe's Price Tracker with Penny Detection",
        "description": "Real-time price monitoring for Home Depot and Lowe's. Detects 30-90% off clearance, penny items (.02/.03 → .01), and inventory drops. Multi-ZIP support. Outputs clean JSON with product details, prices, discounts, and stock status.",
        "version": "1.0",
        "x-build-id": "J92icGv6gdvsTisqx"
    },
    "servers": [
        {
            "url": "https://api.apify.com/v2"
        }
    ],
    "paths": {
        "/acts/pulsewatch~dealwatch-scraper/run-sync-get-dataset-items": {
            "post": {
                "operationId": "run-sync-get-dataset-items-pulsewatch-dealwatch-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/pulsewatch~dealwatch-scraper/runs": {
            "post": {
                "operationId": "runs-sync-pulsewatch-dealwatch-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/pulsewatch~dealwatch-scraper/run-sync": {
            "post": {
                "operationId": "run-sync-pulsewatch-dealwatch-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",
                "required": [
                    "zip_codes"
                ],
                "properties": {
                    "zip_codes": {
                        "title": "ZIP Codes",
                        "type": "array",
                        "description": "List of ZIP codes to monitor (e.g., 28546, 90210)",
                        "items": {
                            "type": "string",
                            "pattern": "^[0-9]{5}$"
                        },
                        "default": [
                            "28546"
                        ]
                    },
                    "store": {
                        "title": "Store",
                        "enum": [
                            "homedepot.com",
                            "lowes.com"
                        ],
                        "type": "string",
                        "description": "Which store to scrape",
                        "default": "homedepot.com"
                    },
                    "keywords": {
                        "title": "Keywords",
                        "type": "array",
                        "description": "Search keywords to find products",
                        "items": {
                            "type": "string"
                        },
                        "default": [
                            "screwdriver",
                            "drill",
                            "generator",
                            "grill"
                        ]
                    }
                }
            },
            "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
                                    }
                                }
                            },
                            "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
                                    }
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}
```