{ "openapi": "3.0.1", "info": { "title": "Walmart Scraper & API: Products, Search, Reviews", "description": "Walmart product scraper, reviews scraper and search scraper in one Walmart API: product details, search and category results and ALL customer reviews. Price, stock, seller, UPC, specs, variants, rating breakdown; past the 10-page limit; star filters. JSON, CSV, Excel.", "version": "1.0", "x-build-id": "0u8D5o8Zq8WxeET7i" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/mvkdata~walmart-scraper-fast/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-mvkdata-walmart-scraper-fast", "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/mvkdata~walmart-scraper-fast/runs": { "post": { "operationId": "runs-sync-mvkdata-walmart-scraper-fast", "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/mvkdata~walmart-scraper-fast/run-sync": { "post": { "operationId": "run-sync-mvkdata-walmart-scraper-fast", "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": { "startUrls": { "title": "Walmart URLs", "type": "array", "description": "Any mix of walmart.com product pages (/ip/...), search pages (/search?q=...), category or browse pages (/cp/..., /browse/...), seller or brand pages, and review pages (/reviews/product/...). Each is detected automatically.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "searchTerms": { "title": "Search terms", "type": "array", "description": "Keywords to search on walmart.com, like typing them in the search box.", "items": { "type": "string" } }, "productIds": { "title": "Product IDs", "type": "array", "description": "Walmart item IDs (the number at the end of a product URL, e.g. 5113175776).", "items": { "type": "string" } }, "maxItemsPerSearch": { "title": "Max products per search / category", "minimum": 0, "type": "integer", "description": "How many products to take from each search term or listing URL. 0 = everything. Walmart shows at most ~1,000 per query; with 'Go past Walmart's page limit' on, the actor splits the query by price to get more.", "default": 50 }, "scrapeProductDetails": { "title": "Open every search result for full details", "type": "boolean", "description": "Off: search/category results come as fast summary rows (name, price, rating, seller, stock). On: each result is opened for the full product record (description, specs, UPC, variants, all images, delivery, return policy, rating breakdown) and charged as a product.", "default": false }, "includeReviews": { "title": "Also scrape reviews", "type": "boolean", "description": "Also collect customer reviews for every product found (product URLs, IDs and search results).", "default": false }, "maxReviewsPerProduct": { "title": "Max reviews per product", "minimum": 0, "type": "integer", "description": "0 = all reviews (Walmart serves every written review, also on products with tens of thousands).", "default": 100 }, "reviewsSort": { "title": "Review order", "enum": [ "relevancy", "helpful", "submission-desc", "submission-asc", "rating-desc", "rating-asc" ], "type": "string", "description": "Order in which reviews are collected.", "default": "relevancy" }, "reviewsStarFilter": { "title": "Only these star ratings", "type": "array", "description": "Collect only reviews with these star ratings, e.g. 1 and 2 for complaint analysis. Empty = all.", "items": { "type": "string", "enum": [ "1", "2", "3", "4", "5" ], "enumTitles": [ "1 star", "2 stars", "3 stars", "4 stars", "5 stars" ] } }, "sort": { "title": "Search sort", "enum": [ "best_match", "price_low", "price_high", "best_seller", "rating_high", "new" ], "type": "string", "description": "Sort order for search and category results.", "default": "best_match" }, "minPrice": { "title": "Min price (USD)", "minimum": 0, "type": "integer", "description": "Only search/category results at or above this price." }, "maxPrice": { "title": "Max price (USD)", "minimum": 0, "type": "integer", "description": "Only search/category results at or below this price." }, "deepSearch": { "title": "Go past Walmart's page limit", "type": "boolean", "description": "Walmart stops paging after ~25 pages. When a query has more matches than that and you asked for more, the actor splits it into price ranges and collects each range, de-duplicated.", "default": true }, "maxItems": { "title": "Max results in total", "minimum": 0, "type": "integer", "description": "Hard cap on all dataset rows (products + search rows + reviews) in this run. 0 = no cap. Protects your budget.", "default": 0 }, "includeRawData": { "title": "Include raw Walmart data", "type": "boolean", "description": "Adds the complete original Walmart product JSON under 'raw' (hundreds of fields) to every product record.", "default": false }, "proxy": { "title": "Proxy", "type": "object", "description": "Default Apify Proxy works. Pages Walmart blocks are retried on fresh IPs and, if needed, on US residential IPs.", "default": { "useApifyProxy": true } }, "residentialFallback": { "title": "Retry blocked pages on residential IPs", "type": "boolean", "description": "With the default proxy, pages blocked several times move to US residential IPs (paid by us, not extra for you).", "default": true }, "maxConcurrency": { "title": "Max parallel requests", "minimum": 1, "maximum": 50, "type": "integer", "description": "Pages fetched at the same time.", "default": 20 }, "maxRequestRetries": { "title": "Max retries per page", "minimum": 0, "maximum": 30, "type": "integer", "description": "Each retry uses a new IP.", "default": 10 } } }, "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 } } } } } } } } } }