{
"openapi": "3.0.1",
"info": {
"title": "Coles, Woolworths & ALDI Scraper – Australian Grocery Prices",
"description": "Coles, Woolworths and ALDI Australia in one run, same fields for all three: price, was-price, specials, multi-buy, unit price, category, barcode, image, URL. Search products, whole departments, every special or any store URL. Checked 30/30 against product pages. $1 per 1,000 products.",
"version": "1.0",
"x-build-id": "aXh5FDUOoTSeEbLkA"
},
"servers": [
{
"url": "https://api.apify.com/v2"
}
],
"paths": {
"/acts/brii3343~coles-woolworths-aldi-scraper/run-sync-get-dataset-items": {
"post": {
"operationId": "run-sync-get-dataset-items-brii3343-coles-woolworths-aldi-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/brii3343~coles-woolworths-aldi-scraper/runs": {
"post": {
"operationId": "runs-sync-brii3343-coles-woolworths-aldi-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/brii3343~coles-woolworths-aldi-scraper/run-sync": {
"post": {
"operationId": "run-sync-brii3343-coles-woolworths-aldi-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": "Products to search for, one per line, for example milk, coffee beans, nappies. Each term is searched in every store you select, so you can compare prices across Coles, Woolworths and ALDI in one run.",
"items": {
"type": "string"
}
},
"stores": {
"title": "Stores",
"type": "array",
"description": "Which supermarkets to search. Leave empty for all three.",
"items": {
"type": "string",
"enum": [
"coles",
"woolworths",
"aldi"
],
"enumTitles": [
"Coles",
"Woolworths",
"ALDI"
]
},
"default": [
"coles",
"woolworths",
"aldi"
]
},
"categories": {
"title": "Categories",
"type": "array",
"description": "Whole departments, with the same name for all three stores (each store's matching department is used). ALDI has no International foods, Lunchbox or Home & garden department.",
"items": {
"type": "string",
"enum": [
"fruit-vegetables",
"meat-seafood",
"dairy-eggs-fridge",
"bakery",
"deli",
"pantry",
"snacks-confectionery",
"drinks",
"frozen",
"liquor",
"health-beauty",
"baby",
"pet",
"cleaning-household",
"international-foods",
"lunchbox",
"home-garden"
],
"enumTitles": [
"Fruit & vegetables",
"Meat & seafood",
"Dairy, eggs & fridge",
"Bakery",
"Deli",
"Pantry",
"Snacks & confectionery",
"Drinks",
"Frozen",
"Liquor",
"Health & beauty",
"Baby",
"Pet",
"Cleaning & household",
"International foods",
"Lunchbox",
"Home & garden"
]
},
"default": []
},
"allCategories": {
"title": "Whole catalogue",
"type": "boolean",
"description": "Every product of the selected stores (tens of thousands). With Specials only on, every product on special. The per-source limit does not apply; use Max products in total to cap it.",
"default": false
},
"startUrls": {
"title": "Start URLs",
"type": "array",
"description": "Any Coles, Woolworths or ALDI page with products: a search, a category, the specials page or a single product, for example https://www.coles.com.au/browse/pantry, https://www.woolworths.com.au/shop/browse/specials/half-price, https://www.aldi.com.au/products/freezer/k/980000000.",
"default": [],
"items": {
"type": "object",
"required": [
"url"
],
"properties": {
"url": {
"type": "string",
"title": "URL of a web page",
"format": "uri"
}
}
}
},
"specialsOnly": {
"title": "Specials only",
"type": "boolean",
"description": "Keep only products on special (price drops, half price, multi-buy offers).",
"default": false
},
"includeMarketplace": {
"title": "Include Woolworths Everyday Market",
"type": "boolean",
"description": "Everyday Market products are sold on woolworths.com.au by third-party sellers (fashion, homewares, electronics…). Off by default so that results are groceries; turn it on to include them.",
"default": false
},
"maxItemsPerSource": {
"title": "Max products per source",
"minimum": 0,
"type": "integer",
"description": "Limit for each search term in each store, each category in each store and each start URL. 0 = everything the store lists.",
"default": 100
},
"maxItems": {
"title": "Max products in total",
"minimum": 0,
"type": "integer",
"description": "Stop after this many products in the whole run. 0 = no limit.",
"default": 0
},
"proxyConfiguration": {
"title": "Proxy",
"type": "object",
"description": "Not needed: the scraper connects directly and switches to Apify Proxy (Australian residential if necessary) only when a store blocks it. Set a proxy here only to force one.",
"default": {
"useApifyProxy": false
}
}
}
},
"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
}
}
}
}
}
}
}
}
}
}