Home Depot API
Home Depot search
Search the Home Depot catalogue: product cards with id, title, brand, model number, price (current, was, saving), rating and review count, badges, thumbnails, delivery and pickup, with the page's filters, total and a cursor to the next page (up to 30 pages). Reactivated 6 Sep 2026 on a search-results supplier after the marketplace listing failed (188).
Endpoint
GET/v1/home_depot/searchlive · proven2 creditsParameters
Query parameters
| Name | Required | Description | Example |
|---|---|---|---|
query | yes | Search words | cordless drill |
page | no | Page number, 1 to 30 (24 products per page) | 1 |
sort_by | no | best_match (default), top_sellers, top_rated, price_low_to_high or price_high_to_low | top_sellers |
min_price | no | Lowest price to include, in dollars | 20 |
max_price | no | Highest price to include, in dollars | 150 |
store_id | no | Store number to localise price and availability | 1087 |
delivery_zip | no | ZIP code for delivery availability | 10001 |
free_ship_to_store | no | Only products with free ship-to-store | true |
dry_run | no | Read a zero-credit estimate without fetching sources, running AI, or reserving credits. Cache status is a snapshot, not a guarantee at execution. | 1 |
Examples
Make the request
curl "https://www.monocrawl.com/v1/home_depot/search?query=cordless%20drill" \ -H "x-api-key: mn_your_key_here"
TypeScript
const key = process.env.MONOCRAWL_API_KEY;
if (!key) throw new Error('Set MONOCRAWL_API_KEY on your server.');
const res = await fetch(
"https://www.monocrawl.com/v1/home_depot/search?query=cordless%20drill",
{ headers: { "x-api-key": key } },
);
const body = await res.json();
if (!body.success) {
// one error shape for every endpoint — see /docs/errors
throw new Error(`${body.error.type}: ${body.error.message}`);
}
console.log(body.data, "credits left:", body.credits_remaining);Python
import os
import requests
res = requests.get(
"https://www.monocrawl.com/v1/home_depot/search?query=cordless%20drill",
headers={"x-api-key": os.environ["MONOCRAWL_API_KEY"]},
timeout=60,
)
body = res.json()
if not body["success"]:
# one error shape for every endpoint — see /docs/errors
raise RuntimeError(f"{body['error']['type']}: {body['error']['message']}")
print(body["data"], "credits left:", body["credits_remaining"])Response
Response fields and example
This example is illustrative, not a captured live response. Variable-cost operations may settle a charge different from the list price below. A successful response puts the platform payload in data and reports the exact credits used, remaining balance, request id and cache status beside it.
{
"success": true,
"platform": "home_depot",
"endpoint": "/v1/home_depot/search",
"data": {
"count": 0,
"cursor": null,
"filters": [],
"filters_supported": [
"example"
],
"has_more": false,
"items": [
{
"badges": [
"example"
],
"brand": "example",
"delivery": {
"free": false,
"free_threshold": false
},
"id": "example",
"model_number": "example",
"pickup": {
"free_ship_to_store": false
},
"platform": "example",
"position": 0,
"price": {
"currency": "example",
"current": 0,
"original": 0,
"percentage_off": 0,
"saving": 0
},
"rating": {
"average": 0,
"count": 0
},
"thumbnails": [
"example"
],
"title": "example",
"url": "https://example.com/example"
}
],
"page": 0,
"page_limit": 0,
"page_size": 0,
"query": "example",
"results_state": "example",
"sort_by": "example",
"store": {
"id": "example",
"name": "example"
},
"total": 0
},
"credits_used": 2,
"credits_remaining": 99,
"request_id": "req_…",
"cached": false
}The example is illustrative and shows a documented subset of data. The fields below are optional across supported sources; nullable fields can also be absent. Preserve unknown values and accept additional fields.
Schema basis: observed response shapes, not an exhaustive field specification. See schema coverage and validation limits.
Download the data JSON Schema. Validate response.data, not the whole envelope. A valid shape does not establish that every field or source record was returned.
| Field inside data | Type | Meaning |
|---|---|---|
count | number | null | Number of records in this response, not lifetime or total matches. |
cursor | string | null | Opaque next-page token; pass it back unchanged. Null does not prove complete history. |
filters | array | null | Source array was empty in the reviewed captures; item fields remain unspecified. |
filters_supported | array | null | Optional filters supported supplied by this operation. Null means unknown. |
has_more | boolean | null | Source continuation indicator; null means unknown. |
items | array | null | Returned records. Source coverage and completeness vary. |
items[].badges | array | null | Optional badges supplied by this operation. Null means unknown. |
items[].brand | string | null | Optional brand supplied by this operation. Null means unknown. |
items[].delivery | object | null | Optional delivery supplied by this operation. Null means unknown. |
items[].delivery.free | boolean | null | Optional free supplied by this operation. Null means unknown. |
items[].delivery.free_threshold | boolean | null | Optional free threshold supplied by this operation. Null means unknown. |
items[].id | string | null | Source identifier. Preserve the supplied type and exact value. |
items[].model_number | string | null | Optional model number supplied by this operation. Null means unknown. |
items[].pickup | object | null | Optional pickup supplied by this operation. Null means unknown. |
items[].pickup.free_ship_to_store | boolean | null | Optional free ship to store supplied by this operation. Null means unknown. |
items[].platform | string | null | Optional platform supplied by this operation. Null means unknown. |
items[].position | number | null | Optional position supplied by this operation. Null means unknown. |
items[].price | object | null | Source price. Currency, taxes and availability depend on the listing. |
items[].price.currency | string | null | Optional currency supplied by this operation. Null means unknown. |
items[].price.current | number | null | Optional current supplied by this operation. Null means unknown. |
items[].price.original | number | null | Optional original supplied by this operation. Null means unknown. |
items[].price.percentage_off | number | null | Optional percentage off supplied by this operation. Null means unknown. |
items[].price.saving | number | null | Optional saving supplied by this operation. Null means unknown. |
items[].rating | object | null | Source rating; read its accompanying scale and vote count. |
items[].rating.average | number | null | Optional average supplied by this operation. Null means unknown. |
items[].rating.count | number | null | Number of records in this response, not lifetime or total matches. |
items[].thumbnails | array | null | Optional thumbnails supplied by this operation. Null means unknown. |
items[].title | string | null | Source title when supplied. |
items[].url | string | null | Original source URL when supplied. |
page | number | null | Optional page supplied by this operation. Null means unknown. |
page_limit | number | null | Optional page limit supplied by this operation. Null means unknown. |
page_size | number | null | Optional page size supplied by this operation. Null means unknown. |
query | string | null | Optional query supplied by this operation. Null means unknown. |
results_state | string | null | Optional results state supplied by this operation. Null means unknown. |
sort_by | string | null | Optional sort by supplied by this operation. Null means unknown. |
store | object | null | Optional store supplied by this operation. Null means unknown. |
store.id | string | null | Source identifier. Preserve the supplied type and exact value. |
store.name | string | null | Optional name supplied by this operation. Null means unknown. |
total | number | null | Source-reported total; null is unknown. |
Optional fields reviewed from preserved successful responses. Additive fields and source variations remain allowed; validate the fields your workflow requires.
The example is invented and illustrates types only; zero and empty values are not claims about a real result.
Failures use the typed error envelope. A confirmed uncharged or refunded failure reports zero; a pending reconciliation can report an unknown charge. Read credits_used and error.details.billing_status, and keep request_id for recovery. Response contract · Error reference