{
"openapi": "3.0.1",
"info": {
"title": "Walmart Scraper - Product Prices, Stock & Reviews",
"description": "Scrape Walmart.com products by keyword, category URL, product URL or item ID: price, was-price, unit price, stock, pickup/delivery, seller (Walmart vs marketplace), UPC/GTIN, variants, specs, images, ratings and optional reviews. Fast HTTP, no browser, auto-retries blocked requests.",
"version": "1.0",
"x-build-id": "WloCxXcMyb02D9xdM"
},
"servers": [
{
"url": "https://api.apify.com/v2"
}
],
"paths": {
"/acts/wrenfield-data~walmart-product-scraper/run-sync-get-dataset-items": {
"post": {
"operationId": "run-sync-get-dataset-items-wrenfield-data-walmart-product-scraper",
"x-openai-isConsequential": false,
"summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.",
"tags": [
"Run Actor"
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/inputSchema"
}
}
}
},
"parameters": [
{
"name": "token",
"in": "query",
"required": true,
"schema": {
"type": "string"
},
"description": "Enter your Apify token here"
}
],
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/acts/wrenfield-data~walmart-product-scraper/runs": {
"post": {
"operationId": "runs-sync-wrenfield-data-walmart-product-scraper",
"x-openai-isConsequential": false,
"summary": "Executes an Actor and returns information about the initiated run in response.",
"tags": [
"Run Actor"
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/inputSchema"
}
}
}
},
"parameters": [
{
"name": "token",
"in": "query",
"required": true,
"schema": {
"type": "string"
},
"description": "Enter your Apify token here"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/runsResponseSchema"
}
}
}
}
}
}
},
"/acts/wrenfield-data~walmart-product-scraper/run-sync": {
"post": {
"operationId": "run-sync-wrenfield-data-walmart-product-scraper",
"x-openai-isConsequential": false,
"summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.",
"tags": [
"Run Actor"
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/inputSchema"
}
}
}
},
"parameters": [
{
"name": "token",
"in": "query",
"required": true,
"schema": {
"type": "string"
},
"description": "Enter your Apify token here"
}
],
"responses": {
"200": {
"description": "OK"
}
}
}
}
},
"components": {
"schemas": {
"inputSchema": {
"type": "object",
"properties": {
"searchKeywords": {
"title": "Search keywords",
"type": "array",
"description": "Keywords to search on Walmart.com, one per line (e.g. coffee, air fryer). Each keyword returns up to Max products per search/category products.",
"items": {
"type": "string"
}
},
"startUrls": {
"title": "Category, search or product URLs",
"type": "array",
"description": "Walmart URLs: category pages (/browse/..., /cp/...), search result pages with filters (/search?q=...), brand/shop pages, or product pages (/ip/...).",
"items": {
"type": "object",
"required": [
"url"
],
"properties": {
"url": {
"type": "string",
"title": "URL of a web page",
"format": "uri"
}
}
}
},
"productIds": {
"title": "Product item IDs or URLs",
"type": "array",
"description": "Walmart item IDs (the number at the end of a product URL, e.g. 578550306) or full /ip/ product URLs, one per line.",
"items": {
"type": "string"
}
},
"maxItems": {
"title": "Max products (total)",
"minimum": 1,
"maximum": 100000,
"type": "integer",
"description": "Maximum number of product rows for the whole run (reviews are not counted). Duplicate products across keywords/categories are skipped automatically.",
"default": 50
},
"maxItemsPerQuery": {
"title": "Max products per search/category",
"minimum": 1,
"maximum": 1000,
"type": "integer",
"description": "How many products to take from each keyword or category URL. Walmart shows about 40 products per page and up to 25 pages (about 1,000 products) per search.",
"default": 40
},
"includeDetails": {
"title": "Scrape full product details",
"type": "boolean",
"description": "Open each product page for brand, UPC/GTIN, specifications, variants, description, all images, seller details and pickup/delivery options. Turn off for a faster, cheaper listing-only scrape (title, price, rating, seller, availability from the search grid).",
"default": true
},
"sort": {
"title": "Sort search results",
"enum": [
"best_match",
"price_low",
"price_high",
"best_seller",
"rating_high",
"new"
],
"type": "string",
"description": "Sort order for keyword searches and category pages.",
"default": "best_match"
},
"minPrice": {
"title": "Min price (USD)",
"minimum": 0,
"type": "integer",
"description": "Only products at or above this price (search and category pages)."
},
"maxPrice": {
"title": "Max price (USD)",
"minimum": 0,
"type": "integer",
"description": "Only products at or below this price (search and category pages)."
},
"zipCode": {
"title": "ZIP code (local price and availability)",
"type": "string",
"description": "Optional 5-digit US ZIP code. Prices, stock, delivery dates and the pickup store (Walmart picks the nearest store) are returned for this ZIP. Every product row includes the location Walmart actually used, so you can verify it. Leave empty for Walmart's default location for the proxy IP."
},
"includeReviews": {
"title": "Scrape reviews",
"type": "boolean",
"description": "Also scrape customer reviews for every product (output rows with type = review).",
"default": false
},
"maxReviewsPerProduct": {
"title": "Max reviews per product",
"minimum": 1,
"maximum": 5000,
"type": "integer",
"description": "Reviews are loaded 10 per page.",
"default": 20
},
"reviewsSort": {
"title": "Review sort",
"enum": [
"relevancy",
"helpful",
"submission-desc",
"submission-asc",
"rating-desc",
"rating-asc"
],
"type": "string",
"description": "Order of the reviews.",
"default": "relevancy"
},
"proxyConfiguration": {
"title": "Proxy",
"type": "object",
"description": "Defaults to Apify datacenter proxy (cheapest) with automatic residential fallback when Walmart blocks it. Choose the RESIDENTIAL group to always use US residential IPs.",
"default": {
"useApifyProxy": true
}
},
"residentialFallback": {
"title": "Residential fallback",
"type": "boolean",
"description": "Retry blocked requests on US residential IPs with a fresh browser session. Recommended - this is what keeps the success rate above 95%.",
"default": true
},
"maxConcurrency": {
"title": "Max concurrency",
"minimum": 1,
"maximum": 50,
"type": "integer",
"description": "Parallel requests.",
"default": 10
},
"maxRetries": {
"title": "Max attempts per page",
"minimum": 1,
"maximum": 20,
"type": "integer",
"description": "Each blocked page is retried with a new IP and browser fingerprint, with backoff.",
"default": 8
}
}
},
"runsResponseSchema": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"actId": {
"type": "string"
},
"userId": {
"type": "string"
},
"startedAt": {
"type": "string",
"format": "date-time",
"example": "2025-01-08T00:00:00.000Z"
},
"finishedAt": {
"type": "string",
"format": "date-time",
"example": "2025-01-08T00:00:00.000Z"
},
"status": {
"type": "string",
"example": "READY"
},
"meta": {
"type": "object",
"properties": {
"origin": {
"type": "string",
"example": "API"
},
"userAgent": {
"type": "string"
}
}
},
"stats": {
"type": "object",
"properties": {
"inputBodyLen": {
"type": "integer",
"example": 2000
},
"rebootCount": {
"type": "integer",
"example": 0
},
"restartCount": {
"type": "integer",
"example": 0
},
"resurrectCount": {
"type": "integer",
"example": 0
},
"computeUnits": {
"type": "integer",
"example": 0
}
}
},
"options": {
"type": "object",
"properties": {
"build": {
"type": "string",
"example": "latest"
},
"timeoutSecs": {
"type": "integer",
"example": 300
},
"memoryMbytes": {
"type": "integer",
"example": 1024
},
"diskMbytes": {
"type": "integer",
"example": 2048
}
}
},
"buildId": {
"type": "string"
},
"defaultKeyValueStoreId": {
"type": "string"
},
"defaultDatasetId": {
"type": "string"
},
"defaultRequestQueueId": {
"type": "string"
},
"buildNumber": {
"type": "string",
"example": "1.0.0"
},
"containerUrl": {
"type": "string"
},
"usage": {
"type": "object",
"properties": {
"ACTOR_COMPUTE_UNITS": {
"type": "integer",
"example": 0
},
"DATASET_READS": {
"type": "integer",
"example": 0
},
"DATASET_WRITES": {
"type": "integer",
"example": 0
},
"KEY_VALUE_STORE_READS": {
"type": "integer",
"example": 0
},
"KEY_VALUE_STORE_WRITES": {
"type": "integer",
"example": 1
},
"KEY_VALUE_STORE_LISTS": {
"type": "integer",
"example": 0
},
"REQUEST_QUEUE_READS": {
"type": "integer",
"example": 0
},
"REQUEST_QUEUE_WRITES": {
"type": "integer",
"example": 0
},
"DATA_TRANSFER_INTERNAL_GBYTES": {
"type": "integer",
"example": 0
},
"DATA_TRANSFER_EXTERNAL_GBYTES": {
"type": "integer",
"example": 0
},
"PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
"type": "integer",
"example": 0
},
"PROXY_SERPS": {
"type": "integer",
"example": 0
},
"PROXY_UNBLOCKER_UNITS": {
"type": "integer",
"example": 0
}
}
},
"usageTotalUsd": {
"type": "number",
"example": 0.00005
},
"usageUsd": {
"type": "object",
"properties": {
"ACTOR_COMPUTE_UNITS": {
"type": "integer",
"example": 0
},
"DATASET_READS": {
"type": "integer",
"example": 0
},
"DATASET_WRITES": {
"type": "integer",
"example": 0
},
"KEY_VALUE_STORE_READS": {
"type": "integer",
"example": 0
},
"KEY_VALUE_STORE_WRITES": {
"type": "number",
"example": 0.00005
},
"KEY_VALUE_STORE_LISTS": {
"type": "integer",
"example": 0
},
"REQUEST_QUEUE_READS": {
"type": "integer",
"example": 0
},
"REQUEST_QUEUE_WRITES": {
"type": "integer",
"example": 0
},
"DATA_TRANSFER_INTERNAL_GBYTES": {
"type": "integer",
"example": 0
},
"DATA_TRANSFER_EXTERNAL_GBYTES": {
"type": "integer",
"example": 0
},
"PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
"type": "integer",
"example": 0
},
"PROXY_SERPS": {
"type": "integer",
"example": 0
},
"PROXY_UNBLOCKER_UNITS": {
"type": "integer",
"example": 0
}
}
}
}
}
}
}
}
}
}