{ "openapi": "3.0.1", "info": { "title": "ALDI Australia Scraper - Prices & Special Buys", "description": "ALDI Australia scraper and API: every product with AUD price, unit price per kg or litre, brand and aisle, upcoming Special Buys with on-sale dates, New Low Price tags, and a price watch with price history. Search, aisles, links or the whole catalogue.", "version": "0.2", "x-build-id": "4cAm2twg5yLxTTYKj" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/acebuilds~aldi-au-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-acebuilds-aldi-au-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/acebuilds~aldi-au-scraper/runs": { "post": { "operationId": "runs-sync-acebuilds-aldi-au-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/acebuilds~aldi-au-scraper/run-sync": { "post": { "operationId": "run-sync-acebuilds-aldi-au-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 (e.g. milk, coffee, tim tam). ALDI matches each word on its own, so a single specific word gives the cleanest results.", "items": { "type": "string" } }, "categories": { "title": "📂 Aisles / categories", "type": "array", "description": "Whole aisles: a name (Pantry, Freezer, Dairy, Eggs & Fridge > Milk), a category key (970000000) or an aldi.com.au/products/… link. Collections work too: New Low Price, Super Savers, Limited Time Only, The People's Picks, Christmas.", "items": { "type": "string" } }, "productUrls": { "title": "🔗 Product links or SKUs", "type": "array", "description": "Specific products: aldi.com.au/product/… links or SKUs (e.g. 281811). These rows always include the label fields (description, ingredients, allergens) at no extra cost.", "items": { "type": "string" } }, "fullCatalogue": { "title": "🛒 Whole catalogue", "type": "boolean", "description": "Collect every product ALDI Australia lists (~3,300), including Special Buys general merchandise that has no aisle. Set Max products to 0 for no limit.", "default": false }, "specialBuys": { "title": "🏷️ Special Buys", "enum": [ "any", "only", "upcoming", "exclude" ], "type": "string", "description": "Keep everything, only Special Buys, only UPCOMING Special Buys (announced but not in store yet), or leave Special Buys out. With no search/aisle above, a Special Buys choice sweeps the whole catalogue for you.", "default": "any" }, "onSaleDate": { "title": "Special Buys date", "pattern": "^$|^\\d{4}-\\d{2}-\\d{2}$", "type": "string", "description": "Only the Special Buys going on sale on this date (YYYY-MM-DD), e.g. the next Wednesday or Saturday drop." }, "newLowPriceOnly": { "title": "Only 'New Low Price' products", "type": "boolean", "description": "Only products in ALDI's New Low Price collection (recent price drops). With nothing else filled in, reads that collection directly.", "default": false }, "minPrice": { "title": "Min price (AUD)", "minimum": 0, "type": "integer", "description": "Skip products cheaper than this. 0 = no minimum.", "default": 0 }, "maxPrice": { "title": "Max price (AUD)", "minimum": 0, "type": "integer", "description": "Skip products dearer than this. 0 = no maximum.", "default": 0 }, "sortBy": { "title": "Sort", "enum": [ "relevance", "name_asc", "name_desc", "price_asc", "price_desc" ], "type": "string", "description": "Order of products within each search or aisle.", "default": "relevance" }, "maxResults": { "title": "Max products (whole run)", "minimum": 0, "type": "integer", "description": "Total products to deliver across everything above — one budget for the run, not per search term. Products found twice are saved and charged once. 0 = no limit.", "default": 100 }, "includeDetails": { "title": "Add label data (add-on)", "type": "boolean", "description": "Fetch each product's page data: description, ingredients, 'Contains' / 'May contain' allergens, storage and usage instructions, variant SKUs. One extra request per product, charged as a small add-on.", "default": false }, "watchName": { "title": "🔔 Price watch name", "type": "string", "description": "Give the run a name (e.g. weekly-dairy) and schedule it. Every row gets changeType (new / priceDown / priceUp / specialChanged / unchanged), previousPrice and priceChange versus the last run with the same name. With Whole catalogue on and no filters, products ALDI removed come back as changeType 'removed'." }, "changesOnly": { "title": "Deliver only changes", "type": "boolean", "description": "With a watch name: skip products whose price and Special Buys date did not move (not charged). The first run of a watch delivers everything as 'new'.", "default": true }, "storeId": { "title": "Store (service point)", "type": "string", "description": "ALDI service point ID. Prices were identical across the stores we tested; the range differs by a few products. Leave the default unless you need one store's range.", "default": "G452" }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Not needed — ALDI serves this data to any visitor. Only set a proxy if your runs start failing.", "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 } } } } } } } } } }