{ "openapi": "3.0.1", "info": { "title": "Australian Grocery Prices: Coles & ALDI", "description": "Coles and ALDI Australia prices in one clean table: price, was-price, specials, unit price normalised to $/kg, $/L or each, category, image and link. Search, categories, specials or product URLs, with optional day-to-day price-change tracking. Woolworths in beta.", "version": "1.0", "x-build-id": "CxG9lenzhC0pNuW1l" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/fourteenerdevs~australian-grocery-prices/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-fourteenerdevs-australian-grocery-prices", "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/fourteenerdevs~australian-grocery-prices/runs": { "post": { "operationId": "runs-sync-fourteenerdevs-australian-grocery-prices", "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/fourteenerdevs~australian-grocery-prices/run-sync": { "post": { "operationId": "run-sync-fourteenerdevs-australian-grocery-prices", "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 look up at every selected supermarket, one per line (e.g. 'milk 2l', 'weet-bix', 'olive oil').", "items": { "type": "string" } }, "retailers": { "title": "Supermarkets", "type": "array", "description": "Which supermarkets to search and pull specials from. Start URLs always run on the supermarket they belong to. Woolworths is in beta: it blocks cloud servers, so it runs through an Australian residential proxy and is slower.", "items": { "type": "string", "enum": [ "coles", "aldi", "woolworths" ], "enumTitles": [ "Coles", "ALDI", "Woolworths (beta)" ] }, "default": [ "coles", "aldi" ] }, "startUrls": { "title": "Start URLs", "type": "array", "description": "Paste category, specials, search or product pages, e.g. https://www.coles.com.au/browse/dairy-eggs-fridge/milk, https://www.aldi.com.au/products/dairy-eggs-fridge/k/960000000, https://www.aldi.com.au/special-buys, or a single product page to track its price. You can also link a text file of URLs.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "scrapeSpecials": { "title": "Scrape all current specials", "type": "boolean", "description": "Collect the full specials lists: Coles specials and every announced ALDI Special Buys date (not yet available in the Woolworths beta). Set 'Max products per source' to 0 to get the complete lists.", "default": false }, "onlySpecials": { "title": "Only keep products on special", "type": "boolean", "description": "Drop products that are at their regular price. ALDI Special Buys count as specials.", "default": false }, "maxItemsPerSource": { "title": "Max products per source", "minimum": 0, "type": "integer", "description": "Upper limit for each search term, URL or specials list, per supermarket. 0 means no limit (a full Coles category can be thousands of products).", "default": 100 }, "maxItems": { "title": "Max products in total", "minimum": 0, "type": "integer", "description": "Stop the run after saving this many products. 0 means no limit. You can also cap the cost with the run's maximum charge.", "default": 0 }, "deduplicate": { "title": "Remove duplicates", "type": "boolean", "description": "Save each product once per supermarket even if several search terms or URLs find it. You only pay for saved products.", "default": true }, "trackPriceChanges": { "title": "Track price changes between runs", "type": "boolean", "description": "Remember each product's price in a storage on your account and add previousPrice, priceChange, priceChangePercent and isNewProduct to every result. Schedule the Actor daily to build a price history.", "default": false }, "onlyChanged": { "title": "Only save new products and price changes", "type": "boolean", "description": "Turns on tracking and saves only products whose price or special changed since the last run, plus products seen for the first time. The first run saves everything as a baseline; later runs are much cheaper.", "default": false }, "historyStoreName": { "title": "Price history storage name", "pattern": "^[a-z0-9-]{1,63}$", "type": "string", "description": "Named key-value store that holds the remembered prices. Use different names to keep separate watch lists apart. Lowercase letters, numbers and dashes only.", "default": "au-grocery-price-history" } } }, "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 } } } } } } } } } }