API reference
Home Depot Product API
One Home Depot product: title, brand, model and UPC, price and any promotion, rating and review count, availability, description, highlights, specifications by group, images and videos, category path.
Endpoint
GET/v1/home_depot/productlimited capacity1 creditLimited capacity: this operation currently relies on small shared monthly allowances. Availability can end before your account credits are used. Contact support before scheduling or bulk use. Allowances are shared across customers and related operations; this is not a per-account entitlement.
Parameters
Query parameters
| Name | Required | Description | Example |
|---|---|---|---|
item_id | no | The item id, the number at the end of a homedepot.com product URL. Send this or url. | 203203319 |
url | no | Product page URL | https://www.homedepot.com/p/Krud-Kutter-32-oz-Brush-Wash-and-Renewer-BW326/203203319 |
store_id | no | Store number to localise price and availability; store 1087 stands in when omitted (store_defaulted says so) | 1087 |
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/product?url=https%3A%2F%2Fwww.homedepot.com%2Fp%2FKrud-Kutter-32-oz-Brush-Wash-and-Renewer-BW326%2F203203319" \ -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/product?url=https%3A%2F%2Fwww.homedepot.com%2Fp%2FKrud-Kutter-32-oz-Brush-Wash-and-Renewer-BW326%2F203203319",
{ 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/product?url=https%3A%2F%2Fwww.homedepot.com%2Fp%2FKrud-Kutter-32-oz-Brush-Wash-and-Renewer-BW326%2F203203319",
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/product",
"data": {
"availability": {
"buyable": false,
"discontinued": false,
"in_stock": false,
"type": "example"
},
"brand": "example",
"category_path": [],
"department": "example",
"description": "example",
"highlights": [
"example"
],
"id": "example",
"images": [
{
"kind": "example",
"type": "example",
"url": "https://example.com/example"
}
],
"model_number": "example",
"parent_id": "example",
"platform": "example",
"price": {
"currency": "example",
"current": 0,
"unit": "example"
},
"rating": {
"average": 0,
"count": 0
},
"returnable": "example",
"specifications": [
{
"group": "example",
"items": [
{}
]
}
],
"store_defaulted": false,
"store_id": "example",
"store_sku": "example",
"title": "example",
"upc": "example",
"url": "https://example.com/example",
"videos": [
"example"
]
},
"credits_used": 1,
"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 |
|---|---|---|
availability | object | null | Optional availability supplied by this operation. Null means unknown. |
availability.buyable | boolean | null | Optional buyable supplied by this operation. Null means unknown. |
availability.discontinued | boolean | null | Optional discontinued supplied by this operation. Null means unknown. |
availability.in_stock | boolean | null | Optional in stock supplied by this operation. Null means unknown. |
availability.type | string | null | Optional type supplied by this operation. Null means unknown. |
brand | string | null | Optional brand supplied by this operation. Null means unknown. |
category_path | array | null | Source array was empty in the reviewed captures; item fields remain unspecified. |
department | string | null | Optional department supplied by this operation. Null means unknown. |
description | string | null | Source description; null or absent means not supplied. |
highlights | array | null | Optional highlights supplied by this operation. Null means unknown. |
id | string | null | Source identifier. Preserve the supplied type and exact value. |
images | array | null | Optional images supplied by this operation. Null means unknown. |
images[].kind | string | null | Optional kind supplied by this operation. Null means unknown. |
images[].type | string | null | Optional type supplied by this operation. Null means unknown. |
images[].url | string | null | Original source URL when supplied. |
model_number | string | null | Optional model number supplied by this operation. Null means unknown. |
parent_id | string | null | Optional parent id supplied by this operation. Null means unknown. |
platform | string | null | Optional platform supplied by this operation. Null means unknown. |
price | object | null | Source price. Currency, taxes and availability depend on the listing. |
price.currency | string | null | Optional currency supplied by this operation. Null means unknown. |
price.current | number | null | Optional current supplied by this operation. Null means unknown. |
price.unit | string | null | Optional unit supplied by this operation. Null means unknown. |
rating | object | null | Source rating; read its accompanying scale and vote count. |
rating.average | number | null | Optional average supplied by this operation. Null means unknown. |
rating.count | number | null | Number of records in this response, not lifetime or total matches. |
returnable | string | null | Optional returnable supplied by this operation. Null means unknown. |
specifications | array | null | Optional specifications supplied by this operation. Null means unknown. |
specifications[].group | string | null | Optional group supplied by this operation. Null means unknown. |
specifications[].items | array | null | Returned records. Source coverage and completeness vary. |
store_defaulted | boolean | null | Optional store defaulted supplied by this operation. Null means unknown. |
store_id | string | null | Optional store id supplied by this operation. Null means unknown. |
store_sku | string | null | Optional store sku supplied by this operation. Null means unknown. |
title | string | null | Source title when supplied. |
upc | string | null | Optional upc supplied by this operation. Null means unknown. |
url | string | null | Original source URL when supplied. |
videos | array | null | Optional videos supplied by this operation. Null means 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