Home Depot product
One product in full by item_id or link.
/v1/homedepot/productTitle, brand, model, store SKU, price, was-price, discount, clearance, rating, review count, description, highlights, specifications, images, availability, and every fulfillment option: in-store pickup with the store's shelf quantity, ship to store, and delivery with dates. Give store_id (and zip_code) for that store's price and stock. An unknown item is a 404 and is not billed.
Request
https://api.scrapercompany.com/v1/homedepot/productAuthenticate 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.
- item_id string | null pattern ^\d{9}$
The 9-digit item id (the number at the end of a product link, or
item_idfrom a search). - url string | null max length 1000
A homedepot.com/p/ product link instead of
item_id. - store_id string | null pattern ^\d{1,4}$
Store number for the store price and its shelf stock.
- zip_code string | null pattern ^\d{5}(?:-\d{4})?$
US ZIP code for delivery options and dates.
Example request
curl -X POST "https://api.scrapercompany.com/v1/homedepot/product" \
-H "x-api-key: $SCRAPERCOMPANY_API_KEY" \
-H "Content-Type: application/json" \
-d '{}'Response
200 — One Home Depot product with store price and shelf stock. Metered responses carry x-credits-charged and x-credits-remaining headers (see credit headers).
{
"search_parameters": {
"engine": "homedepot_product",
"item_id": "312528776",
"store_id": "6175",
"zip_code": "10010"
},
"product": {
"item_id": "312528776",
"title": "2 in. x 4 in. x 96 in. #2 Premium Grade KD-HT Stud",
"brand": "Unbranded",
"model": "058449",
"store_sku": "161640",
"url": "https://www.homedepot.com/p/2-in-x-4-in-x-96-in-2-Premium-Grade-KD-HT-Stud-058449/312528776",
"price": 4.25,
"special_buy": false,
"unit": "each",
"rating": 3.96,
"review_count": 6338,
"image": "https://images.thdstatic.com/productImages/46ab3cfb-6093-435d-a6f0-c991006f05c3/svn/framing-studs-058449-64_1000.jpg",
"discontinued": false,
"availability": {
"pickup": true,
"delivery": true
},
"description": "Minimize culling and rework with high-quality, grade-stamped lumber designed for the job site. Whether you are framing structural interior walls, roofs, or floors, our lumber offers the consistency needed for a fast install. Available in mu…",
"highlights": [
"2 in. x 4 in. x 96 in. (actual 1.5 in. x 3.5 in. x 96 in.)",
"Ideal for structural framing in home construction and renovations"
],
"specifications": [
{
"group": "Details",
"name": "Fastener Recommendation",
"value": "Standard Nails"
},
{
"group": "Details",
"name": "Features",
"value": "Heat Treated,Paintable,Stainable,Untreated"
}
],
"images": [
"https://images.thdstatic.com/productImages/46ab3cfb-6093-435d-a6f0-c991006f05c3/svn/framing-studs-058449-64_1000.jpg",
"https://images.thdstatic.com/productImages/88d1edae-4ecd-4815-a810-9a485286d2cd/svn/framing-studs-058449-c3_1000.jpg"
],
"buyable": true,
"availability_type": "Store Only",
"backordered": false,
"fulfillment": [
{
"option": "pickup",
"service": "bopis",
"store_id": "6175",
"store_name": "Manhattan West 23rd St",
"is_selected_store": true,
"quantity": 110,
"in_stock": true,
"limited_quantity": false,
"free_shipping": false,
"delivery_start": "2027-04-16",
"delivery_end": "2027-04-16"
},
{
"option": "delivery",
"service": "express delivery",
"store_id": "6845",
"is_selected_store": false,
"quantity": 1775,
"in_stock": true,
"limited_quantity": false,
"free_shipping": false,
"delivery_start": "2027-04-16",
"delivery_end": "2027-04-16"
}
]
},
"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 |
404 Not Found | The property, stay, job or record was not found. {"detail":"job not found"} | 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 (an unknown item and failed requests are free)). Failed, blocked and empty results are free.