> For the complete documentation index, see [llms.txt](https://docs.scraperapi.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.scraperapi.com/structured-data-endpoints/e-commerce/homedepot/migrating-from-bigbox-api-to-scraperapi.md).

# Migrating from BigBox API to ScraperAPI

### Overview

BigBox API is shutting down on November 2nd, 2026. From that date, Home Depot data is available exclusively through ScraperAPI’s Home Depot structured data endpoints for product, search and reviews.

Most integrations move over with small changes. This guide shows how each BigBox request maps to ScraperAPI, what changes in the response, and which BigBox features are not available so you can plan around them.

### Before you start

1. Create a ScraperAPI account at [dashboard.scraperapi.com](https://dashboard.scraperapi.com/signup) and copy your API key from the dashboard.
2. Claim your extended 30-day trial with 5,000 credits by replying to the migration email we sent you.
3. Choose sync or async. Sync is a single GET per request. Async lets you submit many item IDs or search terms in one POST and receive results by webhook.

ScraperAPI only charges for successful requests (HTTP 200 and 404). The `sa-credit-cost` response header shows what each request cost, and `GET /account` returns your remaining credits.

### Request mapping

BigBox selects the request type with a `type` query parameter on one `/request` endpoint. ScraperAPI uses one path per type under `/structured/homedepot/`, each with a sync GET and an async POST at `async.scraperapi.com`.

| BigBox request   | ScraperAPI endpoint                                                 | Status                         |
| ---------------- | ------------------------------------------------------------------- | ------------------------------ |
| `type=product`   | `GET /structured/homedepot/product`                                 | Supported, some fields missing |
| `type=search`    | `GET /structured/homedepot/search`                                  | Supported                      |
| `type=category`  | `GET /structured/homedepot/search` with a `/b/` browse URL in `url` | Partial                        |
| `type=reviews`   | `GET /structured/homedepot/reviews`                                 | Supported, no filters          |
| `type=questions` | None                                                                | Not available                  |

### Parameters

<table data-search="false"><thead><tr><th>BigBox parameter</th><th>ScraperAPI</th><th>Notes</th></tr></thead><tbody><tr><td><code>api_key</code></td><td><code>api_key</code></td><td>Async request bodies use <code>apiKey</code>.</td></tr><tr><td><code>item_id</code>, <code>gtin</code>, <code>url</code></td><td><code>item_id</code>, <code>gtin</code>, <code>url</code></td><td>Same precedence: <code>url</code>, then <code>gtin</code>, then <code>item_id</code>. A <code>gtin</code> must match exactly one product. If it doesn’t, Product SDE returns <code>"success": true</code> with <code>payload.message: "Product not found."</code>, and Reviews SDE returns <code>"success": false</code>.</td></tr><tr><td><code>search_term</code>, <code>sort_by</code>, <code>min_price</code>, <code>max_price</code>, <code>page</code></td><td>Same names</td><td>Same five <code>sort_by</code> values. Async requests send <code>page</code>, <code>min_price</code> and <code>max_price</code> as strings.</td></tr><tr><td><code>output</code></td><td><code>output_format</code></td><td>JSON only.</td></tr><tr><td><code>category_id</code></td><td>None</td><td>Send the Home Depot <code>/b/</code> URL as <code>url</code> on the search endpoint. Sort, price and page are ignored when <code>url</code> is set, so encode them in the URL or follow <code>pagination.next.link</code>.</td></tr><tr><td>None</td><td><code>item_ids</code>, <code>search_terms</code></td><td>Async only. Submit many items or terms in one POST.</td></tr><tr><td>None</td><td><code>callback</code></td><td>Async only. Webhook delivery of results.</td></tr></tbody></table>

### Response differences

Most field names are identical. ScraperAPI wraps all data in `payload` beside a `success` flag.

| What you read on BigBox                                                        | On ScraperAPI                                                                           |
| ------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------- |
| Data at the response root                                                      | `payload.*` (for example `payload.product.title`)                                       |
| `request_info.success`                                                         | `success`                                                                               |
| `request_info.credits_used`                                                    | `sa-credit-cost` response header                                                        |
| `request_info.credits_remaining`                                               | `creditsLeft` from `GET /account`                                                       |
| `request_metadata.*`, `request_parameters.*`                                   | Not returned. Async job objects echo the item ID or search term and sort order.         |
| `offers.primary.symbol` (search) and `buybox_winner.currency_symbol` (product) | Same names. Product uses `currency_symbol` and search uses `symbol` for the same value. |

#### What’s richer on ScraperAPI

* **Search delivery details:** each result includes store, price, start and end date and a delivery label for ship to home and scheduled delivery. BigBox returns these only on the product page.
* **Async batching:** submit arrays of item IDs or search terms in one POST, get results by webhook, and retrieve them for up to 72 hours (24 hours guaranteed).
* `is_limited_quantity` on search pickup info.

### Features not available on ScraperAPI

Check this list against your integration first. If you rely on any of these, plan a workaround before the shutdown date or contact support to discuss your use case.

<table data-search="false"><thead><tr><th>BigBox feature</th><th>Status on ScraperAPI</th><th>Workaround</th></tr></thead><tbody><tr><td>Zip code and store targeting (<code>customer_zipcode</code>, Zipcodes API)</td><td>Results are localized to a default Home Depot store (returned in <code>location_info</code>). Selecting a specific store or ZIP code is not currently supported, so fulfillment data (pickup, ship-to-store, stock levels) reflects that default store only.</td><td>None for store-level price and stock.</td></tr><tr><td>In-store aisle and bay</td><td>Not available</td><td>None</td></tr><tr><td>Fulfillment on the product endpoint (pickup, ship to home, ship to store, scheduled delivery)</td><td>Not available on product. Available on search results.</td><td>Search by the product’s model number and use the result whose <code>model_number</code> matches exactly. Searching by item ID doesn’t work, because Home Depot redirects it to the product page.</td></tr><tr><td>Product variants</td><td>Not available. <code>parent_id</code> is returned.</td><td>Group products by <code>parent_id</code>.</td></tr><tr><td><code>was_price</code> (product) and <code>regular_price</code> (search)</td><td>Available. Each is returned only when the product is discounted.</td><td>None</td></tr><tr><td><code>favorite_count</code>, <code>is_top_rated</code> on product, <code>collection</code> on product</td><td>Not available. Home Depot doesn’t show it publicly.</td><td>None</td></tr><tr><td>Search sponsored flag and tile features</td><td>Not available</td><td>None</td></tr><tr><td>Review filters: <code>sort_by</code>, star filters, reviewer type, <code>search_term</code></td><td>Not available</td><td>Page through all reviews and filter by date, rating and <code>source.verified_purchase</code> on your side.</td></tr><tr><td>Reviewer videos</td><td>Not available</td><td>None</td></tr><tr><td>Reviews by <code>gtin</code> or product URL beyond the first 10</td><td>Returns the 1st page only (10 reviews)</td><td>Use <code>item_id</code> to page through all reviews.</td></tr><tr><td>Questions and answers (<code>type=questions</code>)</td><td>Not available</td><td>None</td></tr><tr><td>Categories API and category discovery (<code>category_list</code>, landing page detection)</td><td>Not available</td><td>Browse Home Depot to find the <code>/b/</code> URL, then send it as <code>url</code> to the search endpoint.</td></tr><tr><td><code>max_page</code> (several pages in one call)</td><td>Not available</td><td>Request each page</td></tr><tr><td>CSV and HTML output, <code>csv_fields</code>, <code>include_html</code></td><td>Not available. JSON only.</td><td>Convert JSON to CSV on your side. For raw HTML, send the Home Depot page URL to the standard ScraperAPI endpoint instead of the structured endpoint and parse it yourself.</td></tr><tr><td>Collections (scheduled bulk runs up to 15,000 requests)</td><td>Replaced by DataPipeline, which supports Home Depot.</td><td>Create a DataPipeline project to run your Home Depot requests on a schedule, or use async batches with your own scheduler and a webhook.</td></tr><tr><td>Destinations (S3, GCS, Azure, Alibaba OSS)</td><td>Not available</td><td>Receive results by webhook and write them to your bucket.</td></tr><tr><td>Error logs API and <code>skip_on_incident</code></td><td>Not available</td><td>ScraperAPI charges only successful requests (HTTP 200 and 404).</td></tr><tr><td><code>skip_gtin_cache</code></td><td>Not needed</td><td>GTIN lookups aren’t cached, so every request resolves fresh.</td></tr></tbody></table>

### Migration checklist

* \[ ] Review the features table above and confirm nothing you depend on is missing
* \[ ] Create your ScraperAPI account and reply to the migration email to claim your 30-day trial
* \[ ] Swap the BigBox base URL and `type` parameter for the matching `/structured/homedepot/` endpoint
* \[ ] Rename `output` to `output_format` and remove `customer_zipcode`, `max_page`, `csv_fields` and `include_html`
* \[ ] Update your parsers to read from `payload` and `success`
* \[ ] Move category requests to the search endpoint with a `/b/` URL
* \[ ] Replace Collections and Destinations with async batches, a scheduler and a webhook, or create a project using DataPipeline
* \[ ] Switch production traffic before November 2, 2026

### Beyond Home Depot

Your ScraperAPI account covers far more than Home Depot. It’s web data infrastructure for any public site, with one team accountable for keeping your data flowing.

* **Any site, one API.** ScraperAPI handles proxies, CAPTCHAs and JavaScript rendering, and you can step up with `premium`, `render` or `ultra_premium` when a target gets harder.
* **Structured data for popular sources.** Ready-made JSON endpoints for Amazon, Walmart, eBay and Google sit alongside Home Depot.
* **AI Parser.** Describe the fields you want and get structured JSON from sites without a ready-made endpoint.
* **The whole pipeline.** Crawler finds pages, Async handles volume, DataPipeline runs scraping on a schedule without code, and webhooks send results where you need them.
* **Agent-ready.** Connect through the MCP server, n8n, Zapier, LangChain or LlamaIndex.
* **Maintained for you.** When a site changes its layout or adds a new block, our engineers fix it, so your team doesn’t have to.

### Getting help

* Documentation: [Home Depot structured data endpoints](https://docs.scraperapi.com/structured-data-endpoints/e-commerce/homedepot)
* Support: contact <support@scraperapi.com> with questions about setting up your account or mapping your requests.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.scraperapi.com/structured-data-endpoints/e-commerce/homedepot/migrating-from-bigbox-api-to-scraperapi.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.