Home Depot API endpoint
Returns 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.
/homedepot/suggestQuery parameters:
term (required) — the partial search text, e.g. drill. Must be 100 characters or fewer.Notable response behavior:
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.term that genuinely matches nothing returns an empty suggestions list with count: 0, not an error.503 upstream error rather than an empty result.| Field | Filled in, of 10 checked | Values in the sample |
|---|---|---|
| term | 10 | “drill” and 9 other values |
| position | 10 | 1 to 10, median 5 |
| Parameter | Type | Required | Default | Description | Example |
|---|---|---|---|---|---|
| term | string | Yes | Partial search text, e.g. \ | drill | |
| x-api-key (header) | string | Yes | API key required |
curl -X GET "https://api.crawlora.net/api/v1/homedepot/suggest?term=drill" \ -H "x-api-key: $CRAWLORA_API_KEY"
{
"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 |
| Status | Description | Schema |
|---|---|---|
| 400 | Bad Request | #/definitions/app.Response |
| 429 | Too Many Requests | #/definitions/app.Response |
| 503 | Service Unavailable | #/definitions/app.Response |
Use environment variables for secrets and keep Crawlora API keys server-side.
curl -X GET "https://api.crawlora.net/api/v1/homedepot/suggest?term=drill" \
-H "x-api-key: $CRAWLORA_API_KEY"