{ "openapi": "3.0.1", "info": { "title": "Coles Australia Scraper - Prices, Specials, Barcodes $1/1K", "description": "Scrape Coles supermarket (Australia): shelf price, was-price, specials, unit price, availability, aisle. Search, aisles, specials page, links, per-store prices, barcode, ingredients, nutrition. No login. $1 per 1,000 products, no start fee.", "version": "0.1", "x-build-id": "GRle8ffrG79NdMywX" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/om_kh~coles-australia-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-om_kh-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/om_kh~coles-australia-scraper/runs": { "post": { "operationId": "runs-sync-om_kh-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/om_kh~coles-australia-scraper/run-sync": { "post": { "operationId": "run-sync-om_kh-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 words", "type": "array", "description": "What you would type in the Coles search box, one per line (milk, vegemite, dog food...).", "items": { "type": "string" } }, "categories": { "title": "Aisles (optional)", "type": "array", "description": "Aisle paths or links, for example dairy-eggs-fridge/milk or https://www.coles.com.au/browse/pantry. Switch on 'List all aisles' below to see every path.", "items": { "type": "string" } }, "urls": { "title": "Coles links or product numbers (optional)", "type": "array", "description": "Paste any coles.com.au link: a product, a search, an aisle or the specials page. A bare product number (8150288) also works.", "items": { "type": "string" } }, "productIds": { "title": "Product numbers (optional)", "type": "array", "description": "Coles product numbers, one per line. Each returns the full product page: price plus barcode, ingredients and nutrition.", "items": { "type": "string" } }, "specials": { "title": "Specials", "enum": [ "none", "all", "halfprice", "multibuy", "onlineonly" ], "type": "string", "description": "'none' returns normal listings. 'all' returns only products on special; half price, multi-buy and online-only narrow it. Used alone it reads the whole specials page (about 7,000 products).", "default": "none" }, "wholeCatalogue": { "title": "Read the whole catalogue", "type": "boolean", "description": "Reads every main aisle (about 30,000 products). Set 'Max products per input' high (up to 100,000) and a spending limit you accept.", "default": false }, "listCategories": { "title": "List all aisles", "type": "boolean", "description": "Also returns the full aisle tree (about 1,500 aisles with their paths and product counts). These rows are free.", "default": false }, "maxProductsPerInput": { "title": "Max products per input", "minimum": 1, "maximum": 100000, "type": "integer", "description": "Per search, aisle or link. 1 to 100,000. Coles shows at most 4,800 products per search; the whole-catalogue and big specials jobs are split by aisle for you.", "default": 100 }, "storeId": { "title": "Coles store number (optional)", "type": "string", "description": "Prices and specials of one store. The number is at the end of the store page link on coles.com.au (find-stores/coles/nsw/bondi-junction-7731 gives 7731). Empty = Coles default prices." }, "sortBy": { "title": "Sort", "enum": [ "relevance", "priceAscending", "priceDescending", "unitPriceAscending" ], "type": "string", "description": "Order of the results inside each search or aisle.", "default": "relevance" }, "brands": { "title": "Brands (optional)", "type": "array", "description": "Keep only these brands, for example Cadbury. A brand Coles does not offer for that list is reported together with the brands it does offer.", "items": { "type": "string" } }, "dietary": { "title": "Dietary (optional)", "type": "array", "description": "For example Vegan, Vegetarian, Halal, GMO Free.", "items": { "type": "string" } }, "allergens": { "title": "Free from (optional)", "type": "array", "description": "For example Gluten Free, Dairy Free, Egg Free.", "items": { "type": "string" } }, "minPrice": { "title": "Minimum price (AUD)", "type": "number", "description": "Keep products at or above this shelf price." }, "maxPrice": { "title": "Maximum price (AUD)", "type": "number", "description": "Keep products at or below this shelf price." }, "minDiscountPercent": { "title": "Minimum discount (%)", "type": "number", "description": "Keep only products at least this much below their was-price (50 = half price or better)." }, "inStockOnly": { "title": "In stock only", "type": "boolean", "description": "Skip products Coles marks as unavailable.", "default": false }, "includeSponsored": { "title": "Include sponsored placements", "type": "boolean", "description": "Coles mixes paid placements into search results. Switch off to skip them (they are flagged isSponsored either way).", "default": true }, "includeDetails": { "title": "Add barcode, ingredients, allergens, nutrition", "type": "boolean", "description": "Opens every product page for its barcode (EAN), ingredients, allergens, dietary tags, storage, country of origin, dimensions and the full nutrition table. Slower, and sold as its own event: $0.003 per product instead of $0.001.", "default": false }, "maxTotalChargeUsd": { "title": "Maximum spend (USD)", "minimum": 0, "type": "number", "description": "The run stops before it would spend more than this. The first 10 products of each run are free and do not count.", "default": 1 } } }, "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 } } } } } } } } } }