{ "openapi": "3.0.1", "info": { "title": "Coles vs Woolworths vs ALDI Price Comparison & API", "description": "Compare grocery prices at Coles, Woolworths and ALDI Australia: give a shopping list, get the cheapest supermarket for each item per kg / L / each, the same product at each chain and a basket total. Prices and stock of your nearest Coles. Price change alerts.", "version": "0.1", "x-build-id": "iUKO0BOUKqgthHu2f" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/s_actors~coles-woolworths-aldi-price-comparison/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-s_actors-coles-woolworths-aldi-price-comparison", "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/s_actors~coles-woolworths-aldi-price-comparison/runs": { "post": { "operationId": "runs-sync-s_actors-coles-woolworths-aldi-price-comparison", "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/s_actors~coles-woolworths-aldi-price-comparison/run-sync": { "post": { "operationId": "run-sync-s_actors-coles-woolworths-aldi-price-comparison", "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": { "items": { "title": "🛒 Shopping list", "type": "array", "description": "One item per line, as you would search a supermarket site: \"milk\", \"full cream milk 2l\", \"tim tam\", \"free range eggs\", \"bananas\", \"nappies size 4\". A size in the item (\"2l\", \"200g\", \"24 pack\") keeps only products of that size. Each item is searched at every chosen chain.", "items": { "type": "string" } }, "chains": { "title": "🏬 Supermarkets", "type": "array", "description": "Which chains to compare. All three by default.", "items": { "type": "string", "enum": [ "coles", "woolworths", "aldi" ], "enumTitles": [ "Coles", "Woolworths", "ALDI" ] }, "default": [ "coles", "woolworths", "aldi" ] }, "output": { "title": "📋 Output", "enum": [ "comparison", "products" ], "type": "string", "description": "Comparison = one row per shopping-list item: each chain's cheapest matching product per kg / L / each, the cheapest chain, the price gap, the identical product at each chain, plus a basket total per chain (BASKET record). Products = every matching product of every chain as a row, with a comparable price per kg / L / each.", "default": "comparison" }, "postcode": { "title": "📍 Postcode or suburb (Coles store)", "type": "string", "description": "Optional, e.g. 2000 or \"Bondi Junction\": Coles prices, specials and stock count of the nearest Coles store. Empty = Coles online prices. Woolworths and ALDI prices are the same nationally online." }, "maxProductsPerChain": { "title": "🔢 Products checked per item and chain", "minimum": 1, "maximum": 200, "type": "integer", "description": "How many search results of each chain are checked for each item (most relevant first). More = a better chance of finding the cheapest pack, a bit slower.", "default": 36 }, "onlyChanges": { "title": "🔔 Only report changes", "type": "boolean", "description": "For scheduled comparison runs. The first run saves prices; later runs return an item only when a chain's price changed or another chain became the cheapest. You pay only for the rows returned.", "default": false }, "monitorName": { "title": "🏷️ Monitor name", "type": "string", "description": "Separate monitors keep separate memory. Use a different name for each scheduled task.", "default": "default" }, "maxConcurrency": { "title": "⚡ Parallel requests", "minimum": 1, "maximum": 8, "type": "integer", "description": "How many requests run at the same time.", "default": 4 } } }, "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 } } } } } } } } } }