API Parameters

Important! The engine parameter should always be set to walmart.

Customize the response from the Walmart API by adding parameters to your request.

The Walmart API is a scraping tool made easy to use. To scrape Walmart, send a GET request to our official endpoint followed by the parameters you choose to customize your request.

The Walmart API uses general parameters, applicable to any search type, and search type-specific parameters. Search type-specific parameters are covered in each search category.

Here is the full list of the general parameters:

Parameter	Required	Type	Description
`api_key`	✅	string	Specify your unique API access key to authenticate with the API. You can find your API access key in your account dashboard.
`engine`	✅	string	The engine of the API. Needs to be set to `walmart` for all Walmart API requests.
`type`	✅	string	The Walmart API uses search types to return categorized results.
`product_id`	Product lookup	string	Walmart product ID. Use either `product_id` or `url`, not both.
`url`	Product lookup	string	Walmart product URL. Use either `url` or `product_id`, not both.
`walmart_domain`	❌	string	Walmart domain to scrape from, such as `walmart.com`.
`zip_code`	❌	string	ZIP code used for localized price, pickup, and availability data.