home_depot

Get a Home Depot product by item id or URL

Returns full product detail for a Home Depot item: title, brand, model number, UPC, description, highlight bullets, current and original price, star rating, review count, the image gallery, and stock status. It also returns inventory under product.ext.store_inventory, giving the actual unit count at each location that can fulfil the item, which is the field nothing else in this API sells. Home Depot lists one location per fulfilment path, so a row is not always a store: each row carries fulfillment (pickup or delivery), service (for example bopis, express delivery or sth), location_type (store or online), and is_selected_store. One row has is_selected_store true, and that row is the store the request was localised to, echoing the store_id you sent in the same format. Read that flag rather than matching store ids numerically, because a delivery node can share digits with a store number (0121 is not store 121). On the rare response where the flag is null for every row, the selected store is the pickup row whose store_id equals the store_id you sent, compared as an exact string. Pass store_id to localise that inventory; without it Home Depot picks a default store. Prices are Home Depot's online price and did not vary by store in any comparison we have run (four stores in three states on 28/09/2026), 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. When Home Depot withholds a price, price.current is null and product.ext.price_note says why, for example see final price in cart. Get a store id from GET /v1/home_depot/stores. For the review text call GET /v1/home_depot/reviews with the same item id.

get/home_depot/product

Request

  • Base URL: https://www.socialcrawl.dev/v1
  • URL: https://www.socialcrawl.dev/v1/home_depot/product
  • Auth: API key in header x-api-key

Query parameters

item_idstring

Home Depot internet number (item id), the numeric id at the end of a homedepot.com product URL: homedepot.com/p/<name>/326680222 is item id 326680222. Pass url instead if you would rather hand over the whole product URL. (one of: item_id, url; at least one required)

urlstring

Full Home Depot product page URL, used instead of item_id. The item id is extracted from it. (one of: item_id, url; at least one required)

store_idstring

Home Depot store number used to localise stock and pickup availability, for example 0159. Prices are Home Depot's online price and do not change with the store. It is a string: pass it exactly as GET /v1/home_depot/stores returns it (four digits, zero-padded). The store_inventory row with is_selected_store true is this store, and an unknown store number is rejected.

Headers

Cache-Controlstring

Send no-cache to bypass the response cache and force a live fetch. Billed at the normal endpoint cost; the fresh result is written back to cache for the next caller. Only the no-cache directive triggers this. See the Response Schema guide for details.

Idempotency-Keystring

Optional UUID that makes the request safely retriable. The key is reserved atomically per account before billing. A concurrent retry receives 409 IDEMPOTENCY_IN_PROGRESS with a Retry-After of 1 second while the original is young, growing to a quarter of the time it has been running (at most 30); a crashed reservation expires after 5 minutes. A replay keeps the cached payload immutable except for billing metadata: credits_used becomes 0, idempotent_replay becomes true, and credits_remaining is refreshed to the current balance. A known current balance appears in both the body and X-Credits-Remaining header; no balance row resolves to 0. On a transient lookup failure, body credits_remaining is null and X-Credits-Remaining is omitted. Completed outcomes expire after 24 hours. If the claim store is unavailable, the request fails closed before billing. GET endpoints do not combine idempotent replay with Server-Sent Events: use Accept: application/json when sending this header. The unsupported key-plus-SSE combination is rejected before billing.

Response

Successful response

successboolean required

Whether the request succeeded

platformstring required

Platform name

endpointstring required

API endpoint path

credits_usedinteger required

Number of credits consumed

credits_remaininginteger nullable required

Current account balance, or null when this response could not establish one. Free cache hits always return null because they do not establish an authoritative post-request balance. An idempotency replay also returns null when its current-balance lookup fails. It is never a fabricated zero, so a zero here means the account really is empty. The authoritative reading is the one on a billed response, which comes straight from the deduction.

request_idstring required

Unique request identifier for support

cachedboolean required

Whether the response was served from cache

idempotent_replayboolean

True only when this response is an idempotency replay

Example response

{
  "success": true,
  "platform": "home_depot",
  "endpoint": "/v1/home_depot/product",
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "req-abc123",
  "idempotent_replay": true,
  "meta": {
    "hint": {
      "code": "search_multi",
      "message": "You searched \"matcha\" on 3 platforms one call at a time; /v1/search/multi returns each platform's own search rows in one call at the same price per platform, and a platform with no rows is not charged.",
      "method": "GET",
      "path": "/v1/search/multi?query=matcha&platforms=instagram,tiktok,youtube"
    }
  }
}

Changes