{ "openapi": "3.0.1", "info": { "title": "Walmart Products Scraper: Prices, Sellers, Ratings & Images", "description": "Scrape Walmart products by search words, search or category URL, or product URL: item id, name, brand, price, was-price, unit price, availability, seller, rating and review count, image URLs, category path, UPC and specifications. Several searches per run, a max per search. No login. Misses free.", "version": "0.1", "x-build-id": "knuCu627hA8vbg4sV" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/hyperbach~walmart-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-hyperbach-walmart-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/hyperbach~walmart-scraper/runs": { "post": { "operationId": "runs-sync-hyperbach-walmart-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/hyperbach~walmart-scraper/run-sync": { "post": { "operationId": "run-sync-hyperbach-walmart-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": { "startUrls": { "title": "Walmart URLs", "type": "array", "description": "Walmart pages to read, one a line: a search URL (`https://www.walmart.com/search?q=tshirt`, with any `sort=` or `facet=` you set in your browser), a category URL (`https://www.walmart.com/browse/…` or `/cp/…`), or a product URL (`https://www.walmart.com/ip/…/`, or the item id alone). A search or category URL is one list, read page after page; a product URL is one product. A URL that is not walmart.com gets a free `invalid` row; a URL given twice a free `duplicate` row.", "items": { "type": "string" } }, "searchQueries": { "title": "Search words", "type": "array", "description": "Words to search on walmart.com, one search a line (`air fryer`, `running shoes`), as you would type them in Walmart's search box. Each line is one list, like a search URL. Words Walmart matches with nothing give a free row with no product.", "items": { "type": "string" } }, "maxItemsPerSearch": { "title": "Max products per search or category", "minimum": 0, "maximum": 1000, "type": "integer", "description": "Stop each search or category list after this many new products. 0 = every product the list serves: Walmart shows a reader about 10 pages of a search (about 500 products) and about 20 pages of a category (about 500), whatever its count says. Product URLs are not counted here.", "default": 100 }, "includeDetails": { "title": "Read each product's page", "type": "boolean", "description": "On: every product of a list is read from its own page too, for all the image URLs, the UPC and model number, the five rating counts, the specifications, the variant options, the page's seller and category path. Off: the search card's fields only (price, was-price, unit price, availability, seller, rating, one image, category path), about ten times faster. Product URLs are always read from their page.", "default": true }, "onlyNew": { "title": "Only new products (memory between runs)", "type": "boolean", "description": "Remember every product delivered under this memory (stateStoreName, or a name derived from the inputs) and skip it free in the next run, before its page is read: a scheduled task delivers only what is new in the list. The search row counts the skipped (skipped_seen). A product asked by URL is always delivered.", "default": false }, "stateStoreName": { "title": "Memory name", "pattern": "^([a-zA-Z0-9][a-zA-Z0-9._-]{0,63})?$", "type": "string", "description": "The name of the onlyNew memory, so several tasks can share one or keep theirs apart. Empty: a name derived from the inputs.", "default": "" }, "maxItems": { "title": "Max product rows in the run", "minimum": 0, "maximum": 100000, "type": "integer", "description": "Stop the whole run after this many product rows (the charged rows). 0 = no run cap; each search still stops at its own limit above.", "default": 0 } } }, "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 } } } } } } } } } }