# Walmart Search API (https://www.socialcrawl.dev/platforms/walmart/search)

> Returns Walmart search results for a keyword: title, product id, URL, image, price, rating, review count, availability, seller, and shipping and pickup flags per product, with optional price, location, and store filters. A small number of rows carry no price even when in stock, in which case product.price.current is null rather than zero; call GET /v1/walmart/product with the returned product id for a guaranteed price. Also serves as the keyword-to-product-id resolver for the rest of the Walmart API.

TL;DR: `GET /v1/walmart/search` costs 5 credits per call and returns SocialCrawl's unified JSON schema. Single x-api-key auth, 100 free credits on signup.

## Parameters

| Parameter | Required | Description |
| --- | --- | --- |
| `query` | yes | Search keyword or phrase. |
| `page` | no | Page number, starting at 1. Prefer the universal cursor parameter. |
| `sort_by` | no | Result ordering: best_match (default), price_low, price_high, best_seller, or top_rated. (best_match \| price_low \| price_high \| best_seller \| top_rated) |
| `min_price` | no | Lowest price to include. Must be below max_price when both are set. Applied by Walmart and approximate: it narrows the result set but occasionally returns a row outside the bound, so filter on product.price.current if you need a hard limit. |
| `max_price` | no | Highest price to include. Must be above min_price when both are set. Applied by Walmart and approximate: it narrows the result set but occasionally returns a row outside the bound, so filter on product.price.current if you need a hard limit. |
| `zip_code` | no | ZIP code used to localise availability, pickup, and shipping options. Walmart pricing and stock are store-level, so results differ by location. |
| `state` | no | Two-letter US state code used to localise results (for example CA, NY). |
| `store_id` | no | Walmart store id, to restrict results to one physical store's assortment. |
| `facet` | no | Opaque refinement token taken from a previous response's facet data (for example a brand or category filter). |
| `country` | no | Walmart marketplace as a two-letter country code: US (walmart.com, default) or CA (walmart.ca). A product id from one marketplace will not resolve in the other. (US \| CA) |

## Code example

```bash
curl "https://www.socialcrawl.dev/v1/walmart/search?query=airpods%20pro" \
  -H "x-api-key: sc_YOUR_API_KEY"
```

## FAQ

### What does Walmart search return?

Each result carries the product id, title, URL, image, price, rating, review count, availability, seller and the shipping and pickup flags. The product id is the key you pass to the product, reviews and offers endpoints.

### Does Walmart search return prices?

Yes. Search rows carry the current and list price. A small number of in-stock rows come back without one, and in that case price.current is null rather than zero, so you can tell a missing price from a free item.

### How many results come back per call?

Around 40 per page, and you page with the standard cursor parameter. Consecutive pages do not repeat products, so a crawl of several pages does not pay for the same row twice.

### Can I filter search results?

Yes. You can narrow by price range, sort order, ZIP code, state and store id. Walmart applies the price bounds loosely, so filter on product.price.current yourself if you need a hard limit.

### What happens if a search returns nothing?

You get an empty list and the credits are refunded automatically, so a query that matches no products costs nothing.

See the full Walmart API: https://www.socialcrawl.dev/platforms/walmart

## Pricing

- Standard endpoints: 1 credit per call
- Advanced endpoints: 5 credits per call
- Premium endpoints: 10 credits per call
- 100 free credits on signup, no credit card required. Cached responses cost 0 credits. Credit packs never expire.
- Full pricing: https://www.socialcrawl.dev/pricing

## Explore with AI

Questions this API answers, phrased for an AI assistant:

- How to search Walmart products by keyword with an API
- Walmart API to turn a keyword into a product id