Home Depot API endpoint
Use Crawlora's Home Depot search suggestions 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/suggestReturns Home Depot's own search-box typeahead suggestions for a partial query, in the site's own ranking order. term is the partial search text, e.g. "drill". Each suggestion's term is directly usable as GET /homedepot/search's q parameter. A term that matches nothing returns an empty suggestion list rather than an error. 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 |
|---|---|---|---|---|---|
| term | string | Yes | Partial search text, e.g. \ | ||
| x-api-key (header) | string | Yes | API key required |
curl -X GET "https://api.crawlora.net/api/v1/homedepot/suggest" \ -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.
- Each suggestion's `term` is directly usable as `/api/v1/homedepot/search`'s `q` parameter. - `position` is the suggestion's 1-indexed rank in Home Depot's own typeahead ordering. - A `term` that genuinely matches nothing returns an empty `suggestions` list with `count: 0`, not an error. - The upstream typeahead also carries each suggestion's own search link. Those links are deliberately not returned: they point at URL shapes Home Depot's `robots.txt` disallows, so the suggestion text is exposed instead. - A blocked or non-JSON upstream response returns a `503` upstream error rather than an empty result. Example response: ```json {"code":200,"msg":"OK","data":{"term":"drill","count":3,"suggestions":[{"term":"drill","position":1},{"term":"drill bits","position":2},{"term":"drill set","position":3}],"source_url":"https://www.homedepot.com/TA2/search?term=drill","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 |
| 429 | Too Many Requests | #/definitions/app.Response |
| 503 | Service Unavailable | #/definitions/app.Response |
{
"code": 200,
"msg": "OK",
"data": {
"term": "drill",
"count": 3,
"suggestions": [
{
"term": "drill",
"position": 1
},
{
"term": "drill bits",
"position": 2
},
{
"term": "drill set",
"position": 3
}
],
"source_url": "https://www.homedepot.com/TA2/search?term=drill",
"fetched_at": "2026-09-05T00:00:00Z"
}
}Request schema
No body schema
Response schema
#/definitions/homedepot.suggestResponseDoc
| Field | Type | Required | Enum | Bounds | Example | Description |
|---|---|---|---|---|---|---|
| code | integer | No | 200 | |||
| data | homedepot.SuggestResponse | No | ||||
| data.count | integer | No | 10 | |||
| data.fetched_at | string | No | ||||
| data.source_url | string | No | ||||
| data.suggestions | array | No | ||||
| data.suggestions[].position | integer | No | 2 | Position is the suggestion's 1-indexed rank in Home Depot's own typeahead ordering. | ||
| data.suggestions[].term | string | No | drill bits | |||
| data.term | string | No | drill | |||
| 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/suggest" \
-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