Home Depot

Home Depot Search

Retrieve native Home Depot Search data.

post/v1/home-depot/search

Request

  • Base URL: https://api.prismcrawl.com
  • URL: https://api.prismcrawl.com/v1/home-depot/search
  • Auth: API key in header x-api-key

Request body

querystring required

Text to search for on the selected service. At most 8,192 UTF-8 bytes.

pageinteger

One-based page number.

device'desktop' | 'mobile' | 'tablet'

Device presentation for the source request.

htmlboolean

Return the encoded original response rather than parsed JSON.

zero_traceboolean

Do not archive source or parsed response artifacts.

country'us' | 'ca'

Home Depot marketplace. Default us.

storestring

Canadian store ID. Default 7140.

sort'price-asc' | 'price-desc' | 'reviewAvgRating' | 'relevance'

Canada search sort order.

filterstring

Canada native filter tokens separated by hyphens, obtained from filters.

minmaxstring

Canada price interval, such as price:[100 TO 500] or price:[100 TO *]. URL-encoded input is also accepted.

pagesizeinteger

Canada results per page, up to 40.

delivery_zipstring

US delivery ZIP code for shipping availability.

store_idstring

Home Depot US store ID. Search restricts results to this store.

hd_sort'top_sellers' | 'price_low_to_high' | 'price_high_to_low' | 'top_rated' | 'best_match'

US product sort order.

hd_filter_tokensstring

US native filter tokens separated by commas, obtained from filters.

psinteger

US results per page. Default 24.

naointeger

US zero-based product offset. Cannot be combined with page greater than 1.

lowerboundinteger

Minimum US price in whole USD. Native Home Depot filters may include product variants with different displayed prices.

upperboundinteger

Maximum US price in whole USD. Native Home Depot filters may include product variants with different displayed prices.

output'json' | 'html' | 'md' | 'null' nullable

Response content format. md returns Markdown in data.content with data.format=md; the JSON success/request envelope remains. Accept: text/markdown also selects Markdown unless output or html=true is explicit. html is an alias for html=true and retains the existing Brotli/Base64 source format.

json_restrictorstring nullable

Select fields within data.content for JSON or Markdown. Supports comma-separated paths, non-negative array indices, half-open slices [0:3] (either bound may be omitted), [] and .{nested,subqueries}. Up to128 selections and16 levels. Missing fields are omitted; selected declared fields retain their zero defaults. The request envelope and credit headers remain. Include next_page_token when pagination is needed. Incompatible with HTML output. This changes response presentation only; tracing-enabled history retains the complete JSON result.

no_cacheboolean nullable

Accepted for compatibility. Searches are always fetched without a result cache for either value; normal successful-request billing applies.

Example request

{
  "json_restrictor": "results[].{title,url},has_next_page,next_page_token"
}

Response

Request completed. One credit is charged, including recognized empty or unavailable source results and source inventory changes discovered after a valid continuation is fetched. These completed responses may preserve verified partial results; operational failures remain errors.

successtrue required
request_idstring uuid required

Changes

No recorded changes to this operation across all 1 revision of this API.