# Home Depot Canada (`canadesk/homedepot`) Actor

Extract product listings, prices, and store availability from Home Depot Canada.

- **URL**: https://apify.com/canadesk/homedepot.md
- **Developed by:** [Canadesk Support](https://apify.com/canadesk) (community)
- **Stats:** 2 total users, 1 monthly users, 100.0% runs succeeded, 0 bookmarks
- **User rating**: No ratings yet

## Pricing

Pay per event

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/actors/running/actors-in-store.md#pay-per-event

## What's an Apify Actor?

An Actor is a serverless cloud program that runs on the Apify platform. It has two run modes.
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.

Apify vocabulary and the platform model are defined once, in the agent quickstart at https://apify.com/agents.md.

## 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.

Do not guess an integration path. Every one of them is in the agent quickstart at https://apify.com/agents.md: the Apify MCP server, Agent Skills with the Apify CLI, the JavaScript and Python clients, the REST API, and the account-free path for an agent with no human to sign in. It also carries the rule on stating cost before the first paid run.

For examples already wired to this Actor's own input schema, see the [API](#api) section below.

Each client library has reference documentation the quickstart does not restate: [JavaScript/TypeScript](https://docs.apify.com/api/client/js/docs.md) (`npm install apify-client`) and [Python](https://docs.apify.com/api/client/python/docs.md) (`pip install apify-client`).

# README

Collect products, prices and availability from **Home Depot Canada**. Search one keyword or a list, or look up multiple product codes for a selected store.

### Features

| **Feature** | **What you get** |
| :--- | :--- |
| Search products | Product names, models, brands, prices, ratings, images and available stock |
| Product lookup | Store-specific prices, inventory, aisle and bay information for product codes |
| Optional enrichment | Local availability and fulfillment details added to search results |

Product-code lookups return price and availability data; full descriptions, specifications and reviews may be unavailable. Prices and stock reflect the selected store.

### Pricing

Each valid run includes a shared minimum charge of 100 results. Missing rows are clearly marked placeholders and contain no source data.

Where listed in the Pricing tab, a handled lookup problem that prevents a run from returning any real results produces one clear error record and a single $0.02 unsuccessful-lookup fee, in addition to any listed start fee.

### Multiple inputs

Use `queries` or `productIds` to collect records from several inputs in one run. The 100-result minimum applies once to the whole run. `maxResults` is shared across the batch; use `maxResultsPerInput` to limit each input. Inputs are processed in order, and repeated records are returned once.

### Access

For runs on Apify, select a Canadian residential proxy. Proxy use is not enabled automatically. If enrichment is unavailable, the original search result is retained.

# Actor input Schema

## `mode` (type: `string`):

Search Home Depot Canada or look up a product's store buybox information by product code.

## `queries` (type: `array`):

Optional list of up to 100 inputs in one run. Replaces the single input and selects its corresponding operation. Use only one batch list.

## `query` (type: `string`):

Required in Search products mode. Use up to 120 characters.

## `productIds` (type: `array`):

Optional list of up to 100 inputs in one run. Replaces the single input and selects its corresponding operation. Use only one batch list.

## `productId` (type: `string`):

Required in Product lookup mode. Enter one 6 to 20 digit Home Depot Canada product code.

## `storeId` (type: `string`):

Store used for local prices, stock and aisle information. The default is store 7058.

## `maxResults` (type: `integer`):

Maximum real records across the entire run, shared by all inputs.

## `maxResultsPerInput` (type: `integer`):

Optional limit per batch input, within the run-wide Maximum results limit. Inputs are processed in order.

## `lang` (type: `string`):

Language sent to Home Depot Canada for product search and buybox data.

## `includeDetails` (type: `boolean`):

Request store-specific currency, inventory, aisle/bay and fulfillment information for each search result. A detail error is reported while preserving the search result.

## `pageSize` (type: `integer`):

Number of search products to request per page (1 to 40).

## `maxPages` (type: `integer`):

Maximum search pages to read. Product lookup uses one request regardless of this value.

## `proxy` (type: `object`):

The sample uses a Canadian residential proxy, which worked in our Apify checks. You can change this routing; direct cloud requests may be blocked.

## Actor input object example

```json
{
  "mode": "search",
  "query": "drill",
  "storeId": "7058",
  "maxResults": 3,
  "lang": "en",
  "includeDetails": true,
  "pageSize": 3,
  "maxPages": 1,
  "proxy": {
    "useApifyProxy": true,
    "apifyProxyGroups": [
      "RESIDENTIAL"
    ],
    "apifyProxyCountry": "CA"
  }
}
```

# Actor output Schema

## `results` (type: `string`):

No description

# 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 = {
    "mode": "search",
    "query": "drill",
    "storeId": "7058",
    "maxResults": 3,
    "includeDetails": true,
    "pageSize": 3,
    "maxPages": 1,
    "proxy": {
        "useApifyProxy": true,
        "apifyProxyGroups": [
            "RESIDENTIAL"
        ],
        "apifyProxyCountry": "CA"
    }
};

// Run the Actor and wait for it to finish
const run = await client.actor("canadesk/homedepot").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 = {
    "mode": "search",
    "query": "drill",
    "storeId": "7058",
    "maxResults": 3,
    "includeDetails": True,
    "pageSize": 3,
    "maxPages": 1,
    "proxy": {
        "useApifyProxy": True,
        "apifyProxyGroups": ["RESIDENTIAL"],
        "apifyProxyCountry": "CA",
    },
}

# Run the Actor and wait for it to finish
run = client.actor("canadesk/homedepot").call(run_input=run_input)

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

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

```

## CLI example

```bash
echo '{
  "mode": "search",
  "query": "drill",
  "storeId": "7058",
  "maxResults": 3,
  "includeDetails": true,
  "pageSize": 3,
  "maxPages": 1,
  "proxy": {
    "useApifyProxy": true,
    "apifyProxyGroups": [
      "RESIDENTIAL"
    ],
    "apifyProxyCountry": "CA"
  }
}' |
apify call canadesk/homedepot --silent --output-dataset

```

## MCP server setup

```json
{
    "mcpServers": {
        "apify": {
            "type": "http",
            "url": "https://mcp.apify.com/?tools=fetch-actor-details,canadesk/homedepot"
        }
    }
}
```

The hosted server signs you in with OAuth on first connect, so no API token belongs in this config. Clients without OAuth support can send an `Authorization: Bearer <APIFY_API_TOKEN>` header instead, using a token from API & Integrations in Apify Console (https://console.apify.com/settings/integrations).

## OpenAPI specification

Download the OpenAPI definition: https://api.apify.com/v2/actors/8rfRObB5fAqDVn8Qn/builds/k5FxS6b19UeaWGiNf/openapi.json