{ "openapi": "3.0.1", "info": { "title": "Walmart Product Reviews Scraper", "description": "Scrape Walmart.com reviews & product data: star rating, title, text, date, reviewer name, verified-purchase & Walmart badges, helpful votes, variant reviewed, plus price, seller, category, availability, star breakdown, Walmart's AI summary & sub-scores. Sort or filter by rating.", "version": "0.0", "x-build-id": "sj8vCUPwKwhitnfjJ" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/reviewly~walmart-product-reviews-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-reviewly-walmart-product-reviews-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/reviewly~walmart-product-reviews-scraper/runs": { "post": { "operationId": "runs-sync-reviewly-walmart-product-reviews-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/reviewly~walmart-product-reviews-scraper/run-sync": { "post": { "operationId": "run-sync-reviewly-walmart-product-reviews-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", "required": [ "startUrls" ], "properties": { "startUrls": { "title": "Start URLs", "type": "array", "description": "Walmart items to scrape. Every URL shape works — https://www.walmart.com/ip//, the slug-less https://www.walmart.com/ip/, and the reviews page https://www.walmart.com/reviews/product/ — and so does a bare item id on its own, e.g. 889126122. Query strings are ignored, so a share link with ?athAsset=... can be pasted as-is.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "maxReviews": { "title": "Max reviews per product", "minimum": 0, "type": "integer", "description": "Stop after this many reviews per item. 0 means collect every review Walmart will serve, which is up to 10,000 per item — see the note on Only this star rating for how to reach past that.", "default": 0 }, "sortBy": { "title": "Sort reviews by", "enum": [ "relevancy", "submission-desc", "submission-asc", "rating-desc", "rating-asc" ], "type": "string", "description": "Most relevant is what the reviews page shows by default. Pick Newest first for two reasons: it is the order you want for scheduled runs that track new reviews, and it is a stable order. Most relevant is not — Walmart reshuffles it between requests, so a sweep of a very popular product can re-read some pages and miss others (6-15% of rows lost on a 25,000-review item, versus 0% for Newest first). It depends on the product's churn rather than its size: items with 179 and 433 reviews both came back complete under Most relevant. The actor measures this either way and flags the record partial if it happens.", "default": "relevancy" }, "ratingFilter": { "title": "Only this star rating", "enum": [ "all", "5", "4", "3", "2", "1" ], "type": "string", "description": "Collect only reviews with this many stars. Leave on All ratings to collect everything. This is also how to get past Walmart's 10,000-review ceiling on very popular items: each star is paged separately and gets its own 10,000-review allowance, so five runs — one per star — reach up to 50,000. The per-star counts are in the record's ratingBreakdown.", "default": "all" }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Strongly recommended, and residential rather than datacenter. Walmart is fronted by PerimeterX: a bare IP was hard-blocked after roughly 30 requests during development, and once blocked it stays blocked for a while. Keep the country on US — walmart.com is the US storefront." } } }, "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 } } }, "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 } } } } } } } } } }