> **For coding agents and LLMs:** This is one page from the Social Fetch docs (markdown export). For curated orientation and workflow guidance, start with [`/llms.txt`](https://www.socialfetch.dev/llms.txt); for agent onboarding and crawl rules, use [`/agents.txt`](https://www.socialfetch.dev/agents.txt); for the full endpoint list with links to pages like this one, use [`/llms-endpoints.txt`](https://www.socialfetch.dev/llms-endpoints.txt); for one platform's parameters and curls, use [`/llms-{platform}.txt`](https://www.socialfetch.dev/llms-tiktok.txt); use [`/llms.json`](https://www.socialfetch.dev/llms.json) when you need structured JSON for tool registration.

## This page

- **On-site (HTML):** <https://www.socialfetch.dev/docs/api/v1/home-depot/product/get>
- **Markdown (.mdx) URL:** <https://www.socialfetch.dev/docs/api/v1/home-depot/product/get.mdx>

## API base URL and authentication

- **API origin (from OpenAPI `servers`):** `https://api.socialfetch.dev`
- **Authentication:** send `x-api-key: sfk_...` on `/v1/**` and `/v2/**` routes unless the operation is explicitly anonymous (check OpenAPI `security`, the [API reference hub](https://www.socialfetch.dev/docs/api.mdx), [`/llms.txt`](https://www.socialfetch.dev/llms.txt), or [`/llms.json`](https://www.socialfetch.dev/llms.json) for each route).
- **OpenAPI JSON:** <https://www.socialfetch.dev/openapi.json>

## Recommended docs entrypoints (this site)

- [Documentation overview](https://www.socialfetch.dev/docs.mdx) — top-level orientation (markdown).
- [Quickstart](https://www.socialfetch.dev/docs/quickstart.mdx) — authenticate with `x-api-key`, validate auth with `whoami`, and understand the JSON envelope.
- [SDK](https://www.socialfetch.dev/docs/sdk.mdx) — official TypeScript SDK guide, including `SocialFetchClient`, `Result`, and `unwrap()`.
- [Capability matrix](https://www.socialfetch.dev/docs/capability-matrix.mdx) — every operation with identifiers, pagination, outcomes, media download, credits, and its SDK method. Generated from OpenAPI, so use it for route selection instead of scanning individual pages.
- [Recipes](https://www.socialfetch.dev/docs/recipes.mdx) — copyable workflows (brand monitoring, transcripts, Ad Library, creator scoring, Reddit research) with credit callouts and SDK examples.
- [Integrations](https://www.socialfetch.dev/docs/integrations.mdx) — MCP for AI clients, n8n verified node, Apify Store Actors, Make custom app, SDK, and REST API connection paths.
- [MCP product page](https://www.socialfetch.dev/mcp) — hosted MCP overview, OAuth, Skills install.
- [MCP integration](https://www.socialfetch.dev/docs/integrations/mcp.mdx) — hosted `/mcp` server, OAuth, Cursor/VS Code/Claude install snippets, 1112 endpoint tools, plus docs_search/docs_read for implementation help.
- [n8n integration](https://www.socialfetch.dev/docs/integrations/n8n.mdx) — install `n8n-nodes-socialfetch`, credentials, and workflow examples.
- [Apify integration](https://www.socialfetch.dev/docs/integrations/apify.mdx) — Store Actors under @social-fetch, PPE billing, dataset export, and quick start.
- [Make integration](https://www.socialfetch.dev/docs/integrations/make.mdx) — custom app modules for Make scenarios, API key credentials, and module catalog.
- [`/llms-endpoints.txt`](https://www.socialfetch.dev/llms-endpoints.txt) — every documented operation with a direct link to that route's agent-readable markdown page (prefer this over parsing OpenAPI).
- [`/llms-{platform}.txt`](https://www.socialfetch.dev/llms-tiktok.txt) — per-platform endpoint files generated from OpenAPI (parameters, credits, curls).
- [`/agents.txt`](https://www.socialfetch.dev/agents.txt) — agent crawl/onboarding file with capabilities, auth rules, and allowlist.
- [`/llms.json`](https://www.socialfetch.dev/llms.json) — structured machine-readable operation inventory with parameter names, pagination, outcomes, credits, and SDK mapping.
- [API reference hub](https://www.socialfetch.dev/docs/api.mdx) — human-friendly index of operations with links into generated pages.
- [Errors](https://www.socialfetch.dev/docs/errors.mdx) — shared error envelope and HTTP status guidance.
- [Credits](https://www.socialfetch.dev/docs/credits.mdx) — metering, `402`, and planning batch jobs.
- Outcome semantics such as `found`, `not_found`, and `private` are documented in [Errors](https://www.socialfetch.dev/docs/errors.mdx) and on operation pages when present in the OpenAPI contract.

## Markdown docs convention

- Every docs page has a markdown twin: append **`.mdx`** to the docs pathname (for example `/docs/quickstart` → `/docs/quickstart.mdx`).
- Agents that send `Accept: text/markdown` on `/docs/**` HTML URLs may receive markdown directly (same URL, `Vary: Accept`).
- Published blog posts use the same convention: `/blog/{slug}` → `/blog/{slug}.mdx`, or `Accept: text/markdown` on the HTML URL (`Vary: Accept`).

---
# Get Home Depot product (https://www.socialfetch.dev/docs/api/v1/home-depot/product/get)

## Summary

Get Home Depot product with its price, discount, rating, images, description, highlights, specifications, badges and categories.

**Tags:** `Home Depot`

## HTTP

- **Method:** GET
- **Path:** `/v1/home-depot/product`
- **Base URL:** `https://api.socialfetch.dev`

## Capability summary

- **SDK mapping:** `client.homeDepot.getProduct({ productId: "100497597" })`
- **Pagination:** none
- **Business outcome field:** `data.lookupStatus` with values `found`, `not_found`

## Credits

- 3 credits
- Failed requests are free
- Found, empty and not-found answers are all charged

## Authentication

- **`x-api-key`**: API key (`sfk_...`)

## Parameters

### `productId` (query)

- **Required:** yes
- **Constraints:** type `string`; minLength: 1; maxLength: 500
- **Description:** Home Depot item id, the Internet # on the product page (`100497597`), or product page URL (`https://www.homedepot.com/p/KitchenAid-Artisan-5-Qt-10-Speed-Pistachio-Green-Stand-Mixer-with-Flat-Beater-Wire-Whip-and-Dough-Hook-Attachments-KSM150PSPT/100497597`).

## Responses (status codes)

- **200**: A Home Depot product.
- **400**: Invalid request
- **401**: Missing or invalid API key
- **402**: Insufficient credits
- **500**: Unexpected or billing error
- **502**: Lookup could not be completed.
- **503**: Service temporarily unavailable; safe to retry with backoff.

## Response body (200)

A Home Depot product.

### Field outline

- **data** (required) — type `object`. Endpoint-specific response payload.
  - **lookupStatus** (required) — type `string`; enum: found, not_found. `not_found` when homedepot.com has no product with this item id.
  - **productId** (required) — type `string`. The item id looked up.
  - **product** (required) — type `object`; nullable. The product; null when not found.
    - **id** (required) — type `string`. Item id, the Internet # (`100497597`).
    - **url** (required) — type `string`. Product page URL.
    - **name** (required) — type `string`; nullable. Product name.
    - **brand** (required) — type `string`; nullable. Brand.
    - **brandUrl** (required) — type `string`; nullable. Brand page URL.
    - **modelNumber** (required) — type `string`; nullable. Model number.
    - **storeSku** (required) — type `string`; nullable. Store SKU number.
    - **upc** (required) — type `string`; nullable. UPC barcode.
    - **parentId** (required) — type `string`; nullable. Id of the product family the item belongs to.
    - **productType** (required) — type `string`; nullable. Product type, e.g. `MERCHANDISE`.
    - **description** (required) — type `string`; nullable. Description, plain text.
    - **highlights** (required) — type `array`. The highlight bullets above the fold.
      - _items:_
        - type `string`
    - **bullets** (required) — type `array`. The bullet list under the description.
      - _items:_
        - type `string`
    - **price** (required) — type `object`. The price.
      - **current** (required) — type `number`; nullable. The price shown, in US dollars; null when the site hides it.
      - **original** (required) — type `number`; nullable. The price before a discount, in US dollars; null without a discount.
      - **currency** (required) — type `string`; enum: USD. Always `USD`.
      - **unitOfMeasure** (required) — type `string`; nullable. What the price is for, e.g. `each` or `sq. ft.`.
      - **dollarOff** (required) — type `number`; nullable. Discount in US dollars; null without one.
      - **percentOff** (required) — type `number`; nullable. Discount in percent; null without one.
      - **promotion** (required) — type `string`; nullable. The promotion's text, e.g. `Save $40`; null without one.
    - **rating** (required) — type `number`; nullable. Average star rating out of 5; null with no reviews.
    - **reviewCount** (required) — type `integer`; nullable. Number of reviews.
    - **images** (required) — type `array`. Image URLs, 1000 px, main first.
      - _items:_
        - type `string`
    - **categories** (required) — type `array`. Category path, broadest first, e.g. `Appliances`.
      - _items:_
        - type `string`
    - **badges** (required) — type `array`. Badges on the product.
      - _items:_
    - **specifications** (required) — type `array`. Specifications, in the site's groups and order.
      - _items:_
    - **keyFeatures** (required) — type `array`. Key product features, e.g. `Small Electric Product Type`.
      - _items:_
    - **availability** (required) — type `string`; enum: IN_STOCK, LIMITED_STOCK, BACKORDERED, OUT_OF_STOCK, null; nullable. Stock status for a visitor with no store chosen: `IN_STOCK`, `LIMITED_STOCK`, `BACKORDERED` or `OUT_OF_STOCK` (no delivery or pickup option has it); null when the page does not say.
    - **channel** (required) — type `string`; nullable. How it is sold: `Online`, `Shared` (online and in store), `Store Only` or `Browse Only`; null when not shown.
    - **buyable** (required) — type `boolean`; nullable. Whether it can be ordered now: true in stock, limited or backordered, false out of stock or discontinued; null when the stock is not known.
    - **discontinued** (required) — type `boolean`; nullable. Whether it is discontinued.
    - **returnPolicy** (required) — type `string`; nullable. Return window, e.g. `90-Day`; null when not shown.
    - **quantityLimit** (required) — type `integer`; nullable. Most one order may hold; null when there is no limit.
- **meta** (required) — type `object`. Metadata describing the request and billing outcome.
  - **requestId** (required) — type `string`; minLength: 1. Unique request identifier for tracing this API call.
  - **creditsCharged** (required) — type `integer`; minimum: 0. Credits charged for this request.
  - **version** (required) — type `string`; enum: v1. Public API version that served the response.
  - **stale** (optional) — type `boolean`; enum: true. Present, and `true`, only when the source couldn't be reached and this is the last good answer for the same request instead, up to 24 hours old. Absent on every live answer.
  - **fetchedAt** (optional) — type `string`. When a stale answer (`stale: true`) was originally fetched (ISO 8601, UTC). Absent on every live answer.

### Example JSON (found)

```json
{
  "data": {
    "lookupStatus": "found",
    "productId": "100497597",
    "product": {
      "id": "100497597",
      "url": "https://www.homedepot.com/p/KitchenAid-Artisan-5-Qt-10-Speed-Pistachio-Green-Stand-Mixer-with-Flat-Beater-Wire-Whip-and-Dough-Hook-Attachments-KSM150PSPT/100497597",
      "name": "Artisan 5 Qt. 10-Speed Pistachio Green Stand Mixer with Flat Beater, Wire Whip and Dough Hook Attachments",
      "brand": "KitchenAid",
      "brandUrl": "https://www.homedepot.com/b/KitchenAid/N-5yc1vZue",
      "modelNumber": "KSM150PSPT",
      "storeSku": "1000249571",
      "upc": "050946889849",
      "parentId": "304349583",
      "productType": "MERCHANDISE",
      "description": "The KitchenAid KSM150PSPT Pistachio Green Artisan Series 325-Watt Stand Mixer with Stainless Steel Mixing Bowl is incredibly versatile and more than a mixer. With all the optional attachments, you can use it to make homemade pasta, stuff fresh sausage, whip up ice cream and give fruit a squeeze. This model has a 325-W…",
      "highlights": [
        "10-speed electric stand mixer with an elegant look"
      ],
      "bullets": [
        "Solid-state control provides speed adjustment"
      ],
      "price": {
        "current": 349.99,
        "original": null,
        "currency": "USD",
        "unitOfMeasure": "each",
        "dollarOff": null,
        "percentOff": null,
        "promotion": null
      },
      "rating": 4.86,
      "reviewCount": 20402,
      "images": [
        "https://images.thdstatic.com/productImages/d28aa4ad-06f5-42df-927f-82be3b4d4a3e/svn/pistachio-green-kitchenaid-stand-mixers-ksm150pspt-64_1000.jpg"
      ],
      "categories": [
        "Appliances"
      ],
      "badges": [
        {
          "name": "top rated",
          "label": "Top Rated",
          "message": "Top Rated in Small Kitchen Appliances"
        }
      ],
      "specifications": [
        {
          "group": "Details",
          "name": "Appliance Series",
          "value": "Not Applicable"
        }
      ],
      "keyFeatures": [
        {
          "name": "Small Electric Product Type",
          "value": "Stand Mixer"
        }
      ],
      "availability": null,
      "channel": "Online",
      "buyable": null,
      "discontinued": false,
      "returnPolicy": "90-Day",
      "quantityLimit": 2
    }
  },
  "meta": {
    "requestId": "req_01example_home_depot_product",
    "creditsCharged": 3,
    "version": "v1"
  }
}
```

### Machine-readable error codes

When an error JSON body is returned, it may include one of these `error.code` values (derived from the OpenAPI schemas for this operation; additional codes may exist at runtime):

- `bad_request`

## Error handling & retries

Interpret HTTP status codes using the descriptions below. Do not assume a JSON body unless the OpenAPI schema defines one for that status.

- **400**: Invalid request **Retry:** Fix the request; retrying the same invalid payload will not help.
- **401**: Missing or invalid API key **Retry:** Fix the API key first; retrying without changes will not help.
- **402**: Insufficient credits **Retry:** Do not retry without resolving billing/credits (retrying the same request will not help).
- **500**: Unexpected or billing error
- **502**: Lookup could not be completed. **Retry:** May be transient; a few retries with backoff are reasonable.
- **503**: Service temporarily unavailable; safe to retry with backoff. **Retry:** Usually safe to retry with exponential backoff and jitter.

### Suggested client defaults

- Send the API key using the `x-api-key` header on every request.
- On `503` (and sometimes `502`), retry with backoff; cap retries and surface a clear error to the user.
- On `402`, surface an actionable billing message rather than blind retries.

## Examples

### TypeScript SDK

```typescript
import { SocialFetchClient } from "@socialfetch/sdk";

const client = new SocialFetchClient({
  apiKey: process.env.SOCIALFETCH_API_KEY!,
});

const result = await client.homeDepot.getProduct({
  productId: "100497597",
});

if (!result.ok) {
  console.error(result.error);
} else {
  console.log(result.value.data);
}
```

### Node.js

```javascript
const response = await fetch(
  "https://api.socialfetch.dev/v1/home-depot/product?productId=100497597",
  {
    headers: {
      "x-api-key": "YOUR_API_KEY"
    }
  }
);

const data = await response.json();
console.log(data);
```

### cURL

```bash
curl "https://api.socialfetch.dev/v1/home-depot/product?productId=100497597" \
  -H "x-api-key: YOUR_API_KEY"
```

### Python

```python
import requests

response = requests.get(
    "https://api.socialfetch.dev/v1/home-depot/product?productId=100497597",
    headers={"x-api-key": "YOUR_API_KEY"},
)
data = response.json()
print(data)
```