{ "openapi": "3.0.1", "info": { "title": "Woolworths, Aldi & IGA Scraper: Australian Grocery Prices", "description": "Woolworths, Aldi and IGA (store by store) grocery prices in one run: shelf and was price, half-price and multibuy specials, member prices, Super Savers, unit prices, barcodes and stock. Search by product name, give category or product URLs, read whole catalogues, or get specials only.", "version": "0.0", "x-build-id": "dVVCDr3jtRpeMg3EI" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/alduinxx~woolworths-aldi-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-alduinxx-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/alduinxx~woolworths-aldi-scraper/runs": { "post": { "operationId": "runs-sync-alduinxx-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/alduinxx~woolworths-aldi-scraper/run-sync": { "post": { "operationId": "run-sync-alduinxx-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": { "chains": { "title": "Supermarkets", "type": "array", "description": "Which supermarkets to read. Search terms and the whole-catalogue mode apply to these; category and product URLs are read from their own site whatever is chosen here.", "items": { "type": "string", "enum": [ "Woolworths", "Aldi", "IGA" ] }, "default": [ "Woolworths", "Aldi" ] }, "searchTerms": { "title": "Search terms", "type": "array", "description": "Words to find in product names, e.g. \"milk\", \"peanut butter\", \"nappies\". Every word must appear; closest names come first. Leave empty, with no categories or products, to read each whole catalogue.", "default": [], "items": { "type": "string" } }, "resultsPerTerm": { "title": "Results per search term", "minimum": 0, "maximum": 1000, "type": "integer", "description": "The most rows for each search term at each supermarket (and each IGA store), closest first. 1 gives the best match for every term: use it to price a shopping list at all three. Empty or 0: no limit." }, "categoryUrls": { "title": "Category URLs", "type": "array", "description": "Category pages, e.g. https://www.woolworths.com.au/shop/browse/fruit-veg, https://www.aldi.com.au/products/pantry/k/970000000 or https://www.igashop.com.au/categories/dairy-eggs-and-fridge/milk-and-cream. Woolworths' specials pages (…/shop/browse/specials/half-price) work too.", "default": [], "items": { "type": "string" } }, "productUrls": { "title": "Product URLs", "type": "array", "description": "Product pages from any of the three sites, e.g. https://www.woolworths.com.au/shop/productdetails/888140/woolworths-full-cream-milk or https://www.igashop.com.au/product/a2-milk-full-cream-milk-726347. IGA products are read at each chosen IGA store.", "default": [], "items": { "type": "string" } }, "specialsOnly": { "title": "Specials only", "type": "boolean", "description": "Only products on special: price cuts, half price, multibuys, Woolworths member prices, Aldi Super Savers, IGA specials. With no search terms or URLs, this reads each Woolworths department's specials, Aldi's catalogue and each IGA store's specials list.", "default": false }, "igaStores": { "title": "IGA stores", "type": "array", "description": "Which IGA stores to read: every IGA is independently owned and sets its own prices. Give a postcode (the store there, or the nearest one), a suburb (\"Erskine Park NSW\") or a store number. Empty: the IGA Shop's default store, Ashcroft's IGA Erskine Park (NSW 2759). Up to 20 stores; each counts as one supermarket below.", "default": [], "items": { "type": "string" } }, "maxResults": { "title": "Maximum results", "minimum": 1, "maximum": 500000, "type": "integer", "description": "Rows to return in total, one per product (per store for IGA). Shared evenly between the supermarkets; one that runs out passes its share on.", "default": 100 }, "maxConcurrency": { "title": "Max concurrency", "minimum": 1, "maximum": 50, "type": "integer", "description": "Requests at the same time. The default suits most runs.", "default": 10 } } }, "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 } } } } } } } } } }