{ "openapi": "3.0.1", "info": { "title": "Australia Supermarket Price Scraper: Coles, Woolworths, Aldi", "description": "Prices for Coles, Woolworths and Aldi Australia in one schema: price, was-price, unit price, promotion, EAN where published, store ID, scrapedAt. Use it to compare a product across the three shops or read Aldi Special Buys. Not for NZ or other shops. Pay per product returned plus $0.005 a run.", "version": "0.1", "x-build-id": "wZcsVY9730gk09phc" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/yappman~au-supermarket-price-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-yappman-au-supermarket-price-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/yappman~au-supermarket-price-scraper/runs": { "post": { "operationId": "runs-sync-yappman-au-supermarket-price-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/yappman~au-supermarket-price-scraper/run-sync": { "post": { "operationId": "run-sync-yappman-au-supermarket-price-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": { "retailers": { "title": "Retailers", "type": "array", "description": "Which shops to search. Exact values: coles, woolworths, aldi_au. All three by default. Search mode only; other modes ignore it. Example: [\"coles\", \"woolworths\"] searches Coles and Woolworths only.", "items": { "type": "string", "enum": [ "coles", "woolworths", "aldi_au" ], "enumTitles": [ "Coles", "Woolworths", "Aldi Australia" ] }, "default": [ "coles", "woolworths", "aldi_au" ] }, "mode": { "title": "Mode", "enum": [ "search", "category", "product", "specialBuys" ], "type": "string", "description": "What to run, one mode per run: search (keywords in queries), category (pages in categoryUrls), product (pages in productUrls) or specialBuys (Aldi's dated Special Buys drops). Example: \"search\" with queries [\"full cream milk\"].", "default": "search" }, "queries": { "title": "Search queries", "maxItems": 50, "type": "array", "description": "Keywords to search for in every selected shop, up to 50 (search mode only).", "items": { "type": "string", "maxLength": 200 }, "default": [ "milk" ] }, "categoryUrls": { "title": "Category URLs", "maxItems": 50, "type": "array", "description": "Category page URLs such as https://www.coles.com.au/browse/dairy-eggs-fridge/milk, from coles.com.au, woolworths.com.au or aldi.com.au, up to 50 (category mode only; leave empty unless the user supplied URLs).", "items": { "type": "string", "maxLength": 2048 }, "default": [] }, "productUrls": { "title": "Product URLs", "maxItems": 500, "type": "array", "description": "Product page URLs such as https://www.coles.com.au/product/coles-full-cream-milk-3l-8150288, from coles.com.au, woolworths.com.au or aldi.com.au, up to 500 (product mode only; leave empty unless the user supplied URLs).", "items": { "type": "string", "maxLength": 2048 }, "default": [] }, "maxItems": { "title": "Max items", "minimum": 1, "type": "integer", "description": "The most rows to save in total, 1 or more, split evenly between the shops in the run (every mode; a Special Buys drop is typically 30 to 100 products).", "default": 60 }, "excludeMarketplace": { "title": "Exclude Woolworths marketplace products", "type": "boolean", "description": "Leave out Woolworths Everyday Market (third-party) products (Woolworths only, search and category modes; off by default).", "default": false }, "colesProductDetails": { "title": "Coles: look up barcodes (EAN)", "type": "boolean", "description": "Add each Coles product's barcode (EAN), at one extra request per product in search and category modes (Coles only; product mode always has it; off by default).", "default": false }, "specialBuysDrops": { "title": "Special Buys drop dates", "maxItems": 20, "type": "array", "description": "Aldi Special Buys drop dates as YYYY-MM-DD, up to 20 (specialBuys mode only; empty means today's and later drops, Sydney date).", "items": { "type": "string", "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}$", "maxLength": 10 }, "default": [] } } }, "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 } } } } } } } } } }