{ "openapi": "3.0.1", "info": { "title": "Ultimate Walmart Scraper", "description": "This is the ultimate web scraping tool for extracting the most relevant data points from products on Walmart.com! Developed by an expert software developer, this powerful scraper is a fast and reliable tool for all your web scraping needs.", "version": "1.3", "x-build-id": "Ix2r44K74Bxhzbs5I" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/w3crawler~ultimate-walmart-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-w3crawler-ultimate-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/w3crawler~ultimate-walmart-scraper/runs": { "post": { "operationId": "runs-sync-w3crawler-ultimate-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/w3crawler~ultimate-walmart-scraper/run-sync": { "post": { "operationId": "run-sync-w3crawler-ultimate-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": { "market": { "title": "Generated search market", "enum": [ "ca", "us" ], "type": "string", "description": "Market used only when a search term generates a URL. Canada is the default because its public pages currently expose structured product data; US URLs remain supported and report an access diagnostic when challenged.", "default": "ca" }, "startUrls": { "title": "Product or listing URLs", "type": "array", "description": "Absolute public Walmart.com or Walmart.ca product, search, category, or browse URLs. Explicit URLs take precedence over generated search terms.", "items": { "type": "object", "properties": { "url": { "title": "Walmart URL", "description": "Absolute HTTPS Walmart URL.", "type": "string", "pattern": "^https://([^/]+\\.)?walmart\\.(com|ca)/" } }, "required": [ "url" ] }, "default": [] }, "urls": { "title": "URL aliases", "type": "array", "description": "Compatibility alias for startUrls.", "items": { "type": "object", "properties": { "url": { "title": "Walmart URL", "description": "Absolute HTTPS Walmart URL.", "type": "string" } }, "required": [ "url" ] }, "default": [] }, "searchTerms": { "title": "Search terms", "type": "array", "description": "Non-empty terms converted to public Walmart search URLs when no explicit URL is supplied. Maximum 25 terms, 200 characters each.", "items": { "type": "string", "minLength": 1, "maxLength": 200 }, "default": [] }, "search_terms": { "title": "Search term alias", "type": "array", "description": "Compatibility alias for searchTerms.", "items": { "type": "string", "minLength": 1, "maxLength": 200 }, "default": [] }, "queries": { "title": "Query aliases", "type": "array", "description": "Compatibility alias for searchTerms.", "items": { "type": "string", "minLength": 1, "maxLength": 200 }, "default": [] }, "query": { "title": "Single search term", "maxLength": 200, "type": "string", "description": "One search term alias. It is ignored when a valid explicit URL is supplied." }, "url": { "title": "Single URL", "type": "string", "description": "One URL alias for startUrls." }, "maxItems": { "title": "Maximum products", "minimum": 1, "maximum": 500, "type": "integer", "description": "Global maximum of unique product records across all start URLs and pages.", "default": 50 }, "maxPages": { "title": "Maximum pages per URL", "minimum": 1, "maximum": 10, "type": "integer", "description": "Maximum number of observed search/browse pages to request for each start URL. Product URLs are fetched once.", "default": 1 }, "deduplicate": { "title": "Deduplicate products", "type": "boolean", "description": "Use the stable Walmart item ID, then canonical URL, to deduplicate across pages and URLs.", "default": true }, "includeDetails": { "title": "Enrich product details", "type": "boolean", "description": "Fetch up to maxDetailItems public product pages and merge descriptions, specifications, media, and optional reviews.", "default": true }, "maxDetailItems": { "title": "Maximum detail items", "minimum": 0, "maximum": 50, "type": "integer", "description": "Maximum product records eligible for detail enrichment. Use 0 to disable detail requests even when includeDetails is true.", "default": 5 }, "includeReviews": { "title": "Include public reviews", "type": "boolean", "description": "Include up to maxReviews public reviews from successfully enriched product pages.", "default": false }, "maxReviews": { "title": "Maximum reviews per product", "minimum": 0, "maximum": 20, "type": "integer", "description": "Bound for public review objects included in each detail-enriched record.", "default": 5 }, "requestDelayMs": { "title": "Delay between requests (ms)", "minimum": 0, "maximum": 10000, "type": "integer", "description": "Minimum pacing delay between public requests. The Actor processes requests sequentially for predictable limits.", "default": 700 }, "maxRequestRetries": { "title": "Maximum retries", "minimum": 0, "maximum": 3, "type": "integer", "description": "Bounded retries for transient HTTP statuses; access challenges are never bypassed.", "default": 1 }, "timeoutMs": { "title": "Request timeout (ms)", "minimum": 5000, "maximum": 120000, "type": "integer", "description": "Maximum time for each public HTTP request.", "default": 30000 }, "userAgent": { "title": "User agent", "maxLength": 300, "type": "string", "description": "Optional transparent client user-agent, limited to 300 characters." }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Optional ordinary Apify Proxy settings. When enabled, each request obtains a proxy URL and the summary reports proxy use; this does not bypass challenges.", "default": { "useApifyProxy": 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 }, "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 } } } } } } } } } }