Walmart Autocomplete API Documentation

GET   /api/v1/search?engine=walmart_autocomplete

The Walmart Autocomplete API returns the suggestions Walmart's search box shows while a keyword is being typed, in the order Walmart shows them, along with the Selections row of shortcuts Walmart places above them. Any query suggestion's value can be passed as the q of the Walmart Search API to run that search.

API Parameters

Search Query

  • Name
    q
    Required
    Required
    Description

    The partial or full keyword to autocomplete (e.g. ipho). Returns the suggestions Walmart's search box shows for that text, in the order Walmart shows them. Up to 200 characters. Pass any query suggestion's value as the q of the Walmart Search API to run that search.

Pagination

  • Name
    num
    Required
    Optional
    Description

    The number of query suggestions to return, from 1 to 50. The Selections row, when Walmart shows one, comes in addition. Default: 10, as many as Walmart's search box shows. Walmart returns every query suggestion it has when it has fewer, usually between 40 and 50 for a common prefix.

Engine

  • Name
    engine
    Required
    Required
    Description

    Parameter defines an engine that will be used to retrieve real-time data. It must be set to walmart_autocomplete.

API key

  • Name
    api_key
    Required
    Required
    Description

    The api_key authenticates your requests. Use it as a query parameter (https://www.searchapi.io/api/v1/search?api_key=YOUR_API_KEY) or in the Authorization header (Bearer YOUR_API_KEY).

Zero Data Retention

  • Name
    zero_retention
    Enterprise Only
    Enterprise Only
    Required
    Optional
    Description

    Set this parameter to true to disable all logging and persistent storage. No request parameters, HTML, or JSON responses are stored or logged. Suitable for high-compliance use cases. Debugging and support may be limited while enabled.

API Examples

Suggestions

Suggestions

Each suggestion carries its position, its type and its value. A query suggestion links to its Walmart search and, when Walmart shows one, to a product thumbnail. Most answers start with a refinement row, the Selections row Walmart shows above the suggestions, whose options open categories, filtered searches, brand pages and products. An option carries what its page needs as parameters: a value, category_id and filters for the Walmart Search API, or a product_id for the Walmart Product API. Use the option's value as q. For a category option without a value, use its own title (for example, Ground coffee) as q, together with its category_id and filters. Intent shortcuts such as Get it today may not translate into an equivalent search query; follow the option's original link to preserve that selection. The row's own value is the text Walmart names it after, often the typed prefix. search_information.query_displayed is the query as Walmart read it, lowercased.

GET
https://www.searchapi.io/api/v1/search?engine=walmart_autocomplete&q=ipho
Request
import requests

url = "https://www.searchapi.io/api/v1/search"
params = {
  "engine": "walmart_autocomplete",
  "q": "ipho"
}

response = requests.get(url, params=params)
print(response.text)
Response
{
  "search_metadata": {
    "id": "search_ivDQ1Bc9VpTyAuc4q6xbVFq3",
    "status": "Success",
    "created_at": "2026-11-12T13:19:22Z",
    "request_time_taken": 1.78,
    "parsing_time_taken": 0.01,
    "total_time_taken": 1.79,
    "request_url": "https://www.walmart.com/search?q=ipho",
    "html_url": "https://www.searchapi.io/api/v1/searches/search_ivDQ1Bc9VpTyAuc4q6xbVFq3.html",
    "json_url": "https://www.searchapi.io/api/v1/searches/search_ivDQ1Bc9VpTyAuc4q6xbVFq3"
  },
  "search_parameters": {
    "engine": "walmart_autocomplete",
    "q": "ipho",
    "num": 10
  },
  "search_information": {
    "query_displayed": "ipho"
  },
  "suggestions": [
    {
      "position": 1,
      "type": "refinement",
      "value": "Ipho",
      "title": "Ipho Selections",
      "options": [
        {
          "title": "iPhone 17e",
          "value": "iphone 17e",
          "link": "https://www.walmart.com/search?q=iphone+17e",
          "thumbnail": "https://i5.walmartimages.com/dfw/4ff9c6c9-45e7/k2-_8467c9a9-d3b9-4278-9e3d-eb90ef79d937.v1.png"
        },
        {
          "title": "iPhone 16",
          "category_id": "1105910_7551331_1127173",
          "filters": "model_name:iPhone 16||model_name:iPhone 16 Plus||model_name:iPhone 16 Pro||model_name:iPhone 16 Pro Max",
          "link": "https://www.walmart.com/browse/cell-phones/apple-iphone/1105910_7551331_1127173?facet=model_name%3Ai...",
          "thumbnail": "https://i5.walmartimages.com/dfw/4ff9c6c9-3f98/k2-_16703952-1c89-4d75-958c-daa07d3a6398.v1.png"
        },
        {
          "title": "AirPods Pro 3",
          "product_id": "17835006350",
          "link": "https://www.walmart.com/ip/AirPods-nbsp-Pro-nbsp-3/17835006350",
          "thumbnail": "https://i5.walmartimages.com/dfw/4ff9c6c9-c584/k2-_a1fac6ee-1971-4de0-a289-ce4fdd16ba76.v1.png"
        },
        "..."
      ]
    },
    {
      "position": 2,
      "type": "query",
      "value": "iphone",
      "link": "https://www.walmart.com/search?q=iphone",
      "thumbnail": "https://i5.walmartimages.com/asr/1c1e8882-6647-4f95-b6da-39183898618c.0b325bb079e2cd662542f5c50717c5..."
    },
    {
      "position": 3,
      "type": "query",
      "value": "iphone unlocked",
      "link": "https://www.walmart.com/search?q=iphone+unlocked"
    },
    {
      "position": 4,
      "type": "query",
      "value": "iphone 13",
      "link": "https://www.walmart.com/search?q=iphone+13",
      "thumbnail": "https://i5.walmartimages.com/asr/8a8b19fd-3a87-4fe7-ad58-105158e003eb.4890ddefe870ceac7459f4188d0f1c..."
    },
    "..."
  ]
}

More Suggestions

More Suggestions

With num set, the answer holds up to that many query suggestions, deeper into Walmart's list than its search box shows. The Selections row, when Walmart shows one, comes first and is in addition to num.

GET
https://www.searchapi.io/api/v1/search?engine=walmart_autocomplete&num=20&q=milk
Request
import requests

url = "https://www.searchapi.io/api/v1/search"
params = {
  "engine": "walmart_autocomplete",
  "q": "milk",
  "num": 20
}

response = requests.get(url, params=params)
print(response.text)
Response
{
  "search_metadata": {
    "id": "search_1p7y6l9mIsfoaIpFCv2GPSzF",
    "status": "Success",
    "created_at": "2026-11-12T13:19:25Z",
    "request_time_taken": 1.24,
    "parsing_time_taken": 0.01,
    "total_time_taken": 1.26,
    "request_url": "https://www.walmart.com/search?q=milk",
    "html_url": "https://www.searchapi.io/api/v1/searches/search_1p7y6l9mIsfoaIpFCv2GPSzF.html",
    "json_url": "https://www.searchapi.io/api/v1/searches/search_1p7y6l9mIsfoaIpFCv2GPSzF"
  },
  "search_parameters": {
    "engine": "walmart_autocomplete",
    "q": "milk",
    "num": 20
  },
  "search_information": {
    "query_displayed": "milk"
  },
  "suggestions": [
    {
      "position": 1,
      "type": "refinement",
      "value": "Milk",
      "title": "Milk Selections",
      "options": [
        {
          "title": "Shop all milk",
          "category_id": "976759_9176907_4405816",
          "link": "https://www.walmart.com/browse/food/milk/976759_9176907_4405816",
          "thumbnail": "https://i5.walmartimages.com/dfw/4ff9c6c9-d084/k2-_878abb63-0788-4764-8199-4b641ad665b4.v1.jpg"
        },
        {
          "title": "Whole milk",
          "category_id": "976759_9176907_4405816_6541475_6877499",
          "link": "https://www.walmart.com/browse/food/whole-milk/976759_9176907_4405816_6541475_6877499",
          "thumbnail": "https://i5.walmartimages.com/dfw/4ff9c6c9-d1ad/k2-_dbfa6e0f-06f6-4a30-afc6-83195e508859.v1.png"
        },
        "..."
      ]
    },
    {
      "position": 2,
      "type": "query",
      "value": "milk",
      "link": "https://www.walmart.com/search?q=milk",
      "thumbnail": "https://i5.walmartimages.com/asr/6a7b09b4-f51d-4bea-a01c-85767f1b481a.86876244397d83ce6cdedb030abe6e..."
    },
    {
      "position": 3,
      "type": "query",
      "value": "milk 2%",
      "link": "https://www.walmart.com/search?q=milk+2%25",
      "thumbnail": "https://i5.walmartimages.com/asr/22a6459a-13b6-4057-aeae-45e62c69e8f8.47f793426ff66fa6432c948d836704..."
    },
    "...",
    {
      "position": 21,
      "type": "query",
      "value": "milky way candy",
      "link": "https://www.walmart.com/search?q=milky+way+candy",
      "thumbnail": "https://i5.walmartimages.com/asr/1ce691c5-0241-43ca-8d05-c6f9837b5b62.ac97fbc550c15e2a0c7c6de0079480..."
    }
  ]
}