# Home Depot Search API

> Search Home Depot products by keyword with price, brand, model number, rating, delivery and pickup availability, filters and pagination.

Source: https://www.sandbase.ai/apis/home-depot/search
API reference: https://www.sandbase.ai/apis/home-depot/search/docs

## Facts

- Provider: Home Depot
- Type: Data API
- Endpoint: `POST https://api.sandbase.ai/v1/api/home-depot/search`
- Price: $0.01 per call
- Free allowance: 100 calls per organization per UTC day, shared across eligible APIs
- Capabilities: api, home depot, ecommerce, product data
- Billing: pay per use from one SandBase balance; no provider account or subscription needed

## Call it

`POST https://api.sandbase.ai/v1/api/home-depot/search` with `Authorization: Bearer $SANDBASE_API_KEY` and the parameters as a JSON body.

| Parameter | Type | Required | Allowed values |
| --- | --- | --- | --- |
| `q` | string \| number \| boolean | yes |  |
| `ps` | string \| number \| boolean | no |  |
| `nao` | string \| number \| boolean | no |  |
| `page` | string \| number \| boolean | no |  |
| `sort` | any | no |  |
| `store` | string \| number \| boolean | no |  |
| `filter` | string \| number \| boolean | no |  |
| `minmax` | string \| number \| boolean | no |  |
| `country` | string \| number \| boolean | no |  |
| `hd_sort` | any | no |  |
| `pagesize` | string \| number \| boolean | no |  |
| `store_id` | string \| number \| boolean | no |  |
| `lowerbound` | string \| number \| boolean | no |  |
| `upperbound` | string \| number \| boolean | no |  |
| `delivery_zip` | string \| number \| boolean | no |  |
| `json_restrictor` | string \| number \| boolean | no |  |
| `hd_filter_tokens` | string \| number \| boolean | no |  |

## FAQ

### How do I use the Home Depot Search API?

Send a POST request to https://api.sandbase.ai/v1/api/home-depot/search with your SandBase API key in the Authorization header (Bearer) and the parameters as a JSON body. You can also try it in the Playground on this page without writing code.

### How much does the Home Depot Search API cost?

$0.01 per call. Every organization gets 100 free calls per UTC day, shared across eligible SandBase APIs including this one; after that each call is billed at this price from your SandBase balance. There is no subscription.

### What parameters does the Home Depot Search API accept?

Required: q (string | number | boolean). Optional: ps (string | number | boolean), nao (string | number | boolean), page (string | number | boolean), sort (any), store (string | number | boolean) and filter (string | number | boolean) and 10 more. The Parameters table and the Playground on this page list every field.

### What does the Home Depot Search API return?

A JSON result. This endpoint runs asynchronously, so the response tells you how to fetch the finished result.

### Do I need a Home Depot developer account or API key?

No. Home Depot Search runs through SandBase, so one SandBase API key covers this endpoint and every other API and model in the catalog. You do not need to apply for Home Depot API access separately.

## README

### Home Depot Search

Search Home Depot products by keyword with price, brand, model number, rating, delivery and pickup availability, filters and pagination.

#### Request

```bash
curl -X POST "https://api.sandbase.ai/v1/run" \
  -H "Authorization: Bearer $SANDBASE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"model": "home-depot/search", "q": "cordless drill"}'
```

This API runs asynchronously. `/v1/run` returns a task `id` with status `pending`; poll `GET https://api.sandbase.ai/v1/run/{id}` until `status` is `completed` and read the result from `outputs[0].data`.

#### Parameters

| Name | Type | Required | Description |
|---|---|---|---|
| `q` | string/number/boolean | Yes | The search query. You can use anything that you would use in a regular The Home Depot search. |
| `country` | string/number/boolean | No | The country to use for the Home Depot search. Only United States(`us`), and Canada(`ca`) are supported. |
| `delivery_zip` | string/number/boolean | No | ZIP Postal code. To filter the shipping products by a selected area. |
| `filter` | string/number/boolean | No | Used to pass filter tokens divided by dash (-) in Home Depot Canada. Filter tokens can be obtained from API response |
| `hd_filter_tokens` | string/number/boolean | No | Used to pass filter tokens divided by comma. Filter tokens can be obtained from API response |
| `hd_sort` | any | No | Results sorted by different options in Home Depot US. It can be set to: `top_sellers`: Top Sellers, `price_low_to_high`: Price Low to High, `price_high_to_low`: Price High to Low, `top_rated`: Top Rat… |
| `json_restrictor` | string/number/boolean | No | The fields you want to include in the output, reducing payload size for faster response. See the JSON Restrictor documentation for more details. |
| `lowerbound` | string/number/boolean | No | Defines lower bound for price in USD. |
| `minmax` | string/number/boolean | No | Defines lower and upper bound for price in CAD. Parameter is only used in the Home Depot Canada. Example: `price:[100 TO 500]`(Between $100 to $500) Example: `price:[100 TO *]`(Minimum $100) Example: … |
| `nao` | string/number/boolean | No | Defines offset for products result. A single page contains 24 products. First page offset is 0, second -> 24, third -> 48 and so on. |
| `page` | string/number/boolean | No | Value is used to get the items on a specific page. (e.g., `1` (default) is the first page of results, `2` is the 2nd page of results, `3` is the 3rd page of results, etc.). This parameter is common fo… |
| `pagesize` | string/number/boolean | No | Determines the number of items per page in the Home Depot Canada. By default, the Home Depot Canada returns `40` (maximum allowed value) results. |
| `ps` | string/number/boolean | No | Determines the number of items per page. There are scenarios where The Home Depot overrides the `ps` value. By default, The Home Depot returns `24` (maximum allowed value) results. |
| `sort` | any | No | Results sorted by different options in Home Depot Canada. It can be set to: `price-asc`: Price Low to High, `price-desc`: Price High to Low, `reviewAvgRating`: Top Rated, `relevance`: Recommended (Def… |
| `store` | string/number/boolean | No | Store ID to filter the products by the specific store only in Home Depot Canada. The default store is Gatineau (`7140`). See all Home Depot Canada stores |
| `store_id` | string/number/boolean | No | Store ID to filter the products by the specific store only. See all Home Depot stores |
| `upperbound` | string/number/boolean | No | Defines upper bound for price in USD. |

#### Pricing

Flat price per call. Failed calls are not charged.