{ "openapi": "3.0.1", "info": { "title": "Coles Scraper", "description": "Scrape ALDI and Coles Australia grocery products by keyword, category, specials, Special Buys, product link or number: price, was price, unit price, half-price and multi-buy specials, stock, category, images, barcode, ingredients, allergens and nutrition.", "version": "0.1", "x-build-id": "Lg8I4SQRQgXQdmuFq" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/automly~aldi-coles-australia-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-automly-aldi-coles-australia-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/automly~aldi-coles-australia-scraper/runs": { "post": { "operationId": "runs-sync-automly-aldi-coles-australia-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/automly~aldi-coles-australia-scraper/run-sync": { "post": { "operationId": "run-sync-automly-aldi-coles-australia-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 to search for, like milk, tim tam or gluten free bread. Each term is searched at the shops you pick below.", "items": { "type": "string" } }, "store": { "title": "Shops to search", "enum": [ "both", "aldi", "coles" ], "type": "string", "description": "Which shops the search terms are searched at. Links always go to their own shop.", "default": "both" }, "startUrls": { "title": "Links and product numbers", "type": "array", "description": "Paste aldi.com.au or coles.com.au links, one per line: ALDI categories (https://www.aldi.com.au/products/dairy-eggs-fridge/k/960000000), ALDI Special Buys (https://www.aldi.com.au/special-buys/2026-10-07, or https://www.aldi.com.au/special-buys for every upcoming date), ALDI deals such as Super Savers (https://www.aldi.com.au/products/super-savers/k/1588161426952145), Coles categories (https://www.coles.com.au/browse/dairy-eggs-fridge/milk), Coles specials (https://www.coles.com.au/on-special, or with ?filter_Special=halfprice), search pages and product pages of either shop. You can also enter a product number on its own: a Coles one like 8150288, or an ALDI one like 000000000538441002.", "items": { "type": "string" } }, "maxResults": { "title": "Max products", "minimum": 0, "type": "integer", "description": "The most products this run saves, across all search terms and links together. 0 saves every product listed.", "default": 100 }, "sortBy": { "title": "Sort by", "enum": [ "relevance", "priceLowToHigh", "priceHighToLow", "name" ], "type": "string", "description": "The order products are listed in, which decides which ones come first when you set a maximum. Coles has no name order and lists by relevance instead. A link that carries its own order keeps it.", "default": "relevance" }, "specialsOnly": { "title": "Search: specials only", "type": "boolean", "description": "Keep only products on special in search results: Coles specials, and ALDI Special Buys, Super Savers, Limited Time Only and Lower Prices products.", "default": false }, "includeDetails": { "title": "Include product page details", "type": "boolean", "description": "Add what only the product page shows: barcode, ingredients, allergens, nutrition panel, serving size, storage and country of origin (Coles), and description, ingredients, allergens and storage (ALDI).", "default": false }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "The default works for most runs. If results come back empty, try a different proxy option.", "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 } } } } } } } } } }