Home Depot API endpoint
Use Crawlora's Home Depot Category API to extract supported public Home Depot data as structured JSON. This page includes request parameters, cURL examples, response schema, error behavior, credit cost, and a Playground link for testing before integration.
/homedepot/categoryReturns one page of a Home Depot category or brand browse page's product grid: normalized 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. Developers commonly use this endpoint for data enrichment, monitoring, research dashboards, internal automation, and agent-native workflows that need repeatable structured public web data. Authentication uses the documented Crawlora headers, and usage is metered with the credit cost shown on this page.
Request parameters are generated from the active endpoint catalog. Required values must be sent before Crawlora can call the upstream public web data source.
| Parameter | Type | Required | Default | Description | Example |
|---|---|---|---|---|---|
| path | string | Yes | Home Depot category/brand browse path, e.g. \ | ||
| sort | string | No | 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 Allowed values: best_match, top_sellers, top_rated, price_low_to_high, price_high_to_low, most_popular, delivery_date | ||
| page | integer | No | 1-indexed page number, default 1, maximum 42 (12 products per page) | ||
| x-api-key (header) | string | Yes | API key required |
curl -X GET "https://api.crawlora.net/api/v1/homedepot/category?sort=best_match&page=1" \ -H "x-api-key: $CRAWLORA_API_KEY"
Send your scraping API key in the x-api-key header. Use the console API Keys page to rotate or select the active key.
Endpoint usage is metered in credits. The plan prices, included credits, limits, and overage rates below match the active backend billing configuration.
| Plan | Price | Included credits | Daily cap | Rate limit | Overage |
|---|---|---|---|---|---|
| Free | $0/mo | 2,000 | 500 daily credits | 5/min | No overage |
| Starter | $9/mo | 20,000 | 5,000 daily credits | 15/min | $0.75/1,000 overage credits when enabled |
| Growth | $29/mo | 100,000 | 25,000 daily credits | 45/min | $0.45/1,000 overage credits when enabled |
| Pro | $79/mo | 400,000 | No daily cap | 120/min | $0.30/1,000 overage credits |
| Business | $199/mo | 1,200,000 | No daily cap | 300/min | $0.20/1,000 overage credits |
| Enterprise | $499/mo | 5,000,000 | No daily cap | 1,000/min | $0.12/1,000 overage credits |
This endpoint is executed through Crawlora's managed scraping infrastructure.
- `sort` and `page` are optional and additive. With both omitted the request and response are identical to what this endpoint returned before they existed, so existing callers are unaffected. - `total` is the category's total result count across all pages (from the page's own "Viewing 1-N of M" marker); `count` is how many products this response carries; `page` echoes the page returned. - `facets` are the refinement links the browse page offers, e.g. `Cordless` or `18v` under Impact Drivers. Each facet's `path` is directly usable as this endpoint's own `path` parameter, so a caller drills down by passing a facet's `path` back in. Facets are omitted when the page offers none. - `price` is the current price; `original_price` is present only when the product is on sale. - `rating` and `review_count` are parsed from the card's `(rating / reviews)` text; they are omitted for products that show no rating. - A `path` that would resolve to a URL Home Depot's `robots.txt` disallows (keyword-refined browse such as `Ntt-`/`Ntk-`, the `NCNI-5` search-context marker, or the AJAX/overlay fragments) is rejected with a `400` rather than fetched. Facets pointing at such URLs are likewise never returned. - Keyword search is not part of this endpoint — see `/api/v1/homedepot/search`. - An unrecognized or blocked `path` returns a `503` upstream error rather than an empty result. Example response: ```json {"code":200,"msg":"OK","data":{"path":"Tools-Power-Tools-Drills-Impact-Drivers/N-5yc1vZc29x","sort":"top_sellers","page":1,"title":"IMPACT DRIVERS","total":1962,"count":1,"products":[{"id":"320326875","title":"M18 FUEL 18V Lithium-Ion Brushless Cordless 1/4 in. Hex Impact Driver (Tool-Only)","url":"https://www.homedepot.com/p/Milwaukee-M18-FUEL-18V-Lithium-Ion-Brushless-Cordless-1-4-in-Hex-Impact-Driver-Tool-Only-2953-20/320326875","image":"https://images.thdstatic.com/productImages/fa7d2462-8481-4bd3-8010-384a85aa902f/svn/milwaukee-impact-drivers-2953-20-64_600.jpg","model":"2953-20","price":179,"rating":4.7,"review_count":1542}],"facets":[{"name":"Cordless","path":"Cordless/N-5yc1vZc29xZ1z140i3","url":"https://www.homedepot.com/b/Cordless/N-5yc1vZc29xZ1z140i3"}],"source_url":"https://www.homedepot.com/b/Tools-Power-Tools-Drills-Impact-Drivers/N-5yc1vZc29x?sortby=topsellers&sortorder=desc","fetched_at":"2026-09-05T00:00:00Z"}} ```
Crawlora does not silently return bad data when the upstream page cannot be used.
| Status | Common failure case |
|---|---|
| 400 | Invalid input or missing required parameter |
| 429 | Plan or endpoint rate limit exceeded |
| 500 | Internal execution error |
| 502 | Upstream platform failed, returned unusable HTML, or served a challenge page that could not be resolved |
When possible, Crawlora returns structured error context so your integration can retry, back off, or inspect the request.
| Status | Description | Schema |
|---|---|---|
| 400 | Bad Request | #/definitions/app.Response |
| 404 | Not Found | #/definitions/app.Response |
| 429 | Too Many Requests | #/definitions/app.Response |
| 503 | Service Unavailable | #/definitions/app.Response |
{
"code": 200,
"msg": "OK",
"data": {
"path": "Tools-Power-Tools-Drills-Impact-Drivers/N-5yc1vZc29x",
"sort": "top_sellers",
"page": 1,
"title": "IMPACT DRIVERS",
"total": 1962,
"count": 1,
"products": [
{
"id": "320326875",
"title": "M18 FUEL 18V Lithium-Ion Brushless Cordless 1/4 in. Hex Impact Driver (Tool-Only)",
"url": "https://www.homedepot.com/p/Milwaukee-M18-FUEL-18V-Lithium-Ion-Brushless-Cordless-1-4-in-Hex-Impact-Driver-Tool-Only-2953-20/320326875",
"image": "https://images.thdstatic.com/productImages/fa7d2462-8481-4bd3-8010-384a85aa902f/svn/milwaukee-impact-drivers-2953-20-64_600.jpg",
"model": "2953-20",
"price": 179,
"rating": 4.7,
"review_count": 1542
}
],
"facets": [
{
"name": "Cordless",
"path": "Cordless/N-5yc1vZc29xZ1z140i3",
"url": "https://www.homedepot.com/b/Cordless/N-5yc1vZc29xZ1z140i3"
}
],
"source_url": "https://www.homedepot.com/b/Tools-Power-Tools-Drills-Impact-Drivers/N-5yc1vZc29x?sortby=topsellers&sortorder=desc",
"fetched_at": "2026-09-05T00:00:00Z"
}
}Request schema
No body schema
Response schema
#/definitions/homedepot.categoryResponseDoc
| Field | Type | Required | Enum | Bounds | Example | Description |
|---|---|---|---|---|---|---|
| code | integer | No | 200 | |||
| data | homedepot.CategoryResponse | No | ||||
| data.count | integer | No | ||||
| data.facets | array | No | Facets are the refinement links this browse page offers. Each facet's path is directly usable as this endpoint's own path parameter. | |||
| data.facets[].name | string | No | Cordless | |||
| data.facets[].path | string | No | Cordless/N-5yc1vZc29xZ1z140i3 | |||
| data.facets[].url | string | No | ||||
| data.fetched_at | string | No | ||||
| data.page | integer | No | 1 | Page is the 1-indexed page this response carries. | ||
| data.path | string | No | ||||
| data.products | array | No | ||||
| data.products[].id | string | No | 320326875 | |||
| data.products[].image | string | No | ||||
| data.products[].model | string | No | 2953-20 | |||
| data.products[].original_price | number | No | 199 | |||
| data.products[].price | number | No | 179 | |||
| data.products[].rating | number | No | 4.7 | |||
| data.products[].review_count | integer | No | 1542 | |||
| data.products[].title | string | No | M18 FUEL 18V Lithium-Ion Brushless Cordless 1/4 in. Hex Impact Driver (Tool-Only) | |||
| data.products[].url | string | No | ||||
| data.sort | string | No | top_sellers | Sort echoes the requested sort value, or "" when the upstream default ordering was used. | ||
| data.source_url | string | No | ||||
| data.title | string | No | ||||
| data.total | integer | No | ||||
| msg | string | No | OK |
Use environment variables for secrets and keep Crawlora API keys server-side.
curl -X GET "https://api.crawlora.net/api/v1/homedepot/category?sort=best_match&page=1" \
-H "x-api-key: $CRAWLORA_API_KEY"Crawlora is designed for responsible structured public web data workflows. Customers are responsible for using Crawlora in compliance with applicable laws, third-party rights, target-platform rules, and Crawlora terms.
Read Crawlora terms