{ "openapi": "3.0.1", "info": { "title": "Woolworths Australia Scraper", "description": "Scrape Woolworths Australia products by search, category or URL: price, was price, specials, unit price, stock, rating, nutrition and barcode. Export CSV, Excel, JSON or XML.", "version": "0.1", "x-build-id": "p0RdQognF7FJR8XDa" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/parseforge~woolworths-au-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-parseforge-woolworths-au-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/parseforge~woolworths-au-scraper/runs": { "post": { "operationId": "runs-sync-parseforge-woolworths-au-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/parseforge~woolworths-au-scraper/run-sync": { "post": { "operationId": "run-sync-parseforge-woolworths-au-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": { "searchTerms": { "title": "Search terms", "type": "array", "description": "Product searches, one per line, as you would type them on woolworths.com.au (e.g. milk, coffee beans, nappies). Each term is paged until maxItems is reached.", "items": { "type": "string" } }, "categorySlugs": { "title": "Departments", "uniqueItems": true, "type": "array", "description": "Whole store departments to list. For an aisle or a specials page (half price, lower shelf price), paste its URL in Woolworths URLs instead.", "items": { "type": "string", "enum": [ "everyday-market", "healthylife", "fruit-veg", "poultry-meat-seafood", "dinner", "deli", "dairy-eggs-fridge", "bakery", "lunch-box", "freezer", "snacks-confectionery", "pantry", "international-foods", "drinks", "gift-ideas", "beer-wine-spirits", "beauty", "personal-care", "health-wellness", "cleaning-maintenance", "baby", "pet", "electronics", "home-lifestyle" ], "enumTitles": [ "Everyday Market", "Healthylife", "Fruit & Veg", "Poultry, Meat & Seafood", "Dinner", "Deli", "Dairy, Eggs & Fridge", "Bakery", "Lunch Box", "Freezer", "Snacks & Confectionery", "Pantry", "International Foods", "Drinks", "Gift Ideas", "Beer, Wine & Spirits", "Beauty", "Personal Care", "Health & Wellness", "Cleaning & Maintenance", "Baby", "Pet", "Electronics", "Home & Lifestyle" ] } }, "startUrls": { "title": "Woolworths URLs", "type": "array", "description": "Category or aisle pages (woolworths.com.au/shop/browse/...), specials pages, search result pages (/shop/search/products?searchTerm=...) or product pages (/shop/productdetails/). Product pages add country of origin.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "maxItems": { "title": "Max Items", "minimum": 1, "maximum": 1000000, "type": "integer", "description": "Free users: Limited to 10 items (preview). Paid users: Optional, max 1,000,000" }, "sortBy": { "title": "Sort by", "enum": [ "relevance", "priceLowToHigh", "priceHighToLow", "unitPriceLowToHigh", "name" ], "type": "string", "description": "Order in which Woolworths returns the products.", "default": "relevance" }, "specialsOnly": { "title": "Specials only", "type": "boolean", "description": "Return only products currently on special (price drops, half price, multibuy).", "default": false }, "inStockOnly": { "title": "In stock only", "type": "boolean", "description": "Skip products that are out of stock online.", "default": false }, "includeRatings": { "title": "Include ratings", "type": "boolean", "description": "Add the average star rating, rating count and review count (one extra lookup per page of products).", "default": true }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Apify proxy settings. Leave the default. Choose RESIDENTIAL with country AU only if you want to force it.", "default": { "useApifyProxy": true } } } }, "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 } } } } } } } } } }