# Home Depot API

> Home Depot categories, products, prices, product details and variants (unverified)

- Vendor: `homedepotapi` · version 1.0 · category E-commerce · tags home depot api, home depot product api, home improvement api, hardware store api, home depot price api, home depot inventory api
- Datasource: custom HTTP routes
- Marketplace page: https://apiclay.com/api/homedepotapi
- This document: https://apiclay.com/docs/homedepotapi.md
- OpenAPI 3.1: https://apiclay.com/api/homedepotapi/openapi.json
- MCP: connect https://api.apiclay.com/v1/mcp (see https://apiclay.com/llms.txt), then `apiclay_describe_api` with vendor `homedepotapi`
- Updated: 2026-11-18

## About

## Home Depot API

Home Depot's navigation menu and category levels, category product listings with store prices and fulfillment, product details, and the variant item ids of a product.

Data comes from **homedepot.com** (https://www.homedepot.com). Every route below calls the site's own endpoint directly and returns the upstream response unchanged.

Typical flow: `/menus` -&gt; `/categories` -&gt; `/products` -&gt; `/product` -&gt; `/variants`

Stores are Home Depot store numbers (e.g. `2813`, Eagan MN, zip `55121`), as in a store page URL `/l/////`.

### Routes

#### POST `/menus` - Menus (top navigation)
The top-level shopping departments.

No parameters.

Returns (fields the source code reads; not yet verified live):
- `data.headers.level.primaryNavigation[]`: `id` (category id), `title`, `link`, `icon` / `previewImage`, `level`

#### POST `/categories` - Categories (navigation level)
The children of a navigation node.

| Param | In | Type | Required | Description |
|---|---|---|---|---|
| variables.id | body (JSON) | string | yes | Category id from `/menus` or a previous `/categories`, e.g. `4LnjbM4InXNfHjmkuKLnUw` (Tools). |
| variables.componentClass | body (JSON) | string | yes | `PrimaryNavigationL`, where n is the depth of the category, e.g. `PrimaryNavigationL1`. |

Returns (fields the source code reads; not yet verified live):
- `data.headers.level.primaryNavigation[]`: `id`, `title`, `link` (the part after the last `-` is the `navParam` for `/products`), `level` (absent on leaf categories)

#### POST `/products` - Products (category listing)
One page of a category's products with store price and fulfillment.

| Param | In | Type | Required | Description |
|---|---|---|---|---|
| variables.navParam | body (JSON) | string | yes | Category nav id, e.g. `5yc1vZc3oc`. |
| variables.storeId | body (JSON) | string | yes | Store number, e.g. `2813`. |
| variables.additionalSearchParams | body (JSON) | object | yes | `{"deliveryZip": "55121", "multiStoreIds": []}`. |
| variables.pageSize | body (JSON) | number | yes | `24` times the page number. |
| variables.startIndex | body (JSON) | number | yes | `24` times (page - 1); up to 31 pages. |
| variables.storefilter | body (JSON) | string | yes | `ALL`, or `IN_STORE` for pickup. |
| variables.orderBy | body (JSON) | object | yes | `{"field": "TOP_SELLERS", "order": "ASC"}`. |
| variables.channel, filter, skip* | body (JSON) | mixed | yes | Send as in the sample: `channel` `DESKTOP`, `filter` `{}`, `skipInstallServices` false, `skipFavoriteCount` false, `skipDiscoveryZones` false, `skipBuyitagain` true. |
| x-current-url | header | string | no | `/b/N-`. |

Returns (fields the source code reads; not yet verified live):
- `data.searchModel.searchReport.totalProducts`: product count
- `data.searchModel.products[]`: `itemId`, `identifiers.productLabel`, `identifiers.storeSkuNumber`, `identifiers.canonicalUrl`, `pricing.value`, `media.images[0].url` (with ``) and `sizes`, `info.swatches`, `fulfillment.fulfillmentOptions[]` (`type` pickup/delivery, `services[].locations[].inventory.isInStock`)

#### POST `/product` - Product (product details, price and fulfillment)
One product at a store.

| Param | In | Type | Required | Description |
|---|---|---|---|---|
| variables.itemId | body (JSON) | string | yes | Item id from `/products` (`itemId`, also the last part of the product URL). |
| variables.storeId | body (JSON) | string | yes | Store number, e.g. `2813`. |
| variables.zipCode | body (JSON) | string | no | Zip code, e.g. `55121`. |
| variables.skip* | body (JSON) | boolean | yes | Send as in the sample: `skipSpecificationGroup` false, `skipFavoriteCount` false, `skipPaintDetails` true, `skipInstallServices` true, `skipKPF` false, `skipSubscribeAndSave` false. |

Returns (fields the source code reads; not yet verified live):
- `data.product.itemId`, `identifiers.productLabel`, `identifiers.parentId`, `identifiers.canonicalUrl`, `identifiers.storeSkuNumber`
- `data.product.pricing.value`, `pricing.original`
- `data.product.media.images[]`
- `data.product.fulfillment.anchorStoreStatusType`, `fulfillment.fulfillmentOptions[]` (pickup `bopis` locations with `inventory.quantity`, delivery and shipping services)

#### POST `/variants` - Variants (child item ids of a parent product)
The variant item ids of a parent product.

| Param | In | Type | Required | Description |
|---|---|---|---|---|
| variables.parentId | body (JSON) | string | yes | Parent id (`identifiers.parentId` from `/product`). |

Returns (fields the source code reads; not yet verified live):
- `data.metadata.childItemsLookup[].itemId`: variant item ids; get each one's price and stock with `/product`
- `data.metadata.attributes[]`: variant attributes and values

### Not yet available

| Endpoint | Why |
|---|---|
| store localization cookies | the code reads them from a store page together with the Akamai `bm_sz` cookie; anti-bot cookies are not used |

### Caveats

- These routes were written from MealMe's source code and have not been tested live yet (the site blocks plain requests from the test machine).
- The source site uses bot protection (Akamai); calls may be blocked until that is handled.
- Upstream calls change over time (embedded keys, field names). Verify responses before relying on them.
- Not affiliated with homedepot.com.

## Pricing

- Pay as you go: 0.0012 credits/request
- Trial: 1 free requests per buyer
- Billing order: trial requests -> subscribed plan requests -> pay as you go. 1 credit's USD value is shown on the marketplace page.

## HTTP routes

Only the public, buyer-facing parts of each route are listed; vendor-side credentials stay on the gateway.

### POST /menus — Menus (top navigation)
- Gateway: `POST https://api.apiclay.com/v1/api/homedepotapi/menus`
- Upstream proxy: ApiClay proxy paid by the vendor (data cap 2 MB per call). Fetched through an ApiClay proxy paid by the vendor; a response larger than the route's data cap fails with 502 and is refunded in full.

### POST /categories — Categories (navigation level)
- Gateway: `POST https://api.apiclay.com/v1/api/homedepotapi/categories`
- Body sample (JSON):

```json
{"variables": {"componentClass": "PrimaryNavigationL1", "id": "4LnjbM4InXNfHjmkuKLnUw"}}
```

- Upstream proxy: ApiClay proxy paid by the vendor (data cap 2 MB per call). Fetched through an ApiClay proxy paid by the vendor; a response larger than the route's data cap fails with 502 and is refunded in full.

### POST /products — Products (category listing)
- Gateway: `POST https://api.apiclay.com/v1/api/homedepotapi/products`
- Public headers: `x-current-url`
- Body sample (JSON):

```json
{"variables": {"skipInstallServices": false, "skipFavoriteCount": false, "storefilter": "ALL", "channel": "DESKTOP", "skipDiscoveryZones": false, "skipBuyitagain": true, "additionalSearchParams": {"deliveryZip": "55121", "multiStoreIds": []}, "filter": {}, "navParam": "5yc1vZc3oc", "orderBy": {"field": "TOP_SELLERS", "order": "ASC"}, "pageSize": 24, "startIndex": 0, "storeId": "2813"}}
```

- Upstream proxy: ApiClay proxy paid by the vendor (data cap 2 MB per call). Fetched through an ApiClay proxy paid by the vendor; a response larger than the route's data cap fails with 502 and is refunded in full.

### POST /product — Product (product details, price and fulfillment)
- Gateway: `POST https://api.apiclay.com/v1/api/homedepotapi/product`
- Body sample (JSON):

```json
{"variables": {"skipSpecificationGroup": false, "skipFavoriteCount": false, "skipPaintDetails": true, "skipInstallServices": true, "skipKPF": false, "skipSubscribeAndSave": false, "itemId": "205594063", "storeId": "2813", "zipCode": "55121"}}
```

- Upstream proxy: ApiClay proxy paid by the vendor (data cap 2 MB per call). Fetched through an ApiClay proxy paid by the vendor; a response larger than the route's data cap fails with 502 and is refunded in full.

### POST /variants — Variants (child item ids of a parent product)
- Gateway: `POST https://api.apiclay.com/v1/api/homedepotapi/variants`
- Body sample (JSON):

```json
{"variables": {"parentId": "205594063"}}
```

- Upstream proxy: ApiClay proxy paid by the vendor (data cap 2 MB per call). Fetched through an ApiClay proxy paid by the vendor; a response larger than the route's data cap fails with 502 and is refunded in full.

## Call example

```bash
curl -X POST "https://api.apiclay.com/v1/api/homedepotapi/menus" \
  -H "token: <YOUR_APICLAY_TOKEN>"
```

Index of every published API: https://apiclay.com/llms.txt
