# Woolworths Australia Products Scraper (`neuro-scraper/woolworths-australia-products-scraper`) Actor

Woolworths Australia Products Scraper SD - Woolworths Australia Products Scraper is a logged-out tool that extracts woolworths.com.au grocery products from searches, categories, specials or product links: prices, was-price, unit price, specials, stock, ratings, nutrition, ingredients and allergens.

- **URL**: https://apify.com/neuro-scraper/woolworths-australia-products-scraper.md
- **Developed by:** [Neuro Scraper](https://apify.com/neuro-scraper) (community)
- **Categories:** E-commerce, Automation, Developer tools
- **Stats:** 2 total users, 1 monthly users, 100.0% runs succeeded, 0 bookmarks
- **User rating**: No ratings yet

## Pricing

from $2.49 / 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/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

./README.md

# Actor input Schema

## `searchTerms` (type: `array`):

What you would type into the Woolworths search box, one search per line. Every result page is read until Max items, Max products per search term or the end of the results. Example: milk

## `startUrls` (type: `array`):

Optional. woolworths.com.au search URLs (https://www.woolworths.com.au/shop/search/products?searchTerm=milk), category or specials URLs (https://www.woolworths.com.au/shop/browse/dairy-eggs-fridge/cheese, https://www.woolworths.com.au/shop/browse/specials/half-price), product URLs (https://www.woolworths.com.au/shop/productdetails/888140/a2-milk-full-cream) or plain product codes (888140).

## `specialsCategory` (type: `string`):

Optional. Also scrape one Woolworths specials list (the category id is read from the site's live category menu). Example: half-price

## `maxItems` (type: `integer`):

Maximum number of products in total for the whole run. Result pages (36 products each) are requested one after another with the site's own page number until this number or the end of the list. Example: 50

## `maxResultsPerTerm` (type: `integer`):

Optional limit per search term, category or URL (0 = only Max products applies). Example: 100

## `sortBy` (type: `string`):

Order of the results, as on woolworths.com.au. The values are checked against the site's own sort menu on every run; a sort the site does not offer for a list (Specials sort on a category) skips that list with an error. Example: priceLowToHigh

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

Only products on special. Searches use the site's own specials filter; for category URLs the downloaded products are filtered.

## `inStockOnly` (type: `boolean`):

Leave out products that are out of stock online (checked on the downloaded products).

## `minPrice` (type: `integer`):

Leave out products cheaper than this (0 = no minimum; checked on the downloaded products). Example: 2

## `maxPrice` (type: `integer`):

Leave out products dearer than this (0 = no maximum; checked on the downloaded products). Example: 10

## `minRating` (type: `string`):

Keep only products with at least this average star rating (needs Include ratings; products without ratings are left out when a minimum is set).

## `includeMarketplace` (type: `boolean`):

Woolworths lists third-party Everyday Market (marketplace) items next to its own groceries. Turn off to keep Woolworths' own range only.

## `excludeCategories` (type: `array`):

Optional. Products whose department or category name contains any of these words are left out (case-insensitive). Example: Everyday Market

## `includeRatings` (type: `boolean`):

Add average rating, rating count, review count and star distribution (one extra request per result page, all products of the page at once).

## `fetchDetails` (type: `boolean`):

Open every product's detail data and add country of origin, the country-of-origin label text and the aisle. One extra request per product. Nutrition, ingredients and allergens are included without it.

## `fetchReviews` (type: `boolean`):

Add the written customer reviews of every product (rating, text, author, source, date). Extra requests per product (10 reviews per request).

## `maxReviewsPerProduct` (type: `integer`):

Only with Fetch customer reviews. Reviews are paged 10 at a time until this number or the last review. Example: 20

## `reviewsSort` (type: `string`):

Only with Fetch customer reviews. The same three orders the product page offers.

## `includeRaw` (type: `boolean`):

Add the full product object as Woolworths returns it (column raw) - large.

## `maxPagesPerSearch` (type: `integer`):

Safety limit on result pages per search term or category (Max products is the main limit). Example: 200

## `proxyConfiguration` (type: `object`):

Residential proxy in Australia is the default (woolworths.com.au is protected by Akamai; prices are national online prices).

## Actor input object example

```json
{
  "searchTerms": [
    "milk"
  ],
  "specialsCategory": "",
  "maxItems": 50,
  "maxResultsPerTerm": 0,
  "sortBy": "relevance",
  "specialsOnly": false,
  "inStockOnly": false,
  "minPrice": 0,
  "maxPrice": 0,
  "minRating": "0",
  "includeMarketplace": true,
  "includeRatings": true,
  "fetchDetails": false,
  "fetchReviews": false,
  "maxReviewsPerProduct": 20,
  "reviewsSort": "latest",
  "includeRaw": false,
  "maxPagesPerSearch": 200,
  "proxyConfiguration": {
    "useApifyProxy": true,
    "apifyProxyGroups": [
      "RESIDENTIAL"
    ],
    "apifyProxyCountry": "AU"
  }
}
```

# 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 = {
    "searchTerms": [
        "milk"
    ],
    "proxyConfiguration": {
        "useApifyProxy": true,
        "apifyProxyGroups": [
            "RESIDENTIAL"
        ],
        "apifyProxyCountry": "AU"
    }
};

// Run the Actor and wait for it to finish
const run = await client.actor("neuro-scraper/woolworths-australia-products-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 = {
    "searchTerms": ["milk"],
    "proxyConfiguration": {
        "useApifyProxy": True,
        "apifyProxyGroups": ["RESIDENTIAL"],
        "apifyProxyCountry": "AU",
    },
}

# Run the Actor and wait for it to finish
run = client.actor("neuro-scraper/woolworths-australia-products-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 '{
  "searchTerms": [
    "milk"
  ],
  "proxyConfiguration": {
    "useApifyProxy": true,
    "apifyProxyGroups": [
      "RESIDENTIAL"
    ],
    "apifyProxyCountry": "AU"
  }
}' |
apify call neuro-scraper/woolworths-australia-products-scraper --silent --output-dataset

```

## MCP server setup

```json
{
    "mcpServers": {
        "apify": {
            "type": "http",
            "url": "https://mcp.apify.com/?tools=fetch-actor-details,neuro-scraper/woolworths-australia-products-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/DJKoQEsEDnsR0PHHg/builds/m501uqOa0PJVF22hM/openapi.json