Home Depot

Home Depot search suggestions

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.

get/homedepot/suggest

Request

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

Query parameters

termstring required

Partial search text, e.g. \

Headers

x-api-keystring required

API key required

Response

OK

codeinteger
msgstring

Example response

{
  "code": 200,
  "data": {
    "count": 10,
    "suggestions": [
      {
        "position": 2,
        "term": "drill bits"
      }
    ],
    "term": "drill"
  },
  "msg": "OK"
}

Changes

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