{ "openapi": "3.0.1", "info": { "title": "Walmart Price Scraper", "description": "Walmart search, category and product prices, including the rollback items whose price the search response leaves empty.", "version": "1.0", "x-build-id": "rvUpihiS4RuRG1IIf" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/sellerkit~walmart-price-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-sellerkit-walmart-price-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/sellerkit~walmart-price-scraper/runs": { "post": { "operationId": "runs-sync-sellerkit-walmart-price-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/sellerkit~walmart-price-scraper/run-sync": { "post": { "operationId": "run-sync-sellerkit-walmart-price-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 terms", "type": "array", "description": "Walmart search terms, for example \"gaming laptop\". Each term is paged until Max items is reached.", "items": { "type": "string" } }, "categoryUrls": { "title": "Category or browse URLs", "type": "array", "description": "Any Walmart listing page, for example https://www.walmart.com/browse/electronics/laptops/3944_1089430_3951 or a deals page. Product URLs pasted here are handled as products, so it does not matter which box you use.", "items": { "type": "string" } }, "productUrls": { "title": "Product URLs or item IDs", "type": "array", "description": "Specific products, for example 20305508298, /ip/... or the full URL. Query parts that decide which offer you see (selectedSellerId, classType, conditionGroupCode) are kept; ad tracking parts are dropped. These always read the product page, so they carry brand, model and UPC.", "items": { "type": "string" } }, "maxItems": { "title": "Max items", "minimum": 1, "type": "integer", "description": "Stop after this many unique items. This is also the cap on what you can be charged.", "default": 100 }, "maxPagesPerQuery": { "title": "Max pages per search term", "minimum": 1, "maximum": 100, "type": "integer", "description": "Walmart serves about 60 items per page.", "default": 5 }, "sort": { "title": "Sort", "enum": [ "best_match", "price_low", "price_high", "best_seller", "new", "rating_high" ], "type": "string", "description": "Result order.", "default": "best_match" }, "enrichFromProductPage": { "title": "Open each product page", "type": "boolean", "description": "Adds brand, model, UPC and the seller-level stock status, and confirms the price on the product page itself. Slower, and charged as a separate event.", "default": false }, "onSaleOnly": { "title": "Only items on rollback", "type": "boolean", "description": "Keep only items whose price is below the was-price. Filtered rows are never saved, so they are never charged.", "default": false }, "inStockOnly": { "title": "Only items in stock", "type": "boolean", "description": "Keep only items Walmart currently shows as in stock. Filtered rows are never saved, so they are never charged.", "default": false }, "skipSponsored": { "title": "Skip sponsored placements", "type": "boolean", "description": "Sponsored rows repeat across pages and distort price comparisons.", "default": false }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Leave this off unless you have residential proxies. Walmart's block reads the client, not the address, so this actor runs a real browser and works on a direct connection; datacenter proxy addresses are already burned and get blocked immediately.", "default": { "useApifyProxy": false } }, "requirePrice": { "title": "Drop rows with no price", "type": "boolean", "description": "Walmart leaves a handful of items with no price at all, usually out of stock ones. Turn this on to skip them. Skipped rows are never saved, so they are never charged.", "default": false } } }, "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 } } } } } } } } } }