{ "openapi": "3.0.1", "info": { "title": "Woolworths & Aldi Price Scraper and Comparison", "description": "Woolworths and Aldi Australia prices in one table: price, was-price, unit price, specials, multibuys, stock, barcode, nutrition and Special Buy dates. Search terms, category or product links. Optional: match the same product at both stores, with a confidence score. No login.", "version": "0.1", "x-build-id": "vhpSGZ592UNQhHsPf" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/sz022~woolworths-aldi-price-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-sz022-woolworths-aldi-price-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/sz022~woolworths-aldi-price-scraper/runs": { "post": { "operationId": "runs-sync-sz022-woolworths-aldi-price-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/sz022~woolworths-aldi-price-scraper/run-sync": { "post": { "operationId": "run-sync-sz022-woolworths-aldi-price-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": "Words you would type into the store's search box, one per line: \"cadbury dairy milk\", \"coca cola 2l\", \"nappies\". Each term is searched at every store selected below.", "items": { "type": "string" } }, "stores": { "title": "Stores to search", "enum": [ "both", "woolworths", "aldi" ], "type": "string", "description": "Which stores the search terms run against. Category and product links always go to the store they belong to. Coles is not supported.", "default": "both" }, "categoryUrls": { "title": "Category links", "type": "array", "description": "Category or specials pages copied from the browser, for example https://www.woolworths.com.au/shop/browse/dairy-eggs-fridge/milk, https://www.woolworths.com.au/shop/browse/specials/half-price or https://www.aldi.com.au/products/dairy-eggs-fridge/milk/k/1111111160.", "items": { "type": "string" } }, "productUrls": { "title": "Product links or codes", "type": "array", "description": "Product pages (https://www.woolworths.com.au/shop/productdetails/44528/..., https://www.aldi.com.au/product/...-000000000000398691), a Woolworths stockcode (44528) or an 18-digit Aldi SKU. One request each, and the product page's details are included at no extra charge.", "items": { "type": "string" } }, "maxProductsPerInput": { "title": "Max products per search term or category", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Per store: \"milk\" with both stores selected returns up to this many from Woolworths and this many from Aldi, in the store's own relevance order.", "default": 50 }, "specialsOnly": { "title": "Specials only", "type": "boolean", "description": "Woolworths: only products on special (half price, multibuy, price drops, other specials). Aldi shows no was-prices, so here it means products in Aldi's own Lower Prices, Super Savers and Limited Time Only groups.", "default": false }, "includeAldiSpecialBuys": { "title": "Add Aldi Special Buys", "type": "boolean", "description": "Also list Aldi's current and upcoming Special Buys (the weekly Wednesday and Saturday ranges), with each one's on-sale date. Charged as ordinary products.", "default": false }, "maxSpecialBuys": { "title": "Max Special Buys", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Upper limit on Special Buys rows when the option above is on.", "default": 200 }, "includeDetails": { "title": "Include product page details", "type": "boolean", "description": "One extra request per product. Woolworths: nutrition per serve and per 100 g with serving size, country of origin with the % of Australian ingredients, aisle, all images. Aldi: description, ingredients, allergens, storage and usage notes. Charged as product-details on top of the product. Search rows already carry Woolworths ingredients, allergens, Health Star Rating and the nutrition values without this.", "default": false }, "compareStores": { "title": "Compare the same product at both stores", "type": "boolean", "description": "After reading, pair products sold at both Woolworths and Aldi (same brand, same pack size, similar name) and add one comparison row per pair: cheapest store, price difference, unit-price difference and the match confidence. Needs products from both stores in the run. Charged per comparison row.", "default": false }, "matchThreshold": { "title": "Minimum match confidence", "type": "string", "description": "Comparison rows are only written for pairs at or above this confidence (0.6 to 1). Brand and pack size must always agree; the score then reflects how similar the rest of the name is. 0.85 is strict enough that pairs read as the same product; lower it to see looser pairs.", "default": "0.85" }, "abortAfterConsecutiveFailures": { "title": "Stop after this many failed inputs in a row", "minimum": 0, "type": "integer", "description": "Ends the run early when a store stops answering. Inputs with no results or that do not exist do not count. 0 never stops early.", "default": 3 }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Apify's datacenter proxy, which read both stores in every test. Residential and Google SERP groups are not used: the price is set for datacenter traffic, so a run that asks for them falls back to datacenter. Proxy URLs of your own are used as given.", "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 }, "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 } } } } } } } } } }