Home Depot

Home Depot Reviews

Retrieve native Home Depot Reviews data.

post/v1/home-depot/reviews

Request

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

Request body

idstring required

The provider's identifier, as returned by its search results.

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.

termstring

Search native review text.

ratingstring

One or more ratings separated by commas, such as 5,3,2.

sort_by'photoreview' | 'mosthelpfull' | 'oldest' | 'newest' | 'highestrating' | 'lowestrating'

Native review ordering. Omit to preserve the retailer default.

verified_purchasesboolean

Return only verified-purchase reviews when true.

startinteger

One-based review offset. Cannot be combined with page greater than 1.

pagesizeinteger

Reviews per page, up to 100. Existing default is 8.

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 2 revisions of this API.