# Home Depot API — Products & Nearby Stores (`gauravlabs/homedepot-api`) Actor

Collect Home Depot product information for a selected store and ZIP code, or find nearby stores. Export structured product data with explicit missing-field warnings.

- **URL**: https://apify.com/gauravlabs/homedepot-api.md
- **Developed by:** [Gaurav Kumar Choudhary](https://apify.com/gauravlabs) (community)
- **Categories:** E-commerce, Developer tools
- **Stats:** 2 total users, 1 monthly users, 100.0% runs succeeded, 0 bookmarks
- **User rating**: No ratings yet

## Pricing

from $2.00 / 1,000 successful product extractions

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

## Home Depot API — Products & Nearby Stores

### At a glance

- Collect: Product page metadata or nearby-store lookup, selected with mode.
- Input: use the runnable example below or the prefilled Input form.
- Output: the default dataset supports JSON/CSV/Excel export; see output modes below.
- Billing: $2 per 1,000 successful products or validated store lookups. A store lookup is not charged per returned store. No startup fee. Platform usage may be additional.
- Limits: No keyword search, full review extraction or verified stock quantities; inspect pricing-store warnings.

Collect product information for a selected Home Depot store and ZIP code, or find stores near a ZIP code or coordinates. Built for catalogue enrichment, product research and localized page comparisons.

### Product input

```json
{"mode":"products","products":["330625530"],"storeId":"2414","zipcode":"04401","maxItems":20}
```

Supply 9-digit Internet item IDs or full HTTPS product URLs. Duplicates are removed before fetching. Use stores mode to find store numbers. ZIP codes are strings so leading zeros are preserved.

### Nearby stores

```json
{"mode":"stores","zipcode":"04401","maxItems":20}
```

Alternatively omit zipcode and provide `latitude` and `longitude`. A valid lookup with no nearby stores returns an empty dataset and a successful summary.

### Results

Product rows include item ID, title, brand, model number, description, price, currency, rating, review count, images, page-level availability, store/ZIP context, timestamp and warnings. When embedded catalogue data is present, rows also include original price, UPC, store SKU and categories. `priceStoreId` and `priceStoreMatchesRequested` disclose embedded pricing context when detectable. Missing fields are null, never fabricated zeros. Store rows include ID, name, phone, distance in miles, address and coordinates when available.

Export the default dataset as JSON, CSV or Excel. The `SUMMARY` key-value record reports completed requests, result count, per-item failures and budget stops. Partial batches preserve earlier results.

### Important limitations

This version supports product pages and nearby-store lookup, not keyword search, category crawling, individual review records or verified inventory counts. Prices and availability are extracted from structured page metadata. Some data loads dynamically and may be absent. A store-localized session does not prove every field in page metadata is store-specific; use the warnings and verify critical purchasing decisions independently.

### Billing

Pricing: **$2 per 1,000 successful product requests** and **$2 per 1,000 store lookups**, with no run-start fee or monthly rental. Check the live Pricing tab for the current price and applicable platform terms.

Billing units: `product-request` (one successfully parsed product, even if optional fields are missing) and `store-lookup` (one validated lookup, even when empty, regardless of returned store count). Invalid input and parse failures do not produce billable events.

### Support

Open an issue with the run ID and expected result, without API tokens or sensitive data. For custom use cases and integration projects, contact the developer using their profile contact details.

Independent tool; not affiliated with or endorsed by The Home Depot.

### Minimal API example

Store your own Apify token in `APIFY_TOKEN`; never paste it into public input or code. This example uses the same small input as the prefilled form.

```python
import os
import requests

response = requests.post(
    "https://api.apify.com/v2/acts/gauravlabs~homedepot-api/run-sync-get-dataset-items",
    headers={"Authorization": "Bearer " + os.environ["APIFY_TOKEN"]},
    json={"products":["330625530"],"storeId":"2414","zipcode":"04401"},
    timeout=300,
)
response.raise_for_status()
print(response.json())
```

For large batches, start an asynchronous run with `/runs`, wait for its final status, and retrieve its default dataset. HTTP success when starting a run does not prove the extraction succeeded.

#### Minimal output shape (illustrative)

The following shows one documented field, not a fresh result or a promised yield. Inspect the output reference above for the complete schema.

```json
{
  "priceStoreMatchesRequested": null
}
```

### Practical workflow and accuracy notes

For price monitoring, use a fixed product/store/ZIP input and schedule repeated runs. Join snapshots by itemId plus requested store context. Check `priceStoreMatchesRequested`, `priceStoreId` and warnings before treating a price as store-local. Null means unknown, not a match or zero price.

# Actor input Schema

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

Products requires storeId and zipcode. Stores accepts a ZIP code or coordinates.

## `products` (type: `array`):

9-digit Internet item IDs or https://www.homedepot.com/p/.../ID URLs. Duplicate products are removed.

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

Required for products. Use stores mode to find a store number.

## `zipcode` (type: `string`):

Five-digit US ZIP code. Preserve leading zeros.

## `latitude` (type: `number`):

Latitude from -90 to 90. Use with longitude when no ZIP code is supplied.

## `longitude` (type: `number`):

Longitude from -180 to 180. Use with latitude when no ZIP code is supplied.

## `maxItems` (type: `integer`):

Maximum number of unique products to fetch or stores to return.

## Actor input object example

```json
{
  "mode": "products",
  "products": [
    "330625530"
  ],
  "storeId": "2414",
  "zipcode": "04401",
  "maxItems": 20
}
```

# Actor output Schema

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

No description

## `summary` (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 = {
    "products": [
        "330625530"
    ],
    "storeId": "2414",
    "zipcode": "04401"
};

// Run the Actor and wait for it to finish
const run = await client.actor("gauravlabs/homedepot-api").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 = {
    "products": ["330625530"],
    "storeId": "2414",
    "zipcode": "04401",
}

# Run the Actor and wait for it to finish
run = client.actor("gauravlabs/homedepot-api").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 '{
  "products": [
    "330625530"
  ],
  "storeId": "2414",
  "zipcode": "04401"
}' |
apify call gauravlabs/homedepot-api --silent --output-dataset

```

## MCP server setup

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

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/bSnvVS44eVFhFYNfL/builds/zLxeXmIbmzCtzkCr2/openapi.json