Name: Australian Supermarket Prices API: Coles, Woolworths, ALDI
Brand: highbrow_fame
SKU: api-highbrow_fame-australian-supermarket-prices
Availability: InStock
Author: API Market

Janos Scher

# Australian Supermarket Prices API

## Overview

The Australian Supermarket Prices API returns live product prices, specials and unit prices from Coles, Woolworths, ALDI, IGA and Harris Farm Markets in Australia, and from Woolworths in New Zealand. A search returns each product's name, brand, size, price, previous price, special type and savings, multibuy offers, unit price, availability, department, category, image and product link. IGA and Harris Farm set prices per store, so you can choose an IGA store by number or postcode and a Harris Farm store by name.

It is built for developers of price comparison sites, grocery budgeting apps, specials alerts, retail analytics and research on food prices in Australia and New Zealand. In our tests a search for 2 litre milk at Coles, bread at Woolworths, eggs at ALDI, milk at an IGA in Erskine Park, apples at Harris Farm Broadway and milk at Woolworths New Zealand all returned current prices with unit prices. Most searches took 5 to 9 seconds, and Harris Farm took about 30 seconds.

## Features

*   **4 endpoints**: store lists and product search for Australia and New Zealand.
*   **6 stores**: Coles, Woolworths, ALDI, IGA and Harris Farm Markets in Australia, Woolworths in New Zealand.
*   **Specials**: `isOnSpecial`, previous price, savings and multibuy offers, with an `onlySpecials` filter.
*   **Unit prices**: price per litre, kilo or unit for fair comparison.
*   **Per store prices**: IGA by store number or postcode and Harris Farm by store name.
*   **Rate limit**: up to 10 requests per second on every plan.

## Use Cases

*   **Price comparison**: compare the same product across supermarkets.
*   **Budgeting apps**: build a shopping list with live prices.
*   **Specials alerts**: notify shoppers when a product goes on special.
*   **Retail analytics**: track prices and promotions by category.
*   **Research**: study grocery inflation in Australia and New Zealand.

## API Documentation

### Base URL

All requests use the following base URL.

```
https://prod.api.market/api/v1/highbrow_fame/australian-supermarket-prices
```

### Authentication

All requests are authenticated with the `x-api-market-key` header.

```
x-api-market-key: YOUR_API_KEY
```

Replace `YOUR_API_KEY` with your actual API key.

### Endpoints

#### 1. List Australian stores

Returns the supported Australian stores and the filters each one accepts.

**Method:** `GET`

**Endpoint:** `/grocery-au/sites`

**Parameters:**

None.

**Example Request:**

```bash
curl -X GET 'https://prod.api.market/api/v1/highbrow_fame/australian-supermarket-prices/grocery-au/sites' \
  -H 'x-api-market-key: YOUR_API_KEY'
```

**Example Response (200 OK):**

```json
{
  "api": "grocery-au",
  "sites": [
    {
      "site": "woolworths-au",
      "title": "Woolworths Australia Scraper — Products, Prices & Specials",
      "generic": [
        "keywords",
        "limit",
        "searchUrls",
        "onlySpecials"
      ]
    },
    {
      "site": "coles-au",
      "title": "Coles Australia Scraper — Store Prices, Products & Specials",
      "generic": [
        "keywords",
        "limit",
        "details",
        "searchUrls",
        "onlySpecials"
      ]
    },
    {
      "site": "aldi-au",
      "title": "ALDI Australia Scraper — Products, Prices & Special Buys",
      "generic": [
        "keywords",
        "limit",
        "details",
        "searchUrls",
        "onlySpecials"
      ]
    },
    {
      "site": "harris-farm-au",
      "title": "Harris Farm Markets Australia — Prices & Specials by Store",
      "generic": [
        "keywords",
        "location",
        "limit",
        "onlySpecials"
      ]
    },
    {
      "site": "iga-au",
      "title": "IGA Australia — Prices & Specials by Store",
      "generic": [
        "keywords",
        "limit",
        "onlySpecials",
        "storeId",
        "postcode"
      ]
    },
    {
      "site": "woolworths-nz",
      "title": "Woolworths New Zealand Scraper — Products, Prices & Specials",
      "generic": [
        "keywords",
        "limit",
        "onlySpecials"
      ]
    }
  ]
}
```

The response above lists each store with its main filters. The full response also describes every store specific field.

#### 2. Search Australian products

Returns products and prices from one Australian store.

**Method:** `GET`

**Endpoint:** `/grocery-au/search`

**Parameters:**

| Name | In | Description | Type | Required | Default | Max Value |
|---|---|---|---|---|---|---|
| `store` | query | `coles`, `woolworths`, `aldi`, `iga` or `harris-farm` | string | Yes | - | - |
| `query` | query | Product search, for example `milk 2l` | string | No | - | - |
| `limit` | query | Maximum number of products | integer | No | `20` | 50 |
| `onlySpecials` | query | Return only products on special | boolean | No | - | - |
| `searchUrl` | query | Instead of `query`: a category, specials or product link of the store (not for IGA or Harris Farm) | string | No | - | - |
| `storeId` | query | IGA only: the IGA store number, for example `32600` | string | No | - | - |
| `postcode` | query | IGA only: a 4 digit postcode, which picks the IGA store with that or the nearest postcode | string | No | - | - |
| `location` | query | Harris Farm only: store name or number, for example `Broadway` | string | No | - | - |

**Example Request:**

```bash
curl -X GET 'https://prod.api.market/api/v1/highbrow_fame/australian-supermarket-prices/grocery-au/search?store=coles&query=milk%202l&limit=3' \
  -H 'x-api-market-key: YOUR_API_KEY'
```

**Example Response (200 OK):**

```json
{
  "site": "coles",
  "count": 3,
  "results": [
    {
      "input": "milk 2l",
      "inputType": "search",
      "position": 1,
      "productId": 439693,
      "name": "Coles Full Cream Milk",
      "brand": "Coles",
      "size": "2L",
      "price": 3.4,
      "wasPrice": 3.4,
      "isOnSpecial": false,
      "specialType": null,
      "promotion": null,
      "savings": 0,
      "savePercent": null,
      "multiBuy": null,
      "isOnlineOnlySpecial": false,
      "unitPrice": 1.7,
      "unitMeasure": "1l",
      "unitPriceText": "$1.70 / 1L",
      "isAvailable": true,
      "availabilityType": "InStoreAndOnline",
      "purchaseLimit": 20,
      "promotionalLimit": 12,
      "department": "Dairy, Eggs & Fridge",
      "category": "Milk",
      "aisle": "Full Cream Milk",
      "sponsored": false,
      "image": "https://productimages.coles.com.au/productimages/4/439693.jpg",
      "url": "https://www.coles.com.au/product/coles-full-cream-milk-2l-439693",
      "status": "OK",
      "scrapedAt": "2026-11-12T15:41:48.600Z"
    }
  ],
  "problems": [],
  "notes": [],
  "tookMs": 6757
}
```

The `results` list above is shortened to one of three products. An IGA search with `postcode=2759` also returns the store it used:

```json
{
  "site": "iga",
  "store": {
    "id": "32600",
    "name": "Ashcroft's IGA Erskine Park",
    "postcode": "2759",
    "state": "NSW"
  },
  "count": 3,
  "results": [
    {
      "input": "milk",
      "inputType": "search",
      "storeId": "32600",
      "storeName": "Ashcroft's IGA Erskine Park",
      "storePostcode": "2759",
      "position": 1,
      "stockcode": "726347",
      "sku": "726347",
      "name": "A2 Milk Full Cream Milk",
      "brand": "A2 Milk",
      "packageSize": "3 l",
      "price": 10.5,
      "wasPrice": null,
      "isOnSpecial": false,
      "isHalfPrice": false,
      "savings": 0,
      "promotion": null,
      "promoStartDate": null,
      "promoEndDate": null,
      "unitPrice": 3.5,
      "unitMeasure": "l",
      "unitPriceText": "$3.50/l",
      "isAvailable": true,
      "barcode": null,
      "department": "Dairy, Eggs and Fridge",
      "category": "Grocery/Dairy, Eggs and Fridge/Milk and Cream/Full Cream",
      "image": "https://cdn.metcash.media/image/upload/w_1500,h_1500,c_pad,b_auto/igashop/images/726347.jpg",
      "url": "https://www.igashop.com.au/product/a2-milk-full-cream-milk-726347",
      "store": "iga-au",
      "currency": "AUD",
      "status": "OK",
      "scrapedAt": "2026-11-12T15:42:19.792Z"
    }
  ],
  "problems": [],
  "notes": [],
  "tookMs": 6104
}
```

#### 3. List New Zealand stores

Returns the supported New Zealand stores and their filters.

**Method:** `GET`

**Endpoint:** `/grocery-nz/sites`

**Parameters:**

None.

**Example Request:**

```bash
curl -X GET 'https://prod.api.market/api/v1/highbrow_fame/australian-supermarket-prices/grocery-nz/sites' \
  -H 'x-api-market-key: YOUR_API_KEY'
```

**Example Response (200 OK):**

```json
{
  "api": "grocery-nz",
  "sites": [
    {
      "site": "woolworths-nz",
      "title": "Woolworths New Zealand Scraper — Products, Prices & Specials",
      "generic": [
        "keywords",
        "limit",
        "onlySpecials"
      ]
    }
  ]
}
```

#### 4. Search New Zealand products

Returns products and prices from Woolworths New Zealand.

**Method:** `GET`

**Endpoint:** `/grocery-nz/search`

**Parameters:**

| Name | In | Description | Type | Required | Default | Max Value |
|---|---|---|---|---|---|---|
| `store` | query | `woolworths-nz` | string | Yes | - | - |
| `query` | query | Product search, for example `milk` | string | No | - | - |
| `limit` | query | Maximum number of products | integer | No | `20` | 50 |
| `onlySpecials` | query | Return only products on special | boolean | No | - | - |

**Example Request:**

```bash
curl -X GET 'https://prod.api.market/api/v1/highbrow_fame/australian-supermarket-prices/grocery-nz/search?store=woolworths-nz&query=milk&limit=3' \
  -H 'x-api-market-key: YOUR_API_KEY'
```

**Example Response (200 OK):**

```json
{
  "site": "woolworths-nz",
  "count": 3,
  "results": [
    {
      "input": "milk",
      "inputType": "search",
      "position": 1,
      "stockcode": "6038845",
      "sku": "6038845",
      "name": "anchor lactose free milk blue",
      "brand": "anchor",
      "packageSize": "2L",
      "price": 8.09,
      "wasPrice": null,
      "isOnSpecial": false,
      "isHalfPrice": false,
      "savings": 0,
      "promotion": null,
      "isClubPrice": false,
      "promoStartDate": null,
      "promoEndDate": null,
      "unitPrice": 4.05,
      "unitMeasure": "1L",
      "unitPriceText": "$4.05 / 1L",
      "instorePrice": null,
      "isAvailable": true,
      "isInStock": true,
      "stockLevel": 3,
      "availabilityStatus": "In Stock",
      "barcode": "94153835",
      "department": "Fridge & Deli",
      "category": "Fridge & Deli",
      "image": "https://assets.woolworths.com.au/images/2010/6038845.jpg?impolicy=wowcdxwbjbx&w=200&h=200",
      "url": "https://www.woolworths.co.nz/shop/productdetails?stockcode=6038845&name=anchor-lactose-free-milk-blue",
      "store": "woolworths-nz",
      "currency": "NZD",
      "status": "OK",
      "scrapedAt": "2026-11-12T15:43:07.723Z"
    }
  ],
  "problems": [],
  "notes": [],
  "tookMs": 1614
}
```

The `results` list above is shortened to one of three products.

## Status Codes

| Code | Status | Description |
|---|---|---|
| 200 | OK | The request succeeded and the JSON result is in the response body. |
| 400 | Bad Request | A required parameter is missing or a value is not valid, for example an unknown `store`. |
| 401 | Unauthorized | The `x-api-market-key` header is missing or the key is not valid. |
| 403 | Forbidden | Your key does not have an active subscription that includes this endpoint. |
| 404 | Not Found | The path does not match an endpoint of this API. Check the Base URL and path. |
| 429 | Too Many Requests | You went over 10 requests per second or used up the calls of your plan. |
| 500 | Internal Server Error | The request failed on the server. Retry once, then contact us if it continues. |
| 503 | Service Unavailable | The service is temporarily unavailable. Retry after a short wait. |

## Rate Limits

Every plan allows up to 10 requests per second. The free Basic plan includes 50 calls, Pro includes 1,000 calls per month for $9.99, Ultra 5,000 for $29.99 and Mega 25,000 for $99.99. When you go over a limit, the API returns `429 Too Many Requests`. Throttle your requests, back off before retrying, and honour the `Retry-After` header when it is present.

## FAQ

*   **Why do IGA and Harris Farm need a store?**
    Both set prices per store. Choose an IGA store with `storeId` or `postcode`, and a Harris Farm store with `location`. Without one, a default store is used and shown in the response.

*   **How long does a search take?**
    Most searches take 5 to 9 seconds. Harris Farm can take about 30 seconds, so set your client timeout to at least 60 seconds.

*   **Can I search a category instead of a keyword?**
    Yes. For Coles, Woolworths and ALDI pass a category or specials link of the store in `searchUrl`.

*   **Is every call billed?**
    Yes. Each successful call counts as one call of your plan, however many products it returns.

## Contact Us

If you have any questions or need support, reach out through the chat embedded on this page or email us at hello@magicapi.com.


Live grocery prices, specials and unit prices from Coles, Woolworths, ALDI, IGA and Harris Farm in Australia, plus Woolworths New Zealand.

Australian Supermarket Prices API: Coles, Woolworths, ALDI

Basic