{ "openapi": "3.0.1", "info": { "title": "Walmart Search Scraper - Products, Prices, Ratings", "description": "Walmart.com search results and product pages. Returns usItemId, name, price, wasPrice (sale), rating, reviews, image, seller, availability, Rollback badge, sponsored flag. Use when an agent needs Walmart product prices, deals, or search results for a keyword or URL.", "version": "0.5", "x-build-id": "x2LiufPgyNGE4Rr4a" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/zet46~walmart-search-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-zet46-walmart-search-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/zet46~walmart-search-scraper/runs": { "post": { "operationId": "runs-sync-zet46-walmart-search-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/zet46~walmart-search-scraper/run-sync": { "post": { "operationId": "run-sync-zet46-walmart-search-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": { "queries": { "title": "Search queries", "type": "array", "description": "List of Walmart search terms. Each query is paginated until maxItemsPerQuery or maxPagesPerQuery is reached. Example: ['laptop', 'coffee maker', 'nike shoes'].", "items": { "type": "string" } }, "productUrls": { "title": "Product URLs", "type": "array", "description": "Walmart product URLs to scrape in detail. Accepts full URLs ('https://www.walmart.com/ip/.../5304824336'), canonical paths ('/ip/.../5304824336') or bare usItemId ('5304824336').", "items": { "type": "string" } }, "maxItemsPerQuery": { "title": "Max items per query", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Upper bound on items returned per query. One search page yields 20-57 products.", "default": 100 }, "maxPagesPerQuery": { "title": "Max search pages per query", "minimum": 1, "maximum": 25, "type": "integer", "description": "How many search result pages to fetch per query. Walmart serves up to 25 pages.", "default": 3 }, "includeSponsored": { "title": "Include sponsored products", "type": "boolean", "description": "Walmart injects paid ads among organic results (isSponsoredFlag=true). Off by default to keep only organic rankings.", "default": false }, "onlyInStock": { "title": "Only in-stock items", "type": "boolean", "description": "Skip items whose availabilityStatus is OUT_OF_STOCK / RETIRED.", "default": false }, "minRating": { "title": "Minimum star rating", "minimum": 0, "maximum": 5, "type": "number", "description": "Skip (and don't charge for) items below this rating. Items without a rating are also skipped if set." }, "minReviews": { "title": "Minimum review count", "minimum": 0, "type": "integer", "description": "Skip (and don't charge for) items with fewer reviews. Items without a review count are also skipped if set." }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Apify datacenter US proxy is used by default (country is always forced to US because Walmart only serves prices to US IPs). You rarely need to change this.", "default": { "useApifyProxy": true } } } }, "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 } } } } } } } } } }