# SocialCrawl API — home_depot endpoints
# Base URL: https://www.socialcrawl.dev
# Auth: x-api-key header
# Full docs: https://www.socialcrawl.dev/docs/home_depot

## GET /v1/home_depot/product
Get a Home Depot product by item id or URL
Credit cost: 5 (advanced)
Parameters:
- item_id (optional, string) — Home Depot internet number (item id), the numeric id at the end of a homedepot.com product URL: homedepot.com/p/<name>/326680222 is item id 326680222. Pass url instead if you would rather hand over the whole product URL.
- url (optional, string) — Full Home Depot product page URL, used instead of item_id. The item id is extracted from it.
- store_id (optional, string) — Home Depot store number used to localise price, stock, and pickup availability, for example 121.
- zipcode (optional, string) — Five-digit US ZIP code used to localise delivery options and pricing, for example 30301.
- Constraint: one of item_id, url (at least one required)
curl "https://www.socialcrawl.dev/v1/home_depot/product" \
  -H "x-api-key: sc_your_api_key_here"

## GET /v1/home_depot/reviews
Get Home Depot product reviews
Credit cost: 5 (advanced)
Parameters:
- item_id (required) — Home Depot internet number (item id), the numeric id at the end of a homedepot.com product URL: homedepot.com/p/<name>/326680222 is item id 326680222. Pass url instead if you would rather hand over the whole product URL.
- page (optional, integer) — Page number, starting at 1. Prefer the universal cursor parameter.
- items_per_page (optional, integer) — Reviews per page, 1 to 100. Defaults to 20.
- rating (optional, integer) — Return only reviews with this star rating, 1 to 5.
- sort_by (optional, enum: helpful | newest | oldest | photos_first | highest_rating | lowest_rating) — Review ordering: helpful (default), newest, oldest, photos_first, highest_rating, or lowest_rating.
- search_text (optional, string) — Return only reviews whose text contains these words, for example easy to use.
- verified_only (optional, boolean) — Set true to return only reviews written by verified purchasers.
curl "https://www.socialcrawl.dev/v1/home_depot/reviews?item_id=326680222" \
  -H "x-api-key: sc_your_api_key_here"

## GET /v1/home_depot/search
Search Home Depot products by keyword
Credit cost: 5 (advanced)
Parameters:
- query (required) — Free-text product search, for example drill or cordless impact driver.
- page (optional, integer) — Page number, 1 to 30. Prefer the universal cursor parameter.
- items_per_page (optional, integer) — Products per page, 1 to 48. Defaults to 24.
- sort_by (optional, enum: best_match | top_sellers | top_rated | price_low_to_high | price_high_to_low | newest) — Result ordering: best_match (default), top_sellers, top_rated, price_low_to_high, price_high_to_low, or newest.
- brand (optional, string) — Return only products from one brand, for example DEWALT.
- min_price (optional, string) — Lowest price to include, in USD. Applied by Home Depot and approximate, so filter on product.price.current if you need a hard bound.
- max_price (optional, string) — Highest price to include, in USD. Applied by Home Depot and approximate, so filter on product.price.current if you need a hard bound.
- in_stock (optional, boolean) — Set true to return only products Home Depot can fulfil now.
- store_id (optional, string) — Home Depot store number used to localise price, stock, and pickup availability, for example 121.
- zipcode (optional, string) — Five-digit US ZIP code used to localise delivery options and pricing, for example 30301.
curl "https://www.socialcrawl.dev/v1/home_depot/search?query=drill" \
  -H "x-api-key: sc_your_api_key_here"

## GET /v1/home_depot/category
Browse Home Depot products in a category
Credit cost: 5 (advanced)
Parameters:
- category_id (required) — Home Depot category id, the 5yc1v… segment of a homedepot.com category URL, for example 5yc1vZc2bp. Also returned in the breadcrumbs and filters of GET /v1/home_depot/search.
- page (optional, integer) — Page number, 1 to 30. Prefer the universal cursor parameter.
- items_per_page (optional, integer) — Products per page, 1 to 48. Defaults to 24.
- sort_by (optional, enum: best_match | top_sellers | top_rated | price_low_to_high | price_high_to_low | newest) — Result ordering: best_match (default), top_sellers, top_rated, price_low_to_high, price_high_to_low, or newest.
- brand (optional, string) — Return only products from one brand, for example DEWALT.
- min_price (optional, string) — Lowest price to include, in USD. Applied by Home Depot and approximate, so filter on product.price.current if you need a hard bound.
- max_price (optional, string) — Highest price to include, in USD. Applied by Home Depot and approximate, so filter on product.price.current if you need a hard bound.
- in_stock (optional, boolean) — Set true to return only products Home Depot can fulfil now.
- store_id (optional, string) — Home Depot store number used to localise price, stock, and pickup availability, for example 121.
- zipcode (optional, string) — Five-digit US ZIP code used to localise delivery options and pricing, for example 30301.
curl "https://www.socialcrawl.dev/v1/home_depot/category?category_id=5yc1vZc2bp" \
  -H "x-api-key: sc_your_api_key_here"