Home Depot search
One page of Home Depot products for a query or a category.
/v1/homedepot/searchEach row has the item_id (feed it to /v1/homedepot/product or /v1/homedepot/stock), title, brand, model, store SKU, link, price, was-price, discount, clearance price, special-buy flag, rating, review count, image, and whether pickup and delivery are offered. Give store_id for that store's prices. A search Home Depot sends to a category is followed there (search_information.redirected_to). An empty page is not billed; a failed call is 503 with Retry-After and is not billed.
Request
https://api.scrapercompany.com/v1/homedepot/searchAuthenticate with your API key in the x-api-key header (see Authentication).
Run this request on your own API key from this page, with the values you type. Signed out? Sign in or get an API key.
Body
JSON object. Unknown fields are rejected with 422.
- query string | null min length 1, max length 120
What to search for, as typed in Home Depot's search box: 'cordless drill', 'hammer', '2x4 lumber'.
- category string | null max length 500
A Home Depot category link (https://www.homedepot.com/b/Appliances-Refrigerators/N-5yc1vZc3pi) or its N- code.
- store_id string | null pattern ^\d{1,4}$
Home Depot store number for store prices (from POST /v1/homedepot/stores), e.g. '6175'.
- zip_code string | null pattern ^\d{5}(?:-\d{4})?$
US ZIP code for delivery availability, e.g. '10001'.
- page integer default
1min 1, max 84Result page.
- page_size integer default
24min 1, max 48Products per page (1-48).
Example request
curl -X POST "https://api.scrapercompany.com/v1/homedepot/search" \
-H "x-api-key: $SCRAPERCOMPANY_API_KEY" \
-H "Content-Type: application/json" \
-d '{}'Response
200 — Home Depot products for a search (followed to its category). Metered responses carry x-credits-charged and x-credits-remaining headers (see credit headers).
{
"search_parameters": {
"engine": "homedepot_search",
"query": "hammer",
"store_id": "6175",
"zip_code": "10010",
"page": 1,
"page_size": 24
},
"search_information": {
"total_results": 524,
"keyword": "hammer",
"category": "5yc1vZc98g",
"redirected_to": "https://www.homedepot.com/b/Tools-Hand-Tools-Hammers/N-5yc1vZc98g?NCNI-5",
"page": 1,
"page_size": 24,
"results_on_page": 24,
"has_more": true,
"time_taken_s": 1.41
},
"products": [
{
"item_id": "342864434",
"title": "23 oz. Milled Face Hickory Handle Framing Hammer",
"brand": "Milwaukee",
"model": "48-22-9418",
"store_sku": "1016077058",
"url": "https://www.homedepot.com/p/Milwaukee-23-oz-Milled-Face-Hickory-Handle-Framing-Hammer-48-22-9418/342864434",
"price": 35.97,
"original_price": 35.97,
"discount_amount": 0,
"discount_percent": 0,
"special_buy": false,
"unit": "each",
"rating": 4.86,
"review_count": 29,
"image": "https://images.thdstatic.com/productImages/49e5cc54-5a98-4f88-ab30-ff169c05f870/svn/milwaukee-framing-hammers-48-22-9418-64_1000.jpg",
"discontinued": false,
"availability": {
"pickup": true,
"delivery": true
}
},
{
"item_id": "342864451",
"title": "16 oz. Smooth Face Hickory Handle Hammer",
"brand": "Milwaukee",
"model": "48-22-9517",
"store_sku": "1016077063",
"url": "https://www.homedepot.com/p/Milwaukee-16-oz-Smooth-Face-Hickory-Handle-Hammer-48-22-9517/342864451",
"price": 26.97,
"original_price": 26.97,
"discount_amount": 0,
"discount_percent": 0,
"special_buy": false,
"unit": "each",
"rating": 4.9,
"review_count": 10,
"image": "https://images.thdstatic.com/productImages/8e134d21-a5df-4b67-aef9-e8ac39d3354f/svn/milwaukee-framing-hammers-48-22-9517-64_1000.jpg",
"discontinued": false,
"availability": {
"pickup": true,
"delivery": true
}
}
],
"meta": {
"source": "homedepot"
}
}Errors
Errors return a JSON body with a detail field. Failed requests are not charged. See Errors for the full list and retry advice.
| Status | Meaning | Retry? |
|---|---|---|
401 Unauthorized | Missing or invalid API key. {"detail":"missing or invalid API key"} | No, fix the request |
402 Payment Required | Not enough credits for this request: the account's credits mode is {"detail":"insufficient credits: this request costs 5, 0 available. Credits renew 2026-11-01."} | No, fix the request |
422 Unprocessable Content | Request validation failed. {"detail":[{"loc":["body","name"],"msg":"Field required","type":"missing"}]} | No, fix the request |
429 Too Many Requests | Too many requests: the key's requests-per-minute limit was exceeded, or (in {"detail":"rate limit 60/min exceeded"} | Yes, with backoff |
503 Service Unavailable | Temporarily unavailable: a dependency of this endpoint is down, or the upstream source changed its contract. Retry later. {"detail":"database unavailable: OperationalError"} | Yes, with backoff |
Try it
Press Try it above to run this request on your own key, with the values you type (sign in first). For a no-code walkthrough, use the workspace’s guided Try it.
- Export your key:
export SCRAPERCOMPANY_API_KEY=sk_...(no key yet? start a free trial). - Copy the cURL example above and run it in a terminal.
Credits
2 credits per successful call (2 per page (an empty page and failed requests are free)). Failed, blocked and empty results are free.