Home Depot

Browse a Home Depot category or brand page

Returns one page of a Home Depot category or brand browse page's product grid: products with title, image, model, current/original price, and rating/review count, plus the category's total result count and the refinement facets the page offers. path is the segment of a /b/ URL after "/b/", e.g. "Tools-Power-Tools-Drills-Impact-Drivers/N-5yc1vZc29x"; a full https://www.homedepot.com/b/... URL or a "/b/..." path is also accepted. sort selects the result ordering and is one of best_match, top_sellers, top_rated, price_low_to_high, price_high_to_low, most_popular, delivery_date; omit it to keep the site's default ordering. page is a 1-indexed page number (default 1, maximum 42), 24 products per page. Each returned facet's path is directly usable as this endpoint's own path parameter to drill down. An unrecognized or blocked path returns an upstream error rather than an empty result.

get/homedepot/category

Request

  • Base URL: https://api.crawlora.net/api/v1
  • URL: https://api.crawlora.net/api/v1/homedepot/category
  • Auth: API key in header x-api-key

Query parameters

pathstring required

Home Depot category/brand browse path, e.g. \

sort'best_match' | 'top_sellers' | 'top_rated' | 'price_low_to_high' | 'price_high_to_low' | 'most_popular' | 'delivery_date'

Result ordering. One of: best_match, top_sellers, top_rated, price_low_to_high, price_high_to_low, most_popular, delivery_date. Omit for the site's default ordering

pageinteger

1-indexed page number, default 1, maximum 42 (12 products per page)

Headers

x-api-keystring required

API key required

Response

OK

codeinteger
msgstring

Example response

{
  "code": 200,
  "data": {
    "facets": [
      {
        "name": "Cordless",
        "path": "Cordless/N-5yc1vZc29xZ1z140i3"
      }
    ],
    "page": 1,
    "products": [
      {
        "id": "320326875",
        "model": "2953-20",
        "original_price": 199,
        "price": 179,
        "rating": 4.7,
        "review_count": 1542,
        "title": "M18 FUEL 18V Lithium-Ion Brushless Cordless 1/4 in. Hex Impact Driver (Tool-Only)"
      }
    ],
    "sort": "top_sellers"
  },
  "msg": "OK"
}

Changes

No recorded changes to this operation across all 3 revisions of this API.