---
title: "Home Depot search suggestions"
method: GET
path: "/homedepot/suggest"
tags: ["Home Depot"]
---

# Home Depot search suggestions

`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`

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.

## Query parameters

- `term` string, required

## Headers

- `x-api-key` string, required

## Response `200`

OK

- HomedepotSuggestResponseDoc
  - `code` integer
  - `data` HomedepotSuggestResponse
    - `count` integer
    - `fetched_at` string
    - `source_url` string
    - `suggestions` HomedepotSuggestion[]
      - `position` integer: Position is the suggestion's 1-indexed rank in Home Depot's own typeahead ordering.
      - `term` string
    - `term` string
  - `msg` string

## Other responses

- `400`: Bad Request
- `429`: Too Many Requests
- `503`: Service Unavailable

---

[API](https://skmtc.dev/crawlora/apis/crawlora-api.md) · [All operations](https://skmtc.dev/crawlora/apis/crawlora-api/llms.txt) · [OpenAPI document](https://skmtc.dev/crawlora/apis/crawlora-api/revisions/afac9b012a27?raw)