# Woolworths Scraper - $0.90 / 1000 Products (`scrapeunblocker/woolworths-scraper`) Actor

Scrape Woolworths Australia groceries: search, categories, specials (Half Price and more) or product pages. Price, was-price, unit price, promotions, stock, barcode, categories, Health Star Rating, plus nutrition, ingredients and allergens for products. $0.90 per 1000 products.

- **URL**: https://apify.com/scrapeunblocker/woolworths-scraper.md
- **Developed by:** [Scrapeunblocker](https://apify.com/scrapeunblocker) (community)
- **Stats:** 2 total users, 1 monthly users, 100.0% runs succeeded, 0 bookmarks
- **User rating**: No ratings yet

## Pricing

from $0.90 / 1,000 results

This Actor is paid per event. You are not charged for the Apify platform usage, but only a fixed price for specific events.

Learn more: https://docs.apify.com/actors/running/actors-in-store.md#pay-per-event

## What's an Apify Actor?

An Actor is a serverless cloud program that runs on the Apify platform. It has two run modes.
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.

Apify vocabulary and the platform model are defined once, in the agent quickstart at https://apify.com/agents.md.

## 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.

Do not guess an integration path. Every one of them is in the agent quickstart at https://apify.com/agents.md: the Apify MCP server, Agent Skills with the Apify CLI, the JavaScript and Python clients, the REST API, and the account-free path for an agent with no human to sign in. It also carries the rule on stating cost before the first paid run.

For examples already wired to this Actor's own input schema, see the [API](#api) section below.

Each client library has reference documentation the quickstart does not restate: [JavaScript/TypeScript](https://docs.apify.com/api/client/js/docs.md) (`npm install apify-client`) and [Python](https://docs.apify.com/api/client/python/docs.md) (`pip install apify-client`).

# README

## Woolworths Scraper

Scrape **Woolworths Australia** (woolworths.com.au) groceries as clean JSON: **search results, whole categories, specials pages** (Half Price, Lower Shelf Price, Buy More Save More ...) or **product pages**. Every product comes with price, was-price, savings, **unit price**, the promotion (half price, special, multibuy), stock and purchase limit, barcode, image, categories, **Health Star Rating** and rating; product pages add the description, **ingredients, allergens, dietary claims, the nutrition panel**, serving size, storage, country of origin and all images. Prices are Woolworths' online prices in AUD.

### Features

- **Search mode** - products matching each search term (`queries`); `specialsOnly` keeps only products on special.
- **Category mode** - every product of each category (`categories`: browse link, path or category id).
- **Specials mode** - the products on each chosen specials page (`specialsPages`, Half Price by default).
- **Product mode** - one product page per input (`products`: product link or stockcode) with nutrition, ingredients and allergens.
- **Up to 2000 products per listing** - pages are followed automatically.
- **Many inputs per run** - search terms, categories or products in parallel.

### Use cases

- **Price monitoring** - track shelf prices, specials and unit prices across categories.
- **Promotions research** - every Half Price or multibuy deal of the week.
- **Nutrition and ingredient databases** - nutrition panels, allergens and dietary claims.
- **Retail and FMCG analytics** - assortment, brands and pricing by category.

### Input

| Field | Type | Default | Description |
|-------|------|---------|-------------|
| `mode` | string | `search` | `search`, `category`, `specials` or `product`. |
| `queries` | array | `milk` | Search terms (search mode). |
| `categories` | array | - | Browse links, paths (`dairy-eggs-fridge/milk`) or category ids (category mode). |
| `specialsPages` | array | `half-price` | Specials pages (specials mode). |
| `products` | array | - | Product links or stockcodes (product mode). |
| `maxResults` | integer | `36` | Products per listing (1-2000). |
| `sort` | string | `relevance` | `relevance`, `price_asc`, `price_desc`, `unit_price_asc`, `unit_price_desc`, `name`. |
| `specialsOnly` | boolean | `false` | Search: only products on special. |
| `proxyCountry` | string | - | Optional exit-IP country (ISO-2). |
| `concurrency` | integer | `3` | Inputs processed at the same time (1-5). |

#### Example input

```json
{
  "mode": "category",
  "categories": [
    "https://www.woolworths.com.au/shop/browse/dairy-eggs-fridge/milk",
    "snacks-confectionery/chips"
  ],
  "maxResults": 500,
  "sort": "unit_price_asc"
}
```

### Output

One dataset item per product. A listing item (search, category, specials):

```json
{
  "mode": "search",
  "input": "milk",
  "position": 1,
  "id": "88436",
  "name": "Dairy Farmers Full Cream Milk 2L",
  "brand": "Dairy Farmers",
  "size": "2L",
  "url": "https://www.woolworths.com.au/shop/productdetails/88436/dairy-farmers-full-cream-milk-full-cream-milk",
  "barcode": "9310199012717",
  "price": 4.7,
  "wasPrice": null,
  "currency": "AUD",
  "onSale": false,
  "savings": null,
  "promotion": null,
  "unitPrice": {
    "price": 2.35,
    "per": "1L",
    "text": "$2.35 / 1L"
  },
  "soldBy": "Each",
  "inStock": true,
  "available": true,
  "purchaseLimit": 36,
  "isNew": false,
  "onlineOnly": false,
  "sponsored": true,
  "image": "https://cdn1.woolworths.media/content/wowproductimages/large/088436.jpg",
  "categories": [
    "Container Bonus Credits",
    "Dairy, Eggs & Fridge"
  ],
  "healthStarRating": 4.0,
  "rating": null
}
```

A product-mode item adds the product page's details (lists shortened):

```json
{
  "mode": "product",
  "input": "888137",
  "id": "888137",
  "name": "Woolworths Full Cream Milk 2L",
  "brand": "Woolworths",
  "size": "2L",
  "url": "https://www.woolworths.com.au/shop/productdetails/888137/woolworths-full-cream-milk",
  "barcode": "9300633556143",
  "price": 3.4,
  "wasPrice": null,
  "currency": "AUD",
  "onSale": false,
  "savings": null,
  "promotion": null,
  "unitPrice": {
    "price": 1.7,
    "per": "1L",
    "text": "$1.70 / 1L"
  },
  "soldBy": "Each",
  "inStock": true,
  "available": true,
  "purchaseLimit": 36,
  "isNew": false,
  "onlineOnly": false,
  "sponsored": false,
  "image": "https://cdn0.woolworths.media/content/wowproductimages/large/888137.jpg",
  "categories": [
    "Dairy, Eggs & Fridge",
    "Milk"
  ],
  "healthStarRating": 4.0,
  "rating": null,
  "description": "Woolworths Full Cream Milk 2L",
  "ingredients": "Pasteurised and Homogenised Full Cream Milk.",
  "allergens": {
    "contains": [
      "Milk"
    ],
    "mayContain": [],
    "freeFrom": [
      "Egg Free",
      "Fish Free",
      "Gluten Free",
      "Soy Free",
      "Wheat Free"
    ]
  },
  "dietary": [
    "Gluten Free",
    "Low Salt"
  ],
  "nutrition": [
    {
      "name": "Energy",
      "perServing": "660.0kJ",
      "per100": "264.0kJ"
    },
    {
      "name": "Protein",
      "perServing": "8.2g",
      "per100": "3.3g"
    }
  ],
  "servingSize": "250.0 ML",
  "servingsPerPack": "8.0",
  "storage": null,
  "directions": null,
  "warnings": null,
  "countryOfOrigin": "Australia",
  "countryOfOriginLabel": "Product of Australia",
  "australianIngredientsPercent": 100.0,
  "department": "dairy",
  "aisle": "full cream milk",
  "images": [
    "https://cdn0.woolworths.media/content/wowproductimages/large/888137.jpg",
    "https://cdn0.woolworths.media/content/wowproductimages/large/888137_1.jpg"
  ],
  "variants": []
}
```

The key-value store also holds:

- `LISTINGS` - per search term, category or specials listing: total results, pages fetched and products collected.
- `ERRORS` - inputs that returned no products (no match, unknown product or category, blocked) with the reason. These are **not billed**.

### Pricing

**$0.90 per 1000 products.** You pay only for products delivered; inputs without products are not charged.

### Notes

- Woolworths shows 36 products per page; a listing returns at most `maxResults` products, sometimes a few less when pages repeat sponsored products.
- `healthStarRating` and `rating` are `null` for products without them.
- This actor is not affiliated with Woolworths.

# Actor input Schema

## `mode` (type: `string`):

Search: products for each search term. Category: every product of each category. Specials: the products on each specials page. Product: one product page each, with description, nutrition, ingredients and allergens.

## `queries` (type: `array`):

Used when What to scrape = Search. What to search on Woolworths, e.g. milk, tim tam, chicken breast. One per line.

## `categories` (type: `array`):

Used when What to scrape = Category. Browse links (https://www.woolworths.com.au/shop/browse/dairy-eggs-fridge/milk), browse paths (dairy-eggs-fridge/milk) or category ids (1_6E4F4E4). One per line.

## `specialsPages` (type: `array`):

Used when What to scrape = Specials. Which specials pages to list (Half Price when none is chosen).

## `products` (type: `array`):

Used when What to scrape = Product. Product links (https://www.woolworths.com.au/shop/productdetails/888137/woolworths-full-cream-milk) or stockcodes (888137). One per line.

## `maxResults` (type: `integer`):

Upper limit of products for each search term, category or specials page (1-2000). Woolworths lists 36 products per page.

## `sort` (type: `string`):

Order of the listings.

## `specialsOnly` (type: `boolean`):

Search: only products on special.

## `proxyCountry` (type: `string`):

Optional exit-IP country (ISO-2, e.g. AU, US). Leave empty: Woolworths answers every country and the service spreads the load.

## `concurrency` (type: `integer`):

How many search terms, categories, specials pages or products to process at the same time (1-5).

## Actor input object example

```json
{
  "mode": "search",
  "queries": [
    "milk"
  ],
  "specialsPages": [
    "half-price"
  ],
  "maxResults": 36,
  "sort": "relevance",
  "specialsOnly": false,
  "proxyCountry": "",
  "concurrency": 3
}
```

# Actor output Schema

## `results` (type: `string`):

One item per product with the input it came from and its position

## `listings` (type: `string`):

Per search, category or specials page: total results, pages fetched and products collected

## `errors` (type: `string`):

Inputs that returned no products (no match, unknown product or category, blocked), with the reason (not billed)

# 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 '<YOUR_API_TOKEN>' with your token
const client = new ApifyClient({
    token: '<YOUR_API_TOKEN>',
});

// Prepare Actor input
const input = {
    "queries": [
        "milk"
    ]
};

// Run the Actor and wait for it to finish
const run = await client.actor("scrapeunblocker/woolworths-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 '<YOUR_API_TOKEN>' with your token.
client = ApifyClient("<YOUR_API_TOKEN>")

# Prepare the Actor input
run_input = { "queries": ["milk"] }

# Run the Actor and wait for it to finish
run = client.actor("scrapeunblocker/woolworths-scraper").call(run_input=run_input)

# Fetch and print Actor results from the run's dataset (if there are any)
print(f"💾 Check your data here: https://console.apify.com/storage/datasets/{run.default_dataset_id}")
for item in client.dataset(run.default_dataset_id).iterate_items():
    print(item)

# 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/python/docs/quick-start

```

## CLI example

```bash
echo '{
  "queries": [
    "milk"
  ]
}' |
apify call scrapeunblocker/woolworths-scraper --silent --output-dataset

```

## MCP server setup

```json
{
    "mcpServers": {
        "apify": {
            "type": "http",
            "url": "https://mcp.apify.com/?tools=fetch-actor-details,scrapeunblocker/woolworths-scraper"
        }
    }
}
```

The hosted server signs you in with OAuth on first connect, so no API token belongs in this config. Clients without OAuth support can send an `Authorization: Bearer <APIFY_API_TOKEN>` header instead, using a token from API & Integrations in Apify Console (https://console.apify.com/settings/integrations).

## OpenAPI specification

Download the OpenAPI definition: https://api.apify.com/v2/actors/z3YIsPP1eYzwEg42m/builds/DoJ5Khlg9vkqdId6p/openapi.json