{ "openapi": "3.0.1", "info": { "title": "Walmart Product Scraper | US CA MX Prices Reviews", "description": "Scrape Walmart.com, Walmart.ca & Walmart.com.mx products — search, categories, catalogs & PDP. Extract prices, ratings, sellers, stock, variants & reviews. Export Excel/CSV/JSON.", "version": "0.1", "x-build-id": "3YIBacBwfGiPV0o5e" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/lentic_clockss~walmart-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-lentic_clockss-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/lentic_clockss~walmart-scraper/runs": { "post": { "operationId": "runs-sync-lentic_clockss-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/lentic_clockss~walmart-scraper/run-sync": { "post": { "operationId": "run-sync-lentic_clockss-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", "required": [ "mode" ], "properties": { "market": { "title": "Market", "enum": [ "US", "CA", "MX" ], "type": "string", "description": "Walmart market site: US (walmart.com), CA (walmart.ca), or MX (walmart.com.mx).", "default": "US" }, "mode": { "title": "Mode", "enum": [ "search", "browse", "departments", "product", "catalog", "categoryHub" ], "type": "string", "description": "search = keyword SERP; browse = category PLP; departments = department taxonomy; product = PDP by ID/URL; catalog = product catalog; categoryHub = category-tree hub.", "default": "search" }, "keywords": { "title": "Keywords", "minItems": 0, "maxItems": 10, "type": "array", "description": "Search keywords (search mode). First keyword used if keyword is empty.", "items": { "type": "string" }, "default": [ "wireless earbuds" ] }, "keyword": { "title": "Keyword", "type": "string", "description": "Single search keyword (optional if keywords is set)." }, "categoryId": { "title": "Category ID", "type": "string", "description": "Walmart catId for browse mode (e.g. 3944 electronics, 976759 food)." }, "categorySlug": { "title": "Category SEO slug", "type": "string", "description": "Optional browse slug (e.g. electronics)." }, "facet": { "title": "Facet", "type": "string", "description": "Facet expression, e.g. brand:Apple" }, "sort": { "title": "Sort", "enum": [ "best_match", "price_low", "price_high", "best_seller", "highest_rated", "new" ], "type": "string", "description": "Walmart sort query value.", "default": "best_match" }, "postalCode": { "title": "Postal / ZIP code", "type": "string", "description": "US ZIP for location-sensitive price/fulfillment (recommended).", "default": "10001" }, "storeId": { "title": "Store ID", "type": "string", "description": "Optional Walmart store id (stores= query)." }, "productUrls": { "title": "Product URLs", "type": "array", "description": "PDP URLs for product mode.", "items": { "type": "string" } }, "usItemIds": { "title": "US Item IDs", "type": "array", "description": "Walmart usItemId values for product mode.", "items": { "type": "string" } }, "enrichDetails": { "title": "Enrich list with PDP", "type": "boolean", "description": "Default off so Store Test finishes under the platform ~300s cap. When true on search/browse, fetch PDP details for up to enrichLimit items and attach US seller lead fields (phone/email/门牌/address) from the seller storefront hydration. CA/MX seller contacts are gate-locked (no public storefront).", "default": false }, "enrichLimit": { "title": "PDP enrichment limit", "minimum": 1, "maximum": 50, "type": "integer", "description": "Maximum listing products to enrich with PDP data when enrichDetails is enabled.", "default": 5 }, "minPrice": { "title": "Minimum price", "minimum": 0, "type": "number", "description": "Optional minimum product price filter." }, "maxPrice": { "title": "Maximum price", "minimum": 0, "type": "number", "description": "Optional maximum product price filter; must be at least minPrice." }, "excludeSponsored": { "title": "Exclude sponsored products", "type": "boolean", "description": "Remove sponsored product cards from listing output.", "default": false }, "facetCrawl": { "title": "Crawl facets", "type": "boolean", "description": "Discover and crawl listing facet slices in addition to the base listing.", "default": false }, "facetCrawlMaxFacets": { "title": "Maximum facets to crawl", "minimum": 1, "maximum": 100, "type": "integer", "description": "Optional cap on facet slices when facetCrawl is enabled.", "default": 15 }, "expandVariants": { "title": "Expand variants", "type": "boolean", "description": "Include available PDP variants such as size, color, or pack options.", "default": false }, "maxReviews": { "title": "Maximum reviews", "minimum": 0, "maximum": 100, "type": "integer", "description": "Optional cap on reviews returned for each enriched product.", "default": 0 }, "maxResults": { "title": "Max results", "minimum": 1, "maximum": 500, "type": "integer", "description": "Maximum items to return. Free plan capped at 200.", "default": 1 }, "workerBaseUrl": { "title": "Worker base URL override", "type": "string", "description": "Optional HTTPS Cloud Run origin override (allowlisted). Prefer Actor env WORKER_BASE_URL." } } }, "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 } } } } } } } } } }