{ "openapi": "3.0.1", "info": { "title": "Coles Scraper — Prices, Specials, Barcodes & Nutrition", "description": "Coles.com.au scraper: export the whole Coles catalogue (~25,000 products), any category, search or specials page with prices, was prices, half-price & multibuy specials, unit prices, barcodes (GTIN), ingredients, allergens and nutrition. Store prices by postcode. No login. Not affiliated with Coles.", "version": "1.0", "x-build-id": "hPoHfeTWlsVs9QKKm" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/logiover~coles-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-logiover-coles-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/logiover~coles-scraper/runs": { "post": { "operationId": "runs-sync-logiover-coles-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/logiover~coles-scraper/run-sync": { "post": { "operationId": "run-sync-logiover-coles-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": "Keywords to search on coles.com.au, e.g. \"milk\", \"coffee pods\", \"Coles brand pasta\". Each term is one search. Leave every scope field empty to export the whole Coles catalogue.", "default": [], "items": { "type": "string" } }, "categories": { "title": "Categories", "type": "array", "description": "Departments or categories: a coles.com.au URL (https://www.coles.com.au/browse/dairy-eggs-fridge/cheese), a path (pantry/coffee) or a name (\"Pantry\", \"Frozen\"). The list of departments is read live from the site.", "default": [], "items": { "type": "string" } }, "startUrls": { "title": "Coles URLs", "type": "array", "description": "Optional. Paste coles.com.au pages: category pages (/browse/...), specials pages (/on-special, /on-special/, ?filter_Special=halfprice), /half-price-specials, search pages (/search/products?q=...) or product pages (/product/...).", "default": [], "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "productIds": { "title": "Product IDs or URLs", "type": "array", "description": "Optional. Coles product IDs (the number at the end of a product URL, e.g. 8150288) or product URLs — ideal for daily price monitoring of a fixed list.", "default": [], "items": { "type": "string" } }, "onlySpecials": { "title": "Only specials", "enum": [ "no", "any", "halfPrice", "multibuy", "onlineOnly" ], "type": "string", "description": "Keep only products on special, using Coles' own specials filter: any special, half price, multibuy (\"Any 2 for $X\") or online-only specials. Works with every scope above, including the whole catalogue.", "default": "no" }, "storeId": { "title": "Store number (optional)", "type": "string", "description": "Price everything at one Coles supermarket, e.g. 481 (Coles Central Raine Square, Perth). Prices and range differ between stores and states. Leave empty for the default online prices coles.com.au shows before a store is chosen.", "default": "" }, "postcode": { "title": "Postcode (optional)", "type": "string", "description": "Instead of a store number: an Australian postcode (e.g. 6000 or 2000). The nearest Coles supermarket that publishes online prices is used. Ignored when a store number is given.", "default": "" }, "includeNutrition": { "title": "Include ingredients, allergens & nutrition", "type": "boolean", "description": "Adds the long description, ingredients, allergen and dietary statements, the nutrition panel (per 100 g and per serving, as numbers), country of origin with the % of Australian ingredients, dimensions and storage / usage instructions. Read in the same request as the price — no extra cost, ~2x the data.", "default": true }, "maxItems": { "title": "Max results", "minimum": 0, "maximum": 1000000, "type": "integer", "description": "Stop after this many unique products across all searches and categories. 0 = no limit (the whole catalogue is ~25,000 products).", "default": 1000 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Coles refuses direct connections from cloud servers, so requests go through Apify Proxy (datacenter, included in the price). Each connection keeps its own session and is replaced at once if Coles refuses it.", "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 } } } } } } } } } }