# Home Depot Search API (https://www.socialcrawl.dev/platforms/home_depot/search)

> Returns Home Depot products matching a keyword, 24 per page, each with its item id, title, brand, model number, current and original price, star rating, review count, image gallery, stock status, and department. Feed a returned item id into GET /v1/home_depot/product for full detail including per-store shelf counts, or GET /v1/home_depot/reviews for the review text. Pass store_id to localise stock: each row's product.ext.store_inventory then lists that store with is_selected_store true, and availability reflects whether any fulfilment path has the item in stock. Get a store id from GET /v1/home_depot/stores. Prices are Home Depot's online price and did not vary by store in any comparison we have run, so in-store-only shelf markdowns are not in this data. A markdown Home Depot publishes online appears under product.ext.promotion with its label (Clearance or Special Buys), amount_off and percent_off, and price.original is the price before that markdown. A null price.current comes with product.ext.price_note, for example see final price in cart. This is also the keyword-to-item-id resolver for the rest of the Home Depot API. It takes no sort or filter parameters and rejects them rather than ignoring them, so filter and sort on the returned rows. total is the real match count and holds steady across pages; paginate on has_more, capped at 30 pages.

TL;DR: `GET /v1/home_depot/search` costs 5 credits per call and returns SocialCrawl's unified JSON schema. Single x-api-key auth, 100 free credits on signup.

## Parameters

| Parameter | Required | Description |
| --- | --- | --- |
| `query` | yes | Free-text product search, for example drill or cordless impact driver. |
| `page` | no | Page number, 1 to 30. Prefer the universal cursor parameter. |
| `store_id` | no | Home Depot store number used to localise stock and pickup availability, for example 0723. Prices are Home Depot's online price and do not change with the store. Pass the id exactly as GET /v1/home_depot/stores returns it; rows echo it without the leading zero on search (723). |
| `max_pages` | no | 1 to 50 (default 1, or 50 when `max_items` or `max_credits` is sent). Walk up to this many pages in one call and return the rows from all of them. Each page walked is billed exactly as one call to this endpoint (a cached page is free) and counts against your rate limit; its charge and any refund are recorded under the page's own request id, listed in `data.walk.request_ids`. The walk stops early at the last page, or when the request's time budget runs low; `data.walk.stopped` says why (`end`, `max_pages`, `max_items`, `max_credits`, `time_budget`, `page_error`) and `pagination.next_cursor` continues from where it stopped. |
| `max_items` | no | 1 to 5000. Get more in one call: keep walking pages until the response holds at least this many rows, then stop with `data.walk.stopped: "max_items"`. The last page is returned whole (it was billed), so `data.items` can hold up to one page more than this, and `pagination.next_cursor` resumes right after it without skipping a row. Walks up to 50 pages unless `max_pages` says fewer; each page is billed as one call (a cached page is free). Add `max_credits` to cap the spend. A long walk can stop on the time budget first (`"time_budget"`): send the returned cursor with the same params to continue. |
| `max_credits` | no | 1 to 100000. The most this call may spend, across every page it walks. A page starts only while the credits already spent plus that page's price (or, when higher, the most any page of this walk has cost) still fit, so the call never goes past it; the walk then stops with `data.walk.stopped: "max_credits"` and the cursor to resume. Sent alone, it walks as far as the budget goes (up to 50 pages). A value below the price of one page is a free 400 whose `error.details.page_credits` names that price. Credits a row join (`include=`) adds are known only once a page has run, so page 1 is checked against its own price. |

## Code example

```bash
curl -G "https://www.socialcrawl.dev/v1/home_depot/search" \
  --data-urlencode "query=drill" \
  -H "x-api-key: sc_YOUR_API_KEY"
```

## FAQ

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

Returns Home Depot products matching a keyword, 24 per page, each with item id, title, brand, model number, price, rating, review count, images, and stock status. The response uses the same JSON envelope as every SocialCrawl endpoint, with the data, credits_used and request_id fields.

### When should I use the Home Depot Search endpoint?

Use it to turn a keyword into item ids. Pass store_id when the price and stock have to match one store; get that id from the stores endpoint.

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

Each call costs 5 credits, so the 100 free credits every new account gets cover 20 calls. Credits for failed or empty calls are refunded automatically, and there is no subscription.

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

The one required parameter is query (free-text product search, for example drill or cordless impact driver). It also accepts 5 optional parameters, all listed on this page.

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

Send a GET request to https://www.socialcrawl.dev/v1/home_depot/search?query=drill with your API key in the x-api-key header. An Authorization: Bearer header works too.

See the full Home Depot API: https://www.socialcrawl.dev/platforms/home_depot

## Pricing

- Standard endpoints: 1 credit per call
- Advanced endpoints: 5 credits per call
- Premium endpoints: 10 credits per call
- 100 free credits on signup, no credit card required. Cached responses cost 0 credits. Credit packs never expire.
- Full pricing: https://www.socialcrawl.dev/pricing

## Explore with AI

Questions this API answers, phrased for an AI assistant:

- What does the SocialCrawl Home Depot Search API return?
- How do I get Home Depot Search data with the SocialCrawl API?