Home Depot

Search Home Depot products

Search Home Depot products by keyword, with prices, discounts, ratings, badges and how each is sold.

GET/v1/home-depot/search
x-api-keystringheader

API key (`sfk_...`)

Parameters
3
querystringrequiredquery

Words to search for, up to 200 characters (`cordless drill`).

min 1 chars · max 200 chars

sortstringoptionalquery

Order of the products: `best_match` (default), `top_sellers`, `price_low_to_high`, `price_high_to_low` or `top_rated`.

one of: best_match, top_sellers, price_low_to_high, price_high_to_low, top_rated

cursorstringoptionalquery

Pass `page.nextCursor` from the previous response to get the next page. It only works with the same filters.

min 1 chars · max 1024 chars

Response fields
44

Endpoint-specific response payload.

datalookupStatus
string

Always `found`: no match is an empty list.

one of: found, not_found

dataquery
string

The words searched for.

datacorrectedQuery
stringnullable

The words the site searched instead, when it corrected them.

datatotalResults
integernullable

Products matching, across every page, as the site counts them.

The category the search landed on, broadest first, when the site narrowed it to one; empty otherwise.

datacategories[]
stringoptional

Products on this page, in the site's order.

dataproducts[]id
string

Item id, the Internet # (`100497597`); pass it as `productId` to the product, reviews and questions endpoints.

dataproducts[]url
string

Product page URL.

dataproducts[]name
stringnullable

Product name.

dataproducts[]brand
stringnullable

Brand.

dataproducts[]modelNumber
stringnullable

Model number.

dataproducts[]storeSku
stringnullable

Store SKU number.

dataproducts[]imageUrl
stringnullable

Main image URL, 1000 px.

The price.

dataproducts[]pricecurrent
numbernullable

The price shown, in US dollars; null when the site hides it.

dataproducts[]priceoriginal
numbernullable

The price before a discount, in US dollars; null without a discount.

dataproducts[]pricecurrency
string

Always `USD`.

one of: USD

dataproducts[]priceunitOfMeasure
stringnullable

What the price is for, e.g. `each` or `sq. ft.`.

dataproducts[]pricedollarOff
numbernullable

Discount in US dollars; null without one.

dataproducts[]pricepercentOff
numbernullable

Discount in percent; null without one.

dataproducts[]pricepromotion
stringnullable

The promotion's text, e.g. `Save $40`; null without one.

dataproducts[]rating
numbernullable

Average star rating out of 5; null with no reviews.

dataproducts[]reviewCount
integernullable

Number of reviews.

Badges on the card.

dataproducts[]badges[]name
string

Badge key, e.g. `top rated`.

dataproducts[]badges[]label
stringnullable

Badge text, e.g. `Top Rated`.

dataproducts[]badges[]message
stringnullable

Badge detail, e.g. `Top Rated in Small Kitchen Appliances`; null when none.

Category path, broadest first, e.g. `Tools`, `Power Tools`.

dataproducts[]categories[]
stringoptional
dataproducts[]availability
stringnullable

Stock status for a visitor with no store chosen: `IN_STOCK`, `LIMITED_STOCK`, `BACKORDERED` or `OUT_OF_STOCK` (no delivery or pickup option has it); null when the page does not say.

one of: IN_STOCK, LIMITED_STOCK, BACKORDERED, OUT_OF_STOCK, null

dataproducts[]channel
stringnullable

How it is sold: `Online`, `Shared` (online and in store), `Store Only` or `Browse Only`; null when not shown.

dataproducts[]isSponsored
boolean

Whether the card is a paid placement.

Pagination state for the current page.

datapagehasMore
boolean

Whether another page is available.

datapagenextCursor
stringnullable

Cursor for the next page; null on the last page.

datapagetruncated
boolean

True when the list stops here before its end: more rows exist (see `totalResults`) but no further page can be read.

Metadata describing the request and billing outcome.

metarequestId
string

Unique request identifier for tracing this API call.

min 1 chars

metacreditsCharged
integer

Credits charged for this request.

≥ 0

metaversion
string

Public API version that served the response.

one of: v1

metastale
booleanoptional

Present, and `true`, only when the source couldn't be reached and this is the last good answer for the same request instead, up to 24 hours old. Absent on every live answer.

one of: true

metafetchedAt
stringoptional

When a stale answer (`stale: true`) was originally fetched (ISO 8601, UTC). Absent on every live answer.

Code example

curl "https://api.socialfetch.dev/v1/home-depot/search?query=cordless%20drill" \
  -H "x-api-key: YOUR_API_KEY"

Responses

Home Depot product search results.