{ "openapi": "3.0.1", "info": { "title": "Walmart.com Product Search & Price Filter Scraper", "description": "Search Walmart.com by keyword and filter results by price, rating, review count, free shipping, stock status, brand or seller, with sponsored placements flagged apart from organic results.", "version": "1.1", "x-build-id": "3heBF67TyRgXhfrFf" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/vexaloom-labs~walmart-com-product-search-and-price-filter/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-vexaloom-labs-walmart-com-product-search-and-price-filter", "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/vexaloom-labs~walmart-com-product-search-and-price-filter/runs": { "post": { "operationId": "runs-sync-vexaloom-labs-walmart-com-product-search-and-price-filter", "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/vexaloom-labs~walmart-com-product-search-and-price-filter/run-sync": { "post": { "operationId": "run-sync-vexaloom-labs-walmart-com-product-search-and-price-filter", "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": { "mode": { "title": "Mode", "enum": [ "search", "browse", "products", "reviews" ], "type": "string", "description": "What to scrape: keyword search, a category shelf, full product pages, or customer reviews.", "default": "search" }, "searchQueries": { "title": "Search keywords", "type": "array", "description": "One or more keywords to search on walmart.com (mode = search). Each query is walked page by page.", "default": [ "iphone case" ], "items": { "type": "string" } }, "categoryUrls": { "title": "Category URLs", "type": "array", "description": "Walmart category links starting with /browse/ or /cp/ (mode = browse), e.g. https://www.walmart.com/browse/electronics/3944.", "default": [], "items": { "type": "string" } }, "productUrls": { "title": "Product URLs", "type": "array", "description": "Walmart product links (mode = products or reviews), e.g. https://www.walmart.com/ip/20042402979. Short /ip/ links and alphanumeric product IDs also work.", "default": [], "items": { "type": "string" } }, "itemIds": { "title": "Item IDs", "type": "array", "description": "Walmart numeric item IDs (the number at the end of a product link), one per line (mode = products or reviews).", "default": [], "items": { "type": "string" } }, "maxItems": { "title": "Max records", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Hard cap on emitted records for the whole run. In review mode this caps review rows.", "default": 50 }, "maxPages": { "title": "Max result pages per query", "minimum": 1, "maximum": 25, "type": "integer", "description": "Maximum search or category pages to walk per query/URL (about 40 products per page). Walmart caps its own listing at 25 pages.", "default": 5 }, "sortBy": { "title": "Sort by", "enum": [ "best_match", "price_low", "price_high", "best_seller", "rating_high", "new" ], "type": "string", "description": "Walmart listing order for search and browse modes.", "default": "best_match" }, "minPrice": { "title": "Min price (USD)", "minimum": 0, "maximum": 1000000, "type": "number", "description": "Only keep products at or above this price. Applied by Walmart's own price filter." }, "maxPrice": { "title": "Max price (USD)", "minimum": 0, "maximum": 1000000, "type": "number", "description": "Only keep products at or below this price. Applied by Walmart's own price filter." }, "minRating": { "title": "Min rating", "minimum": 0, "maximum": 5, "type": "number", "description": "Only keep products rated at least this (0-5). Products with no rating yet are kept." }, "minReviewCount": { "title": "Min review count", "minimum": 0, "maximum": 100000000, "type": "integer", "description": "Only keep products with at least this many reviews. Products with no review count are kept." }, "freeShippingOnly": { "title": "Free shipping only", "type": "boolean", "description": "Only keep products with free shipping. Search/browse rows are automatically enriched from product pages so this filter is accurate.", "default": false }, "excludeOutOfStock": { "title": "Exclude out of stock", "type": "boolean", "description": "Drop products Walmart marks out of stock.", "default": true }, "excludeSponsored": { "title": "Exclude sponsored", "type": "boolean", "description": "Drop paid/sponsored placements and keep organic search results only.", "default": false }, "brands": { "title": "Brands (exact names)", "type": "array", "description": "Only keep these brands, using Walmart's own brand filter. Enter names exactly as Walmart shows them, e.g. DEWALT.", "default": [], "items": { "type": "string" } }, "sellerContains": { "title": "Seller name contains", "type": "string", "description": "Only keep products whose seller name contains this text (case-insensitive), e.g. Walmart, Pro Seller." }, "facet": { "title": "Walmart facet (advanced)", "type": "string", "description": "Any Walmart listing facet as type:value, e.g. retailer_type:Walmart, special_offers:Rollback, customer_rating_range_facet_new_filter_v0:4 - 5 Stars, exclude_oos:Show available items only." }, "enrichDetails": { "title": "Enrich search rows with product details", "type": "boolean", "description": "Open each search/browse product page to add brand, UPC, model, description, specifications, images, return policy and review breakdown. Slower and uses more requests.", "default": false }, "maxConcurrency": { "title": "Parallel requests", "minimum": 1, "maximum": 10, "type": "integer", "description": "How many product or review pages to fetch at the same time (1-10). Higher is faster but more aggressive.", "default": 4 }, "maxReviews": { "title": "Max reviews per product", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Maximum customer reviews to read per product in review mode. Walmart only publishes reviews that contain text.", "default": 10 }, "reviewSort": { "title": "Review order", "enum": [ "relevancy", "submission-desc", "submission-asc", "rating-desc", "rating-asc", "helpful-desc" ], "type": "string", "description": "How Walmart should order customer reviews.", "default": "relevancy" } } }, "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 } } } } } } } } } }