{ "openapi": "3.0.1", "info": { "title": "Walmart Product & Reviews Scraper", "description": "Scrape Walmart products and customer reviews with structured data including product titles, prices, ratings, review counts, availability, product URLs, and review details for e-commerce research, price monitoring, and competitor analysis.", "version": "0.1", "x-build-id": "jJQ0mebaCF5h4Htyw" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/mrdoe~walmart-product-reviews-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-mrdoe-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/mrdoe~walmart-product-reviews-scraper/runs": { "post": { "operationId": "runs-sync-mrdoe-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/mrdoe~walmart-product-reviews-scraper/run-sync": { "post": { "operationId": "run-sync-mrdoe-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": [ "operation" ], "properties": { "operation": { "title": "Operation", "enum": [ "search", "productsByCategory", "productDetails", "productOffers", "productReviews" ], "type": "string", "description": "Which Walmart data to scrape. One operation per run.", "default": "search" }, "query": { "title": "Search query (optional)", "type": "string", "description": "Keyword to search Walmart, e.g. \"coffee maker\". Used by the search operation. Defaults to a demo query if left blank.", "default": "coffee maker" }, "queries": { "title": "Search queries - batch (optional)", "type": "array", "description": "Many keywords in one run. Wins over \"query\" when filled. Duplicates and blanks are dropped.", "items": { "type": "string" } }, "categoryId": { "title": "Category ID (optional)", "type": "string", "description": "A Walmart category ID, e.g. \"3944\" (Electronics) or \"3951\" (Laptops). You can paste either the bare leaf ID or the full underscore-joined breadcrumb path (e.g. \"3944_1089430_3951\") copied from a category page - the Actor extracts the leaf ID either way. Used by the productsByCategory operation." }, "categoryIds": { "title": "Category IDs - batch (optional)", "type": "array", "description": "Many category IDs in one run. Wins over \"categoryId\" when filled.", "items": { "type": "string" } }, "productId": { "title": "Product ID (optional)", "type": "string", "description": "A Walmart product ID - either the numeric usItemId (e.g. \"609040889\") or the alphanumeric product ID (e.g. \"4SZSM8SXAAJT\"). Used by productDetails, productOffers, and productReviews." }, "productIds": { "title": "Product IDs - batch (optional)", "type": "array", "description": "Many product IDs in one run. Wins over \"productId\" when filled.", "items": { "type": "string" } }, "domain": { "title": "Marketplace", "enum": [ "us", "ca" ], "type": "string", "description": "Which Walmart marketplace to query.", "default": "us" }, "sortBy": { "title": "Sort by (optional)", "enum": [ "best_match", "price_low", "price_high", "best_seller", "top_rated" ], "type": "string", "description": "Applies to search and productsByCategory." }, "minPrice": { "title": "Min price (optional)", "minimum": 0, "type": "integer", "description": "Applies to search and productsByCategory." }, "maxPrice": { "title": "Max price (optional)", "minimum": 0, "type": "integer", "description": "Applies to search and productsByCategory." }, "storeId": { "title": "Store ID (optional)", "type": "string", "description": "Localize availability and shipping to a specific Walmart store. Applies to search and productsByCategory." }, "state": { "title": "State (optional)", "type": "string", "description": "Localize availability and shipping to a US state, e.g. \"TX\". Applies to search and productsByCategory." }, "reviewSort": { "title": "Review sort (optional)", "enum": [ "relevancy", "recent", "rating_high_low", "rating_low_high" ], "type": "string", "description": "Applies to productReviews." }, "reviewRating": { "title": "Review rating filter (optional)", "minimum": 1, "maximum": 5, "type": "integer", "description": "Return only reviews with this star rating (1-5). Leave blank to return all ratings. Applies to productReviews." }, "reviewLimit": { "title": "Reviews per page", "minimum": 1, "maximum": 50, "type": "integer", "description": "Applies to productReviews.", "default": 10 }, "maxItems": { "title": "Max result rows (optional)", "minimum": 1, "type": "integer", "description": "Caps the total number of result rows returned across this whole run (all queries/categories/products combined) - useful to bound spend on a large batch. The first 10 rows in a run are always free regardless of this setting; leave blank for no cap. There is no page cap - search, productsByCategory, and productReviews always paginate through to the site's own last reported page for each item." }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "A residential proxy is strongly recommended - Walmart aggressively rate-limits repeated traffic from one IP.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ] } } } }, "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 } } } } } } } } } }