{ "openapi": "3.0.1", "info": { "title": "Coles Australia Scraper - Prices, Specials, Nutrition & Stock", "description": "Coles supermarket product data: price, was price, unit price, half-price and multibuy specials, stock, category, barcode, ingredients, allergens and nutrition. Search, categories, specials or product URLs. HTTP-only, fast and cheap.", "version": "1.0", "x-build-id": "INbrfsClfZ5jk5pDd" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/rel8ble~coles-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-rel8ble-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/rel8ble~coles-scraper/runs": { "post": { "operationId": "runs-sync-rel8ble-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/rel8ble~coles-scraper/run-sync": { "post": { "operationId": "run-sync-rel8ble-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": { "searchQueries": { "title": "Search keywords", "type": "array", "description": "Keywords typed into the Coles search box, one per line, e.g. \"milk\", \"tim tam\", \"shampoo\". A barcode (EAN/GTIN like 9300617064923) also works. Each keyword is scraped separately, up to \"Max products per source\".", "items": { "type": "string" } }, "categories": { "title": "Categories", "type": "array", "description": "Coles category slugs or browse URLs, e.g. \"dairy-eggs-fridge\", \"pantry/breakfast\", \"meat-seafood\" or \"https://www.coles.com.au/browse/bakery\". Use \"all\" for the whole online catalogue (every department, about 35,000 products, deduplicated). One department is roughly 1,000-4,000 products.", "items": { "type": "string" } }, "specials": { "title": "Specials catalogue", "enum": [ "none", "all", "halfprice", "multibuy", "onlineonly" ], "type": "string", "description": "Scrape the Coles weekly specials catalogue (new specials start each Wednesday). \"All specials\" is every product on special, usually 6,000-8,000; or pick half price, multibuy or online-only specials.", "default": "none" }, "startUrls": { "title": "Coles URLs", "type": "array", "description": "Any coles.com.au search, category (/browse/...), specials (/on-special), brand or product (/product/...) URL. Filters in the URL are kept. Example: https://www.coles.com.au/on-special?filter_Special=halfprice", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "maxItems": { "title": "Max products per source", "minimum": 0, "type": "integer", "description": "Stop each keyword, category, specials list or URL after this many unique products. 0 = everything Coles lists. Example: 100 with two keywords returns up to 200 products.", "default": 100 }, "includeDetails": { "title": "Include barcode, ingredients & nutrition (slower)", "type": "boolean", "description": "Opens each product page to add the barcode (GTIN), ingredients, allergens, dietary info, nutrition panel, country of origin and all images. One extra request per product, so runs take about twice as long. Leave off if you only need prices.", "default": false }, "storeId": { "title": "Store ID", "type": "string", "description": "Optional Coles store number for that store's prices, stock and shelf location, e.g. 7799, or paste a store page URL like https://www.coles.com.au/find-stores/coles/vic/ardeer-7799. Leave empty for Coles' default online store." }, "includeSponsored": { "title": "Include sponsored products", "type": "boolean", "description": "Coles puts paid product ads at the top of search and specials pages. Off = organic results only. When on, sponsored rows are flagged isSponsored: true.", "default": false }, "maxConcurrency": { "title": "Max concurrency", "minimum": 1, "maximum": 25, "type": "integer", "description": "How many requests run in parallel (1-25). The default of 5 is fast and gentle; raise it for very large catalogue runs.", "default": 5 }, "maxRequestRetries": { "title": "Max retries per request", "minimum": 0, "maximum": 20, "type": "integer", "description": "How many times a failed page is retried (0-20). Blocked requests are retried on a fresh proxy session with a new IP.", "default": 8 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Coles sits behind Imperva bot protection. Australian residential proxies (the default) get through reliably; datacenter proxies are often blocked. Blocked requests are retried on a fresh session automatically. Leave as is unless you have a reason to change it.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ], "apifyProxyCountry": "AU" } } } }, "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 } } } } } } } } } }