Skip to main content
Piloterr
Back to library

Walmart Suggest API

Get Walmart.com search autocomplete suggestions for a keyword via browser rendering, with optional US ZIP code localization.

Active2 credits = 1 requestGET/v2/walmart/suggest

Endpoint Overview

Detailed documentation, pricing, and usage examples.

OverviewLink to Overview

Return search autocomplete suggestions from the Walmart.com typeahead — the same query expansions shoppers see while typing in the search bar.

Walmart injects suggestions dynamically after JavaScript runs. Piloterr uses website rendering to load walmart.com in a browser, trigger the typeahead for your keyword, and return structured suggestion objects with display labels, thumbnail images, and internal query strings.

Pair this endpoint with Walmart Search (full results page) and Walmart Product (PDP details) to build a complete discovery pipeline.

QuickstartLink to Quickstart

GET https://api.piloterr.com/v2/walmart/suggest?query=apples

With optional ZIP localization:

GET https://api.piloterr.com/v2/walmart/suggest?query=apples&zipcode=95829

Or via POST:

POST https://api.piloterr.com/v2/walmart/suggest
Content-Type: application/json

{"query": "apples"}

ParametersLink to Parameters

Parameter Type Required Description
query string yes Partial or full search keyword (e.g. apples)
zipcode string no Optional 5-digit US ZIP code for localized store context

Response fieldsLink to Response fields

Field Type Description
results array Autocomplete suggestions returned by Walmart
results[].display_name string Label shown in the typeahead dropdown
results[].url string Internal query string (e.g. query=applesauce&typeahead=apples)
results[].type string Suggestion type (typically QUERY)
results[].image_url string Thumbnail image for the suggested category or product
results[].analytics_fm number Walmart analytics metadata attached to the suggestion

WorkflowLink to Workflow

  1. Suggest — discover related queries from a partial keyword
  2. Search — pass https://www.walmart.com/search?q=<term> to get product cards
  3. Product — pass any result /ip/ URL for full PDP data

NotesLink to Notes

  • Returns query-level suggestions, not full product listings.
  • zipcode is optional — omit it when you only need generic query suggestions.
  • When provided, the ZIP code affects localized store and inventory context on walmart.com.
  • Build the search URL from a suggestion: https://www.walmart.com/search?q=<display_name>.
  • Costs 2 credits per call (browser rendering).

Main use casesLink to Main use cases

  • Power typeahead UIs with live Walmart search suggestions
  • Discover high-intent query expansions from partial keywords
  • Feed keyword research and SEO pipelines for US grocery and retail
  • Localize suggestion context by ZIP code when store-level intelligence is needed

Related APIs

Expand your data capabilities with these complementary tools.

Ready to get started?

Your web scraping API is one click away. Start with +500 credits, no infrastructure to set up, no proxies to manage, and no credit card required.

  • +500 credits
  • No credit card required
  • All endpoints included