# Home Depot Product and Price Lookup (`maplerope44/home-depot-product-lookup`) Actor Look up real-time Home Depot product information by product ID and ZIP code. Returns price, sale and bulk pricing, availability, product details, and a link/image, plus key information about the nearest Home Depot store. Results are returned as structured JSON. - **URL**: https://apify.com/maplerope44/home-depot-product-lookup.md - **Developed by:** [Maple Rope](https://apify.com/maplerope44) (community) - **Categories:** E-commerce, Integrations, Automation - **Stats:** 348 total users, 34 monthly users, 100.0% runs succeeded, 6 bookmarks - **User rating**: 5.00 out of 5 stars ## Pricing $5.00 / 1,000 products 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 ## Overview The **Home Depot Product Lookup API** retrieves real-time product pricing, availability, inventory, and product details using a Home Depot product ID and ZIP code. Each lookup returns the product information and the nearest Home Depot store for the supplied ZIP code, including store details, price, sale price, bulk pricing, available quantity, description, product URL, and image URL. ### When to Use This Actor Use this Actor when you have a **Home Depot product ID** and a **ZIP code** and need current information such as: - Home Depot product price - Sale price or bulk pricing - Product availability or inventory quantity - Product details and description - Product URL or image - Nearest Home Depot store information - Store distance, address, phone number, or hours Each lookup returns data for **one product at one nearest Home Depot store**. #### Example Use Cases This Actor can be used for requests such as: - "What is the current price of Home Depot product 311335459 near ZIP 10918?" - "Is Home Depot product 313383605 in stock near 10918?" - "How much does this Home Depot product cost at my nearest store?" - "Get the current Home Depot price and availability for this product ID." - "Check the availability and price of this Home Depot product near me." - "Get the product details and nearest store information for Home Depot product 311335459." ## Free Users Free users are limited to a maximum of 10 lookups per day and up to 100 lookups per month. Please reach out if you need additional requests to validate your use case. ## Key Features - **Real-Time Data:** Get current Home Depot product pricing and availability. - **ZIP-Based Lookup:** Find product information for the nearest Home Depot store to a ZIP code. - **Product Details:** Get pricing, inventory, description, URL, image, and other product information. - **Structured JSON:** Results are returned as structured JSON for easy use in applications, automation, and AI agents. ## Input Schema **IMPORTANT** Runtime may vary significantly depending on caching. Set the timeout to at least **180s** to prevent Apify from timing out the request before a response is returned. | Parameter | Type | Required | Description | | ------------- | ------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------- | | `zip` | string | yes | The ZIP code used to determine the nearest Home Depot store for the lookup. | | `productId` | string | yes | The Home Depot product ID to look up. | | `noWait` | boolean | no | If `true`, the lookup is processed asynchronously and an `asyncId` is returned immediately. | | `callback` | string | no | If set, an `asyncId` is returned immediately and the results will be provided via the callback. Note that this has an **increased** cost for the run. | | `bypassCache` | boolean | no | **COMING SOON:** If `true`, the request will ignore all caches to ensure a fresh capture of all data. Note that this has an **increased** cost for the run. | If the lookup completes quickly, the product details are returned directly in the response. ### Asynchronous Lookup Some lookups may take longer to complete. Asynchronous processing allows the lookup to continue while the result is retrieved separately. An `asyncId` can be returned when: - `noWait` is `true` - `callback` is set - The initial lookup takes too long to complete The `asyncId` is used to check the lookup status and retrieve the final result. | Parameter | Type | Required | Description | | --------- | ------ | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | | `asyncId` | string | yes | An ID obtained from a previous lookup request when the lookup is being processed asynchronously. Use this to check the status and retrieve the results. | #### Async Status Codes A request using an `asyncId` returns one of the following states: **202 - Queued** The lookup has not started yet. ```json { "asyncId": "abcd-1234-efgh-5678", "status": 202 } ``` **206 - In Progress** The lookup is currently being processed. ```json { "asyncId": "abcd-1234-efgh-5678", "status": 206 } ``` **200 - Complete** The lookup has completed. The normal product lookup response is returned. This asynchronous workflow applies when the initial lookup times out, `noWait` is `true`, or `callback` is set. ## Output Schema ### Successful Product Lookup Response A completed lookup returns the product and nearest store information. ```json { "status": 200, "stores": { "STORE_ID": { "id": "string", "name": "string", "address": "string", "city": "string", "state": "string", "zip": "string", "phone": "string", "distance": "number", "hours": { "mon": { "open": "string", "close": "string" }, "tue": { "open": "string", "close": "string" }, "wed": { "open": "string", "close": "string" }, "thu": { "open": "string", "close": "string" }, "fri": { "open": "string", "close": "string" }, "sat": { "open": "string", "close": "string" }, "sun": { "open": "string", "close": "string" } }, "products": { "PRODUCT_ID": { "name": "string", "description": "string", "url": "string", "imageUrl": "string", "quantityAvailable": "number", "priceCentsPerUnit": "number", "salePriceCentsPerUnit": "number", "bulkQuantityRequired": "number", "bulkPriceCentsPerUnit": "number" } } } } } ``` ### Error Responses If the lookup cannot be completed, one of the following status codes will be returned. #### 422 - Lookup Cannot Be Completed ```json { "status": 422 } ``` A **422** is returned when the lookup cannot be completed due to an external reason, such as an invalid product ID. The request should **not** be retried. If you believe a request was incorrectly rejected, please contact support. #### 429 - Rate Limited ```json { "status": 429 } ``` A **429** is returned when the system is under pressure and requests are being rate limited. The request should be retried at a later time. #### 500 - Unexpected Error ```json { "status": 500 } ``` A **500** is returned when an unexpected error occurs in the system. #### 504 - Request Timed Out ```json { "status": 504 } ``` A **504** is returned when the request times out after exceeding the allowed time limit. ## Support For issues or assistance, contact support via Apify or email [**help@maplerope.com**](mailto:help@maplerope.com). # Actor input Schema ## `zip` (type: `string`): The zip code to lookup ## `productId` (type: `string`): The Product Id from the Home Depot website for an item. This is the number at the last part of the URL. ## `noWait` (type: `boolean`): If true, the actor will return an AsyncId result that can be used to query for the results at a later time. If false, the actor will wait for the results to be available. If the results are not available within a preconfigured timeout, the AsyncId will be returned. ## `callback` (type: `string`): If set, the actor will return an AsyncId result immediately and the callback will be invoked as a POST with the results (on success or on failure). Note that this has an **increased** cost for the run. ## `asyncId` (type: `string`): Set to the asyncId returned from a previous run to obtain the results. If set, zip and productId should not be set. ## `bypassCache` (type: `boolean`): If true, the actor will bypass the cache. Note that this has an **increased** cost for the run. ## Actor input object example ```json { "zip": "10918", "productId": "312528776" } ``` # Actor output Schema ## `status` (type: `string`): HTTP-style status code for the lookup. 200 means complete, 202 means queued, 206 means in progress, 422 means the lookup cannot be completed, 429 means rate limited, and 500 means an unexpected error. ## `asyncId` (type: `string`): Async lookup ID. Present when the lookup is queued or in progress. Use this ID to retrieve the result. ## `stores` (type: `string`): Home Depot store and product data returned by a completed lookup. # 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 '' with your token const client = new ApifyClient({ token: '', }); // Prepare Actor input const input = { "zip": "10918", "productId": "312528776", "noWait": false, "callback": "" }; // Run the Actor and wait for it to finish const run = await client.actor("maplerope44/home-depot-product-lookup").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 '' with your token. client = ApifyClient("") # Prepare the Actor input run_input = { "zip": "10918", "productId": "312528776", "noWait": False, "callback": "", } # Run the Actor and wait for it to finish run = client.actor("maplerope44/home-depot-product-lookup").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 '{ "zip": "10918", "productId": "312528776", "noWait": false, "callback": "" }' | apify call maplerope44/home-depot-product-lookup --silent --output-dataset ``` ## MCP server setup ```json { "mcpServers": { "apify": { "type": "http", "url": "https://mcp.apify.com/?tools=fetch-actor-details,maplerope44/home-depot-product-lookup" } } } ``` 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 ` 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/ZTiwr7yONboKCKPbK/builds/hjWlTySQkO8RWw4Zc/openapi.json