> ## Documentation Index
> Fetch the complete documentation index at: https://docs.zenrows.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Using the Walmart Discovery API

> Search Walmart and extract structured product listings including names, prices, ratings, and discounts with the ZenRows Discovery API.

The Walmart Discovery API allows you to retrieve structured data from Walmart based on specific search queries. With this endpoint, you can access product details such as:

* Product Name, Price, and Discounts
* Ratings, Reviews, and Popularity Metrics
* Product Links and Images
* Related Searches and Sponsored Products
* This API is useful for a variety of applications, including market analysis, competitive research, and monitoring sponsored products' visibility.

Example Use Cases:

* **Market Analysis:** Identify popular products and analyze trends in specific categories.
* **Ad Performance:** Monitor and evaluate sponsored product visibility for your campaigns or competitors.

## Supported Query Parameters

| PARAMETER            | TYPE           | DEFAULT | DESCRIPTION                                                                                                      |
| -------------------- | -------------- | ------- | ---------------------------------------------------------------------------------------------------------------- |
| **query** `required` | `string`       |         | The search term you want to query on Walmart. Must be URL-encoded. Example: `Wireless+Headphones`.               |
| **url**              | `string <uri>` |         | The URL of the search results page to retrieve. Example: `https://www.walmart.com/search?q=Wireless+Headphones`. |
| **tld**              | `string`       | `.com`  | The top-level domain of the Walmart website. Supported examples: `.com`, `.ca`                                   |

## How to Setup

Request the search endpoint with your desired query:

```bash theme={null}
https://ecommerce.api.zenrows.com/v1/targets/walmart/discovery/{query}?apikey=YOUR_ZENROWS_API_KEY
```

### Example

```bash cURL theme={null}
curl "https://ecommerce.api.zenrows.com/v1/targets/walmart/discovery/{query}?apikey=YOUR_ZENROWS_API_KEY"
```

<Note>Note: {query} should be URL-encoded.</Note>

<RequestExample>
  ```python Python theme={null}
  # pip install requests
  import requests
  import urllib.parse

  query = "laptop stand"  # Example query
  encoded_query = urllib.parse.quote(query)
  api_endpoint = f"https://ecommerce.api.zenrows.com/v1/targets/walmart/discovery/{encoded_query}"
  params = {
      "apikey": "YOUR_ZENROWS_API_KEY",
  }
  response = requests.get(api_endpoint, params=params)
  print(response.text)
  ```

  ```javascript NodeJS theme={null}
  // npm install axios
  const axios = require('axios');

  const query = "laptop stand"; // Example query
  const encodedQuery = encodeURIComponent(query);
  const apikey = 'YOUR_ZENROWS_API_KEY';
  const api_endpoint = `https://ecommerce.api.zenrows.com/v1/targets/walmart/discovery/${encodedQuery}`;

  axios
      .get(api_endpoint, {
          params: { apikey },
      })
      .then((response) => console.log(response.data))
      .catch((error) => console.log(error));
  ```

  ```java Java theme={null}
  import org.apache.hc.client5.http.fluent.Request;
  import org.apache.hc.core5.net.URIBuilder;
  import java.net.URI;
  import java.net.URLEncoder;
  import java.nio.charset.StandardCharsets;

  public class ZRRequest {
      public static void main(final String... args) throws Exception {
          String query = "laptop stand"; // Example query
          String encodedQuery = URLEncoder.encode(query, StandardCharsets.UTF_8.toString());
          String api_endpoint = "https://ecommerce.api.zenrows.com/v1/targets/walmart/discovery/" + encodedQuery;
          String apikey = "YOUR_ZENROWS_API_KEY";

          URI uri = new URIBuilder(api_endpoint)
              .addParameter("apikey", apikey)
              .build();

          String response = Request.get(uri)
              .execute().returnContent().asString();

          System.out.println(response);
      }
  }
  ```

  ```php PHP theme={null}
  <?php
  $query = "laptop stand"; // Example query
  $encoded_query = urlencode($query);
  $api_endpoint = "https://ecommerce.api.zenrows.com/v1/targets/walmart/discovery/" . $encoded_query;
  $apikey = 'YOUR_ZENROWS_API_KEY';
  $params = [
      'apikey' => $apikey,
  ];

  $ch = curl_init();
  curl_setopt($ch, CURLOPT_URL, $api_endpoint . '?' . http_build_query($params));
  curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
  curl_setopt($ch, CURLOPT_FOLLOWLOCATION, true);

  $response = curl_exec($ch);
  echo $response . PHP_EOL;
  curl_close($ch);
  ```

  ```go Go theme={null}
  package main

  import (
      "fmt"
      "io/ioutil"
      "log"
      "net/http"
      "net/url"
  )

  func main() {
      query := "laptop stand" // Example query
      encodedQuery := url.PathEscape(query)
      api_endpoint := "https://ecommerce.api.zenrows.com/v1/targets/walmart/discovery/" + encodedQuery
      apikey := "YOUR_ZENROWS_API_KEY"
      params := url.Values{}
      params.Add("apikey", apikey)

      resp, err := http.Get(api_endpoint + "?" + params.Encode())
      if err != nil {
          log.Fatalln(err)
      }
      defer resp.Body.Close()

      body, err := ioutil.ReadAll(resp.Body)
      if err != nil {
          log.Fatalln(err)
      }

      fmt.Println(string(body))
  }
  ```

  ```ruby Ruby theme={null}
  # gem install faraday
  require 'faraday'
  require 'cgi'

  query = "laptop stand" # Example query
  encoded_query = CGI.escape(query)
  api_endpoint = "https://ecommerce.api.zenrows.com/v1/targets/walmart/discovery/#{encoded_query}"
  apikey = 'YOUR_ZENROWS_API_KEY'

  conn = Faraday.new(url: api_endpoint) do |f|
    f.params = {
      apikey: apikey
    }
  end

  response = conn.get

  puts response.body
  ```
</RequestExample>

<ResponseExample>
  ```json Response Example theme={null}
  {
    "pagination": {},
    "products_list": [
      {
        "discounted_product": false,
        "is_sponsored_product": true,
        "price_currency_code": "USD",
        "price_currency_symbol": "$",
        "product_image": "https://i5.walmartimages.com/seo/2-Pack-Monitor-Stand-Riser-with-3-Height-Adjustable-and-Mesh-Platform-for-Laptop-Computer-Printer_44a610f2-8aff-4e34-ba45-6a3ee7953961.9c19d429044fc663fd286a501f919a17.jpeg?odnHeight=580&odnWidth=580&odnBg=FFFFFF",
        "product_name": "2-Pack Monitor Stand Riser with 3 Height Adjustable and Mesh Platform for Laptop, Computer, Printer",
        "product_price": 19.99,
        "product_url": "https://www.walmart.com/sp/track?bt=1&eventST=click&plmt=sp-search-middle~desktop~&pos=1&tax=4044_103150_97116_1071224_4693685&rdf=1&rd=https%3A%2F%2Fwww.walmart.com%2Fip%2F2-Pack-Monitor-Stand-Riser-with-3-Height-Adjustable-and-Mesh-Platform-for-Laptop-Computer-Printer%2F589900557%3FclassType%3DREGULAR%26athbdg%3DL1600%26adsRedirect%3Dtrue&adUid=88d8d4d8-3706-4b09-9a79-011c0b047aa8&mloc=sp-search-middle&pltfm=desktop&pgId=laptop%20stand&pt=search&spQs=zlCCCQ6bXwgcJMBnpc7HUG07FCKn9TJHleXCILUoDQCBZLTUk2xnvYBhZxhhe3Nud8mHCByXsCbL3IpDbDcynOk0FtVgUYIMZmTduaYkDe7RmDgIMKKqtw5tHhKJTfAhxnNKiTuyFe7sVA6E31gWz6kroUpV5V2tXLVLhCQYvXGSN1BsLzThgFnzOfI-YAXBfonZ6ccMlO0nfiQHy97_ArlpdrhKDH4XeG7QyguUUulAJ3e4nX4M42VwYCHHQpQmEmKAcGZzZr3cZxe_bpF6701W4npF0CgQVQWN2JG24uDbUx0coKyLMbnA83CIKiQW&storeId=3081&couponState=na&bkt=ace1_default%7Cace2_default%7Cace3_default%7Cbb_11236%7Ccoldstart_on%7Csearch_merged_ranker_xe_v2%7Csearch_wic.online&classType=REGULAR&athbdg=L1600",
        "rating_score": 4.7,
        "review_count": 265
      },
      {
        "discounted_product": false,
        "is_sponsored_product": true,
        "price_currency_code": "USD",
        "price_currency_symbol": "$",
        "product_image": "https://i5.walmartimages.com/seo/Laptop-Stand-for-Desk-KEXIN-Aluminum-Adjustable-Stand-of-Laptop-for-Mac-HP-Dell-Samsung-10-17-inches-Foldable-Computer-Holder_275e43d2-0540-4ffc-97ab-5c74259f48e7.ce2af724da4de7736fa3d5d31a6992ac.jpeg?odnHeight=580&odnWidth=580&odnBg=FFFFFF",
        "product_name": "Laptop Stand for Desk, KEXIN Aluminum Adjustable Stand of Laptop for Mac / HP / Dell / Samsung, 10-16 inches Foldable Computer Holder",
        "product_price": 20.99,
        "product_url": "https://www.walmart.com/sp/track?bt=1&eventST=click&plmt=sp-search-middle~desktop~&pos=2&tax=4044_103150_97116_1071224_4693685&rdf=1&rd=https%3A%2F%2Fwww.walmart.com%2Fip%2FLaptop-Stand-for-Desk-KEXIN-Aluminum-Adjustable-Stand-of-Laptop-for-Mac-HP-Dell-Samsung-10-17-inches-Foldable-Computer-Holder%2F1210717083%3FclassType%3DVARIANT%26adsRedirect%3Dtrue&adUid=88d8d4d8-3706-4b09-9a79-011c0b047aa8&mloc=sp-search-middle&pltfm=desktop&pgId=laptop%20stand&pt=search&spQs=sRfbwGhVSWu-lVqRZfuvTDyP40eiYItpvPPoxGUbxPzY8Gh9W3P4glNcY_XVPoR8SDg5xtvQBrdm6k4TwS0Or91rJMFuGFPh9nhpAfkaMlZKUld2KT_0RpWPLcOCR7Pb8q46BCLU3V6bRUn53E70tQagpx4WrYx20RKz_N_Oz2zsEoVe6qvOzilTvn6CW56Ki2PwnwAV0VyHD3AlOIF-FzdlExP4MQThgq7cAs-u7-3bvxMmAAh3bi-1De1rHI-A&storeId=3081&couponState=na&bkt=ace1_default%7Cace2_default%7Cace3_default%7Cbb_11236%7Ccoldstart_on%7Csearch_merged_ranker_xe_v2%7Csearch_wic.online&classType=VARIANT",
        "rating_score": 4.8,
        "review_count": 132
      },
      {
        "discounted_product": false,
        "is_sponsored_product": true,
        "price_currency_code": "USD",
        "price_currency_symbol": "$",
        "product_image": "https://i5.walmartimages.com/seo/Laptop-Stand-Desk-Adjustable-Computer-360-Rotating-Base-Ergonomic-Riser-Collaborative-Work-Foldable-Portable-Stand-fits-All-10-17-Laptops_75b2e2a4-0eca-40a6-bcf5-4c1ea3f8efd2.af9c821dd57967a71aec546edaba6036.jpeg?odnHeight=580&odnWidth=580&odnBg=FFFFFF",
        "product_name": "Laptop Stand for Desk, Adjustable Computer Stand with 360° Rotating Base, Ergonomic Laptop Riser for Collaborative Work, Foldable & Portable Laptop Stand, fits for All 10-16\" Laptops - Grey",
        "product_price": 32.38,
        "product_url": "https://www.walmart.com/sp/track?bt=1&eventST=click&plmt=sp-search-middle~desktop~&pos=3&tax=4044_103150_97116_1071224_4693685&rdf=1&rd=https%3A%2F%2Fwww.walmart.com%2Fip%2FLaptop-Stand-Desk-Adjustable-Computer-360-Rotating-Base-Ergonomic-Riser-Collaborative-Work-Foldable-Portable-Stand-fits-All-10-17-Laptops%2F8413806345%3FclassType%3DVARIANT%26adsRedirect%3Dtrue&adUid=88d8d4d8-3706-4b09-9a79-011c0b047aa8&mloc=sp-search-middle&pltfm=desktop&pgId=laptop%20stand&pt=search&spQs=j3zERNIdY5W9QDLWjFbVgOrPVNGpjzo5DMzndPXOadKGDiP4axcgYVHGlIRtWYd2hRSK-FEH_d2d7CFNNCQ1Td1rJMFuGFPh9nhpAfkaMlZAkOESxsQpz7ivMGpVeiRFY-iV2G9dQOfPT0pAcNW6rUQUbfGI0m0u8gg-l61PwuURUwYjyjPZLPzyMINgZ_0MzaYMyT9EyjIpGo_ZSgWaWqu2NWlqzG2aw76uWU_AA3N1sJm1v8XEPPYy3EDO2i6SZrc23D39rZh-S4rOeCa1KM-IZSoHdqWM6rzimgpxxytj9R0Q1S7yNFSTBHo7arNw&storeId=3081&couponState=na&bkt=ace1_default%7Cace2_default%7Cace3_default%7Cbb_11236%7Ccoldstart_on%7Csearch_merged_ranker_xe_v2%7Csearch_wic.online&classType=VARIANT",
        "rating_score": 4.4,
        "review_count": 5
      },
      {
        "discounted_product": false,
        "is_sponsored_product": true,
        "price_currency_code": "USD",
        "price_currency_symbol": "$",
        "product_image": "https://i5.walmartimages.com/seo/Laptop-Stand-for-Desk-Adjustable-Ergonomic-Desk-Riser-MacBook-Stand-for-All-10-17-inch-Laptops-Portable-Cool-Mesh-Riser-Stand-For-Laptops_0a6f8b6e-9e1d-4388-b400-e4209be4db4e.40fc2ad5d1009024957e82c674fdfdb6.jpeg?odnHeight=580&odnWidth=580&odnBg=FFFFFF",
        "product_name": "Laptop Stand for Desk, Adjustable Ergonomic Desk Riser, MacBook Stand for All 10-17 inch Laptops, Portable Cool Mesh Riser Stand For Laptops - Silver",
        "product_price": 27.67,
        "product_url": "https://www.walmart.com/sp/track?bt=1&eventST=click&plmt=sp-search-middle~desktop~&pos=4&tax=4044_103150_97116_1071224_4693685&rdf=1&rd=https%3A%2F%2Fwww.walmart.com%2Fip%2FLaptop-Stand-for-Desk-Adjustable-Ergonomic-Desk-Riser-MacBook-Stand-for-All-10-17-inch-Laptops-Portable-Cool-Mesh-Riser-Stand-For-Laptops%2F735781176%3FclassType%3DREGULAR%26adsRedirect%3Dtrue&adUid=88d8d4d8-3706-4b09-9a79-011c0b047aa8&mloc=sp-search-middle&pltfm=desktop&pgId=laptop%20stand&pt=search&spQs=mbfb9QpFqltQs9UEuAw9yZo4xw9Ac6OLhxGZCvZzleFahzgNOck8esPQxbh4dpcggg80-Kn_Ubnn6Kcc9MY8P9X5i9Fj_8DJfmqsCqhyqsGEQnDAcBjrZIg6nIotmJ7gE8zZt2lwdmQXTfF50dd1ldBqDke0Me_6z9fy55YbA-wFegDtAT2UgNm6mV8aAC7FyH-GGv0Ln0oH3HYicT-9iJd7ewytdTgLt5HzvC9_g2u1vPtahqLPuBhPYXY9pD0CmNJfLBXLmV2JbMXRo_6fZXE4cb19g&storeId=3081&couponState=na&bkt=ace1_default%7Cace2_default%7Cace3_default%7Cbb_11236%7Ccoldstart_on%7Csearch_merged_ranker_xe_v2%7Csearch_wic.online&classType=REGULAR",
        "rating_score": 4.4,
        "review_count": 16
      }
    ]
  }
  ```
</ResponseExample>

## Troubleshooting and FAQs

<Accordion title="What does the query parameter represent?">
  The `query` parameter is the search term you want to look up on Walmart's website. It could be a product name, category, or keyword. Make sure to URL-encode the query string (e.g., `Wireless Headphones` becomes `Wireless+Headphones`).
</Accordion>
