# ScrapingBee Walmart Search API

> Search Walmart and receive structured product and facet data.

## Endpoint and authentication

- Endpoint: `https://app.scrapingbee.com/api/v1/walmart/search`
- Required input: `query`.
- Authentication: `Authorization: Bearer YOUR_API_KEY`.
- The `api_key` query parameter remains supported for backward compatibility but is deprecated for new integrations.
- Response format: structured JSON.

## Request controls

| Parameter | Default / behavior |
| --- | --- |
| `query` | Required Walmart search text; URL-encode special characters. |
| `light_request` | `true`; set `false` for browser-rendered results. |
| `start_page` | `1`; selects one Walmart result page. No multi-page aggregation parameter is documented. |
| `min_price`, `max_price` | Integer price filters. |
| `sort_by` | `best_match` (default), `price_low`, `price_high`, or `best_seller`. |
| `device` | `desktop` (default), `mobile`, or `tablet`; results can differ by layout. |
| `domain` | Optional Walmart domain for localization, for example `com`. |
| `fulfillment_speed` | `today`, `tomorrow`, `2_days`, or `anytime`. |
| `fulfillment_type` | `in_store` for pickup-available items. |
| `delivery_zip`, `store_id` | Delivery ZIP or a specific Walmart store. Store IDs are published at `https://www.scrapingbee.com/download/walmart_stores.json`. |
| `add_html` | `false` by default; set `true` to include the HTML. |
| `screenshot` | Forces a browser screenshot. |
| `tag` | Response-header label only. |

## Rendering, cost, and response

- Light requests do not use a browser and can omit data returned by a regular request. Use `light_request=false` when completeness matters.
- Cost: 10 credits for a successful light request or 15 for a regular request. `screenshot=true` costs 15 credits, ignores `light_request`, and returns a base64-encoded image.
- Failed searches are retried by ScrapingBee for up to 30 seconds. Account for that server-side retry window in client timeouts.
- The source front matter claims `parse=false` returns HTML but does not define the parameter in the endpoint contract. Use `add_html=true` for documented HTML output.
- The response contains `meta_data` (`url`, result/product counts, page, and `total_pages`), `products`, `facets`, and `location` (`zip_code`, `store_id`). Product objects can include numeric `product_id`, position, title, price/currency, rating/review count, availability, image, URL, brand, seller, and `prime`, free-shipping, and two-day-shipping flags. Facets include brand counts, price ranges, and rating counts.