{ "openapi": "3.0.1", "info": { "title": "Walmart Product Search", "description": "Scrape Walmart search results by keyword with real-time product data — titles, prices, list prices, savings, ratings, review counts, seller names, shipping options, stock availability, and badge flags. Sort by Best Match, Price, Best Seller, store ID, ZIP code, and more.", "version": "1.0", "x-build-id": "mZBiZJyb4UT6TXdlS" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/burbn~walmart-product-search/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-burbn-walmart-product-search", "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/burbn~walmart-product-search/runs": { "post": { "operationId": "runs-sync-burbn-walmart-product-search", "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/burbn~walmart-product-search/run-sync": { "post": { "operationId": "run-sync-burbn-walmart-product-search", "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": [ "query" ], "properties": { "query": { "title": "🔎 Search Query", "type": "string", "description": "Enter the product keyword to search for on Walmart (e.g., gaming laptop, iphone 17, samsung tv, air fryer).", "default": "iphone 17" }, "domain": { "title": "🌍 Walmart Marketplace", "enum": [ "us", "ca" ], "type": "string", "description": "Select the Walmart domain/marketplace to search. Sets the country, language, and currency.", "default": "us" }, "sort_by": { "title": "📊 Sort By", "enum": [ "best_match", "price_low", "price_high", "best_seller", "top_rated" ], "type": "string", "description": "Sort order for search results.", "default": "best_match" }, "min_price": { "title": "💰 Minimum Price", "type": "number", "description": "Only return products with price greater than this value (in the currency of the selected marketplace). Must be lower than max_price." }, "max_price": { "title": "💰 Maximum Price", "type": "number", "description": "Only return products with price less than this value (in the currency of the selected marketplace). Must be higher than min_price." }, "store_id": { "title": "🏬 Store ID", "type": "string", "description": "Walmart store ID to filter results by a specific store's availability. Leave empty for all stores." }, "state": { "title": "🗺️ US State Code", "type": "string", "description": "US state code to localize search results (e.g., CA, NY, TX, FL). Only applicable for US marketplace." }, "zip": { "title": "📮 ZIP / Postal Code", "type": "string", "description": "ZIP or postal code to localize search results (e.g., 90210, 10001). Helps show local pricing and availability." }, "facet": { "title": "🏷️ Facet Filter", "type": "string", "description": "Facet filter string for refining results (e.g., by brand, category). Advanced filter — leave empty if not needed." }, "page": { "title": "📄 Start Page", "minimum": 1, "maximum": 100, "type": "integer", "description": "Starting page number. Range: 1-100.", "default": 1 }, "maxPages": { "title": "🎯 Maximum Pages", "minimum": 1, "maximum": 100, "type": "integer", "description": "Maximum number of pages to scrape. Set to 1 for a quick test, or higher for comprehensive data.", "default": 1 } } }, "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 } } } } } } } } } }