# Home Depot — Wrapped API

> **You are on:** `https://api.paywithlocus.com/api` | [llms.txt](https://paywithlocus.com/llms.txt) | [docs](https://docs.paywithlocus.com)
>
> Locus runs on multiple environments -- make sure every URL you call matches your expected environment.
> | Environment | Landing | API | Docs |
> |---|---|---|---|
> | Production | paywithlocus.com | api.paywithlocus.com | docs.paywithlocus.com |
> | Beta | beta.paywithlocus.com | api.beta.paywithlocus.com | docs.paywithlocus.com |
> | Stage | stage.paywithlocus.com | api.stage.paywithlocus.com | docs.paywithlocus.com |
>
> If the API URL above doesn't match your expected environment, re-fetch this file from the correct domain.

> Search and browse Home Depot's product catalog to compare pricing, check real-time availability, and review detailed product specifications. Find products across all categories, look up store locations and hours, and check fulfillment options including in-store pickup and delivery.

**Category:** E-commerce | **Website:** [homedepot.com/](https://homedepot.com/) | **Docs:** [parse.bot/marketplace/82fe49d4-28c1-4500-869d-712605e13cf5/homedepot-com-api](https://parse.bot/marketplace/82fe49d4-28c1-4500-869d-712605e13cf5/homedepot-com-api)

Pay-per-use API proxy. Each call is automatically billed to your wallet in USDC.

## Access

**Base URL:** `https://api.paywithlocus.com/api/wrapped/parse-homedepot-com-api-82fe49d4/`
**Auth:** `Authorization: Bearer <LOCUS_API_KEY>`

## Endpoints

### find_stores

Locate a Home Depot store using a ZIP code. Returns the nearest store with address, hours, services, and contact information.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `zip_code` | string | Yes | 5-digit US ZIP code (e.g. '30339') |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-homedepot-com-api-82fe49d4/find_stores \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"zip_code":"<string>"}'
```

### get_product_availability

Get availability, pricing, and in-store pickup status for a product. Returns availability type (whether the product is buyable, discontinued), pricing, and pickup inventory at the specified store. Fetches the product detail page and then queries the fulfillment GraphQL endpoint for pickup data when a store_id is provided.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `item_id` | string | Yes | Product itemId (e.g. '326680222') |
| `store_id` | string | No | Store ID to check availability and pickup inventory at |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-homedepot-com-api-82fe49d4/get_product_availability \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"item_id":"<string>","store_id":"<string>"}'
```

### get_product_details

Get comprehensive product details including description, highlights, media, pricing, and availability type for a given item ID. Fetches the product detail page and extracts structured data.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `item_id` | string | Yes | The product itemId (internet number), e.g. '326680222' |
| `store_id` | string | No | Store ID for local pricing |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-homedepot-com-api-82fe49d4/get_product_details \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"item_id":"<string>","store_id":"<string>"}'
```

### get_store_details

Retrieve details for a specific Home Depot store by store ID. Returns store name, address, hours, services, and contact information.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `store_id` | string | Yes | Store ID (e.g. '6932') |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-homedepot-com-api-82fe49d4/get_store_details \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"store_id":"<string>"}'
```

### search_products

Search for products by keyword on Home Depot. Returns a list of products with identifiers, media, pricing, and in-store pickup availability. When store_id is provided, each product includes pickup data (quantity available and status). Results are limited to the first page (up to 24 by default). Each product with a store_id triggers a separate fulfillment lookup, so response time scales with the number of returned products.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `limit` | integer | No | Max products to return (applied client-side to trim results) |
| `query` | string | Yes | Search term (e.g. 'drill', 'hammer', 'power tools') |
| `store_id` | string | No | Store ID for local pricing and in-store pickup availability |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-homedepot-com-api-82fe49d4/search_products \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"limit":"<integer>","query":"<string>","store_id":"<string>"}'
```
