Walmart Search API (Async)

This endpoint will retrieve product list data from Walmart as a result of a search.

Single query request:

require 'net/http'
require 'json'
require 'uri'
uri = URI('https://async.scraperapi.com/structured/walmart/search')
request = Net::HTTP::Post.new(uri, 'Content-Type' => 'application/json')
request.body = {
  apiKey: 'APIKEY',
    query: 'QUERY',
    tld: 'TLD',
    page: 'PAGE',
    output_format: 'FORMAT',
    callback: {
    type: 'webhook',
    url: 'CALLBACK'
  }
}.to_json
begin
  response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) do |http|
    http.request(request)
  end
  puts response.body
rescue => e
  puts "Error: #{e.message}"
end

Multiple Query Request:

require 'net/http'
require 'json'
require 'uri'
uri = URI('https://async.scraperapi.com/structured/walmart/search')
request = Net::HTTP::Post.new(uri, 'Content-Type' => 'application/json')
request.body = {
  apiKey: 'APIKEY',
    queries: ['QUERY1', 'QUERY2'],
    tld: 'TLD',
    page: 'PAGE',
    output_format: 'FORMAT',
    callback: {
    type: 'webhook',
    url: 'CALLBACK'
  }
}.to_json
begin
  response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) do |http|
    http.request(request)
  end
  puts response.body
rescue => e
  puts "Error: #{e.message}"
end

REQUIRED

APIKEY

User account’s normal API key.

QUERY

Walmart search term

OPTIONAL

PAGE

Pagination. Example: 3

TLD

Top level domain. Valid values are com and ca

OUTPUT_FORMAT

For structured data methods we offer CSV and JSON output. JSON is default if parameter is not added. Options:

  • csv

  • json

Sample Response

For single query requests:

{
  "id": "2c75d8dc-02e9-4243-bef9-5da4bb352c4c",
  "status": "running",
  "statusUrl": "https://async.scraperapi.com/jobs/2c75d8dc-02e9-4243-bef9-5da4bb352c4c",
  "query": "bucket"
}

For multiple query requests:

[
  {
    "id": "b61d65c2-7998-41d5-8852-41175336d4b2",
    "attempts": 0,
    "status": "running",
    "statusUrl": "https://async.scraperapi.com/jobs/b61d65c2-7998-41d5-8852-41175336d4b2",
    "query": "bucket"
  },
  {
    "id": "e9d5a1b8-872c-4926-bb25-bc22c17c07bb",
    "attempts": 0,
    "status": "running",
    "statusUrl": "https://async.scraperapi.com/jobs/e9d5a1b8-872c-4926-bb25-bc22c17c07bb",
    "query": "sprinkler"
  }
]

After the job(s) finish, you will find the result under the response key in the response JSON object. The structure is the same as in the corresponding SYNC data endpoint.

Last updated