# Woolworths Australia Scraper (`crawlerbros/woolworths-au-scraper`) Actor Scrape Woolworths Australia groceries - search products by keyword, browse any of 19 departments, or pull current specials. Real prices, discounts, brands, nutrition, images and product URLs. - **URL**: https://apify.com/crawlerbros/woolworths-au-scraper.md - **Developed by:** [Crawler Bros](https://apify.com/crawlerbros) (community) - **Categories:** E-commerce, Automation, Integrations - **Stats:** 1 total users, 0 monthly users, 100.0% runs succeeded, 0 bookmarks - **User rating**: No ratings yet ## Pricing from $3.00 / 1,000 results This Actor is paid per event and usage. You are charged both the fixed price for specific events and for Apify platform usage. Since this Actor supports Apify Store discounts, the price gets lower the higher subscription plan you have. Learn more: https://docs.apify.com/platform/actors/running/actors-in-store#pay-per-event ## What's an Apify Actor? Actors are a software tools running on the Apify platform, for all kinds of web data extraction and automation use cases. In Batch mode, an Actor accepts a well-defined JSON input, performs an action which can take anything from a few seconds to a few hours, and optionally produces a well-defined JSON output, datasets with results, or files in key-value store. In Standby mode, an Actor provides a web server which can be used as a website, API, or an MCP server. Actors are written with capital "A". ## How to integrate an Actor? If asked about integration, you help developers integrate Actors into their projects. You adapt to their stack and deliver integrations that are safe, well-documented, and production-ready. The best way to integrate Actors is as follows. In JavaScript/TypeScript projects, use official [JavaScript/TypeScript client](https://docs.apify.com/api/client/js.md): ```bash npm install apify-client ``` In Python projects, use official [Python client library](https://docs.apify.com/api/client/python.md): ```bash pip install apify-client ``` In shell scripts, use [Apify CLI](https://docs.apify.com/cli/docs.md): ````bash # MacOS / Linux curl -fsSL https://apify.com/install-cli.sh | bash # Windows irm https://apify.com/install-cli.ps1 | iex ```bash In AI frameworks, you might use the [Apify MCP server](https://docs.apify.com/platform/integrations/mcp.md). If your project is in a different language, use the [REST API](https://docs.apify.com/api/v2.md). For usage examples, see the [API](#api) section below. For more details, see Apify documentation as [Markdown index](https://docs.apify.com/llms.txt) and [Markdown full-text](https://docs.apify.com/llms-full.txt). # README ## Woolworths Australia Scraper Scrape [Woolworths](https://www.woolworths.com.au) Australia's online groceries — search for products by keyword, browse any of 19 departments, or pull current specials. Real prices, discounts, brands, nutrition, images and product URLs, straight from Woolworths' own public search API. No login, no cookies required. ### What this actor does - **Three modes:** `search`, `byCategory`, `weeklyDeals` - **19 real departments** to browse: Fruit & Veg, Poultry Meat & Seafood, Dairy Eggs & Fridge, Bakery, Freezer, Pantry, Drinks, and more - **Automatic pagination** — pages through results until it reaches your requested `maxItems` or Woolworths has no more matching products - **Filters:** price range, on-sale only, brand - **Empty fields are omitted** — every record only contains what Woolworths actually returned ### Output per product - `productId` — Woolworths' Stockcode - `name`, `brand`, `unit` (pack size, e.g. `3L`, `4 Pint`) - `price` — current price (AUD) - `originalPrice`, `discount`, `discountPercent` — only present when the product is discounted - `category` — department name; `subcategory` — Woolworths' own fine-grained category (e.g. `Full Cream Milk`, `Shampoo & Conditioner`) - `variant` — flavor/variant descriptor (e.g. `Berry`, `Mini Bars 12 pack`) - `barcode` — the product's EAN/GTIN barcode - `pricePerUnit` — Woolworths' own per-unit price string (e.g. `$1.72 / 1L`) - `description` — product description, when published - `purchaseLimit` — maximum quantity purchasable per order - `imageUrl`, `productUrl` - `isOnSale`, `inStock`, `isNew` - `ingredients`, `allergens` — when Woolworths publishes ingredient/allergen data for the product - `dietaryAttributes` — e.g. `Gluten Free`, `Vegetarian`, `Low Salt` - `healthStarRating` — Australia's official 0.5-5 Health Star Rating, when published - `nutrition` — per-100g nutrition panel for food products (`energyKj`, `protein`, `fat`, `saturatedFat`, `carbohydrates`, `sugars`, `sodium`), when published - `sourceUrl`, `scrapedAt`, `recordType: "product"` ### Input | Field | Type | Default | Description | |---|---|---|---| | `mode` | string | `search` | `search` / `byCategory` / `weeklyDeals` | | `searchQuery` | string | `milk` | Free-text query (mode=search) | | `category` | string | `Dairy, Eggs & Fridge` | Department to browse (mode=byCategory / weeklyDeals) | | `minPrice` / `maxPrice` | number | – | Price range filter (AUD) | | `onSaleOnly` | bool | `false` | Only emit discounted products (always on in weeklyDeals mode) | | `brand` | string | – | Filter by brand (case-insensitive substring) | | `maxItems` | int | `30` | Hard cap, 1–200 (auto-paginated) | | `proxyConfiguration` | object | AUTO proxy | Apify proxy config (free datacenter group) | #### Example: search for chocolate under $5 ```json { "mode": "search", "searchQuery": "chocolate", "maxPrice": 5, "maxItems": 30 } ```` #### Example: browse the Bakery department ```json { "mode": "byCategory", "category": "1_DEB537E", "maxItems": 50 } ``` #### Example: current specials in Drinks ```json { "mode": "weeklyDeals", "category": "1_5AF3A0A", "maxItems": 40 } ``` ### Use cases - **Price monitoring** — track Woolworths AU prices and specials over time - **Grocery comparison apps** — feed real Australian supermarket pricing into a comparison tool - **Deal alerts** — surface products newly on special in a chosen department - **Market research** — analyse brand assortment and pricing by department - **Meal planning apps** — pull ingredient prices for a shopping list ### FAQ **Do I need a Woolworths account or cookies?** No — this actor reads Woolworths' own public search API, the same data your browser receives when you search or browse the site. **How does `weeklyDeals` mode work?** It searches the selected department and keeps only products Woolworths currently marks as on special (`IsOnSpecial`, half price, or Everyday Rewards special), paging through results automatically to find enough. **Why does `byCategory` search by department name instead of a category ID?** Woolworths' public search API accepts free-text queries but doesn't expose a stable category-ID filter parameter. Searching by the department's own real display name (e.g. `"Dairy, Eggs & Fridge"`) reliably surfaces that department's products — the department dropdown handles this automatically. **Is this free to run?** Yes — the actor uses Apify's free `AUTO` datacenter proxy group (falling back to a direct connection automatically), so it works on the Apify free plan with no paid add-ons. # Actor input Schema ## `mode` (type: `string`): What to fetch. ## `searchQuery` (type: `string`): Free-text product search, e.g. `milk`, `chicken breast`, `chocolate`. ## `category` (type: `string`): Woolworths department to browse or scan for specials. ## `minPrice` (type: `number`): Drop products cheaper than this. ## `maxPrice` (type: `number`): Drop products pricier than this. ## `onSaleOnly` (type: `boolean`): Only emit products currently on special. Always applied in `weeklyDeals` mode. ## `brand` (type: `string`): Only emit products whose brand contains this text (case-insensitive), e.g. `Dairy Farmers`. ## `maxItems` (type: `integer`): Hard cap on emitted records. The actor pages through results automatically (up to 8 pages of 36) to reach this many. ## `proxyConfiguration` (type: `object`): Uses Apify's free datacenter proxy pool. A direct (no-proxy) fallback is used automatically if needed. ## Actor input object example ```json { "mode": "search", "searchQuery": "milk", "category": "1_6E4F4E4", "onSaleOnly": false, "maxItems": 30, "proxyConfiguration": { "useApifyProxy": true } } ``` # Actor output Schema ## `products` (type: `string`): Dataset containing all scraped Woolworths AU products. # API You can run this Actor programmatically using our API. Below are code examples in JavaScript, Python, and CLI, as well as the OpenAPI specification and MCP server setup. ## JavaScript example ```javascript import { ApifyClient } from 'apify-client'; // Initialize the ApifyClient with your Apify API token // Replace the '' with your token const client = new ApifyClient({ token: '', }); // Prepare Actor input const input = { "mode": "search", "searchQuery": "milk", "category": "1_6E4F4E4", "onSaleOnly": false, "maxItems": 30, "proxyConfiguration": { "useApifyProxy": true } }; // Run the Actor and wait for it to finish const run = await client.actor("crawlerbros/woolworths-au-scraper").call(input); // Fetch and print Actor results from the run's dataset (if any) console.log('Results from dataset'); console.log(`💾 Check your data here: https://console.apify.com/storage/datasets/${run.defaultDatasetId}`); const { items } = await client.dataset(run.defaultDatasetId).listItems(); items.forEach((item) => { console.dir(item); }); // 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/js/docs ``` ## Python example ```python from apify_client import ApifyClient # Initialize the ApifyClient with your Apify API token # Replace '' with your token. client = ApifyClient("") # Prepare the Actor input run_input = { "mode": "search", "searchQuery": "milk", "category": "1_6E4F4E4", "onSaleOnly": False, "maxItems": 30, "proxyConfiguration": { "useApifyProxy": True }, } # Run the Actor and wait for it to finish run = client.actor("crawlerbros/woolworths-au-scraper").call(run_input=run_input) # Fetch and print Actor results from the run's dataset (if there are any) print("💾 Check your data here: https://console.apify.com/storage/datasets/" + run["defaultDatasetId"]) for item in client.dataset(run["defaultDatasetId"]).iterate_items(): print(item) # 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/python/docs/quick-start ``` ## CLI example ```bash echo '{ "mode": "search", "searchQuery": "milk", "category": "1_6E4F4E4", "onSaleOnly": false, "maxItems": 30, "proxyConfiguration": { "useApifyProxy": true } }' | apify call crawlerbros/woolworths-au-scraper --silent --output-dataset ``` ## MCP server setup ```json { "mcpServers": { "apify": { "command": "npx", "args": [ "mcp-remote", "https://mcp.apify.com/?tools=crawlerbros/woolworths-au-scraper", "--header", "Authorization: Bearer " ] } } } ``` ## OpenAPI specification ```json { "openapi": "3.0.1", "info": { "title": "Woolworths Australia Scraper", "description": "Scrape Woolworths Australia groceries - search products by keyword, browse any of 19 departments, or pull current specials. Real prices, discounts, brands, nutrition, images and product URLs.", "version": "1.0", "x-build-id": "Ezb5BAmegYaF9BvjD" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/crawlerbros~woolworths-au-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-crawlerbros-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/crawlerbros~woolworths-au-scraper/runs": { "post": { "operationId": "runs-sync-crawlerbros-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/crawlerbros~woolworths-au-scraper/run-sync": { "post": { "operationId": "run-sync-crawlerbros-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", "required": [ "mode" ], "properties": { "mode": { "title": "Mode", "enum": [ "search", "byCategory", "weeklyDeals" ], "type": "string", "description": "What to fetch.", "default": "search" }, "searchQuery": { "title": "Search query (mode=search)", "type": "string", "description": "Free-text product search, e.g. `milk`, `chicken breast`, `chocolate`.", "default": "milk" }, "category": { "title": "Department (mode=byCategory / weeklyDeals)", "enum": [ "1-E5BEE36E", "1_D5A2236", "1_6E4F4E4", "1_DEB537E", "1_ACA2FC2", "1_39FD49C", "1_5AF3A0A", "1_717445A", "1_3151F6F", "1_8AD6702", "1_9E92C35", "1_F229FBE", "1_8E4DA6F", "1_8D61DD6", "1_894D0A8", "1_9851658", "1_2432B58", "1_717A94B", "1_61D6FEB" ], "type": "string", "description": "Woolworths department to browse or scan for specials.", "default": "1_6E4F4E4" }, "minPrice": { "title": "Min price (AUD)", "minimum": 0, "maximum": 100000, "type": "number", "description": "Drop products cheaper than this." }, "maxPrice": { "title": "Max price (AUD)", "minimum": 0, "maximum": 100000, "type": "number", "description": "Drop products pricier than this." }, "onSaleOnly": { "title": "On sale only", "type": "boolean", "description": "Only emit products currently on special. Always applied in `weeklyDeals` mode.", "default": false }, "brand": { "title": "Filter by brand", "type": "string", "description": "Only emit products whose brand contains this text (case-insensitive), e.g. `Dairy Farmers`." }, "maxItems": { "title": "Max items", "minimum": 1, "maximum": 200, "type": "integer", "description": "Hard cap on emitted records. The actor pages through results automatically (up to 8 pages of 36) to reach this many.", "default": 30 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Uses Apify's free datacenter proxy pool. A direct (no-proxy) fallback is used automatically if needed.", "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 } } }, "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 } } } } } } } } } } ```