> Documentation index: https://docs.scrapier.io/llms.txt
> Auth: header `X-API-Key: <key>` · Base: https://api.scrapier.io/api/v2 · Synchronous; paginate with `cursor` ← `data.next_cursor`.

# Walmart Data Extractor

Structured Walmart data: send `urls`. Cursor-paginated, 1 credit per successful call.

`GET|POST https://api.scrapier.io/api/v2/walmart-data-extractor/` · 1 credit per successful call · Cursor-paginated

## Overview

Call `GET /api/v2/walmart-data-extractor/` with `urls`. The results are in `data.products`; send `data.next_cursor` back as `cursor` to get the next page. 4 optional parameters refine the call (see Parameters).

## Request

```bash
curl -G "https://api.scrapier.io/api/v2/walmart-data-extractor/" \
  -H "X-API-Key: YOUR_API_KEY" \
  --data-urlencode "urls=laptop" \
  --max-time 210
```

```python
import requests

resp = requests.get(
    "https://api.scrapier.io/api/v2/walmart-data-extractor/",
    headers={"X-API-Key": "YOUR_API_KEY"},
    params={"urls": "laptop"},
    timeout=210,
)
body = resp.json()
if not resp.ok:
    raise RuntimeError(body.get("error") or body.get("detail"))

print(body["data"]["products"])
```

POST with a JSON body works too (same parameters; the body is merged over the query string).

## Parameters

| Name | Type | Required | Default | Description |
|---|---|---|---|---|
| `X-API-Key` (header) | string | yes | — | Your API key. |
| `urls` | string | yes | e.g. `laptop` | Walmart listing (/search?q=, /browse/, /shop/) or product (/ip/) URL, or a plain keyword. Required first call. One listing page (~40-60 products, each enriched from its product page; detail_fetched=false if that missed the time budget) per call. |
| `cursor` | string | no | — | Pagination cursor returned in the previous response's `next_cursor`. Pass it back unchanged to fetch the next page. When `next_cursor` is null, you have reached the last page. |
| `include_details` | boolean | no | `false` | Also fetch each product page (seller, UPC, variants, full description). Much heavier; default false returns listing-card data. Locked in cursor. |
| `include_reviews` | boolean | no | `false` | Attach reviews to each product. Locked in cursor. |
| `zip_code` | string | no | — | 5-digit US delivery ZIP hint. Locked in cursor. |
| `use_proxy` | boolean | no | `true` | Route the request through Scrapier's residential proxy pool. Default: `true`. Leave as is unless support tells you otherwise. |
| `raw_data` | boolean | no | `false` | When true, the response carries the full raw upstream payload(s) the scraper received (GraphQL / JSON API bodies, HTML, embedded JSON-LD -- exactly as the platform returned them) under `raw_responses`, in place of the formatted items. When false (default) you get the formatted output. Pagination (`cursor` / `next_cursor`) works the same in both modes. |

## Response

HTTP 200. Results are in `data.products`. Sample from the live catalog, arrays trimmed to 3 items.

```json
{
  "success": true,
  "data": {
    "urls": "https://www.walmart.com/search?q=laptop",
    "page": 1,
    "page_size": 58,
    "details_fetched": 56,
    "products": [
      {
        "name": "Acer Chromebook 315 15.6” Full HD Laptop, 8GB RAM 128GB, ChromeOS",
        "us_item_id": "20349310960",
        "brand": "Acer",
        "seller_name": "Walmart.com",
        "price_info": {
          "current_price": {
            "price": 199,
            "price_string": "$199.00",
            "currency_unit": "USD"
          }
        },
        "canonical_url": "/ip/Acer-Chromebook-315-.../20349310960",
        "detail_fetched": true,
        "input_url": "https://www.walmart.com/search?q=laptop",
        "scraped_at": "2026-09-15T00:00:00.000Z"
      }
    ],
    "next_cursor": "eyJ1IjoiaHR0cHM6Ly93d3cud2FsbWFydC5jb20vc2VhcmNoP3E9bGFwdG9wIiwicCI6Mn0"
  }
}
```

## Response fields

| Field | Type | Example | Description |
|---|---|---|---|
| `urls` | string | `https://www.walmart.com/search?q=laptop` |  |
| `page` | integer | `1` |  |
| `page_size` | integer | `58` |  |
| `details_fetched` | integer | `56` |  |
| `products` | array | `[1 item]` | The results. |
| `next_cursor` | string | `eyJ1IjoiaHR0cHM6Ly93d3cud2FsbWFydC5jb20vc2Vhc…` | Pass back as `cursor` for the next page. `null` on the last page. |
| `products[].name` | string | `Acer Chromebook 315 15.6” Full HD Laptop, 8GB…` |  |
| `products[].us_item_id` | string | `20349310960` |  |
| `products[].brand` | string | `Acer` |  |
| `products[].seller_name` | string | `Walmart.com` |  |
| `products[].price_info` | object | `{…}` |  |
| `products[].canonical_url` | string | `/ip/Acer-Chromebook-315-.../20349310960` |  |
| `products[].detail_fetched` | boolean | `true` |  |
| `products[].input_url` | string | `https://www.walmart.com/search?q=laptop` |  |
| `products[].scraped_at` | string | `2026-09-15T00:00:00.000Z` |  |

## Pagination

Pass `data.next_cursor` back as `cursor` until it is `null`. Required inputs are ignored once a cursor is sent. Each page is one billed call.

```python
import requests

URL = "https://api.scrapier.io/api/v2/walmart-data-extractor/"
HEADERS = {"X-API-Key": "YOUR_API_KEY"}
params = {"urls": "laptop"}
items = []

for _ in range(10):  # each page is one billed call
    resp = requests.get(URL, headers=HEADERS, params=params, timeout=210)
    resp.raise_for_status()
    data = resp.json()["data"]
    items.extend(data.get("products") or [])
    if not data.get("next_cursor"):  # None = last page
        break
    params = {"cursor": data["next_cursor"]}
```

## Errors

Failed calls are free. Branch on HTTP status; the message is in `error` (or `detail`). See https://docs.scrapier.io/errors.md

- **400** Bad input. The exact message varies by endpoint. `{"success":false,"error":"…"}`
- **402** Balance below the endpoint's price. `{"error":"Insufficient credits. Buy more to scrape more.","balance":1,"required":2}`
- **403** Invalid or unknown API key. `{"detail":"Authentication service unavailable or invalid API key."}`
- **429** Throttled — wait for Retry-After. `{"detail":"Request was throttled. Expected available in N seconds."}`
- **404** unknown slug · **503** busy (retry after `Retry-After`) · **5xx** upstream failure or timeout (retry with backoff).

## Notes

- Locked into the cursor: `include_details`, `include_reviews`, `zip_code`. Set them on the first call; later pages reuse them.

## Related

- [Walmart Category](https://docs.scrapier.io/api-reference/walmart/walmart-category.md): Structured Walmart data: send `urls`. Cursor-paginated, 1 credit per successful call.
- [Walmart Reviews](https://docs.scrapier.io/api-reference/walmart/walmart-reviews.md): Structured Walmart data: send `urls`. Cursor-paginated, 1 credit per successful call.
- [Walmart Search Scraper](https://docs.scrapier.io/api-reference/walmart/walmart-search-scraper.md): Structured Walmart data: send `queries`. Cursor-paginated, 1 credit per successful call.
