{ "openapi": "3.0.1", "info": { "title": "Coles Australia Scraper - Prices, Specials, Nutrition & Stock", "description": "Use this to get Coles Australia (coles.com.au) grocery prices. Input: search keywords, category slugs, specials list or URLs. One result = one product: name, brand, size, price, was price, unit price, special type, stock, category, URL; optional barcode and nutrition. $1.50 per 1,000 results.", "version": "1.0", "x-build-id": "PxC2bY4Jldeoqms6Y" }, "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": "Optional. List of keywords typed into the Coles search box, e.g. [\"milk\", \"tim tam\"]. A barcode (EAN/GTIN, e.g. \"9300617064923\") also works. Each keyword returns up to maxItems products. Give at least one of searchQueries, categories, specials or startUrls.", "items": { "type": "string" } }, "categories": { "title": "Categories", "type": "array", "description": "Optional. List of Coles category slugs or browse URLs, e.g. [\"dairy-eggs-fridge\", \"pantry/breakfast\", \"https://www.coles.com.au/browse/bakery\"]. \"all\" = whole catalogue (~35,000 products). One department is ~1,000-4,000 products.", "items": { "type": "string" } }, "specials": { "title": "Specials catalogue", "enum": [ "none", "all", "halfprice", "multibuy", "onlineonly" ], "type": "string", "description": "Optional. Weekly specials list to scrape. One of: \"none\" (default, skip), \"all\" (every special, usually 6,000-8,000), \"halfprice\", \"multibuy\", \"onlineonly\". New specials start each Wednesday.", "default": "none" }, "startUrls": { "title": "Coles URLs", "type": "array", "description": "Optional. List of coles.com.au URLs as objects, e.g. [{\"url\": \"https://www.coles.com.au/on-special?filter_Special=halfprice\"}]. Accepts search, /browse/ category, /on-special, brand and /product/ pages; URL filters are kept.", "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": "Optional. Maximum products per keyword, category, specials list or URL, integer >= 0. Default 100; 0 = everything. Two keywords with 100 = up to 200 results. You pay per product, so use 10-20 for a quick answer.", "default": 100 }, "includeDetails": { "title": "Include barcode, ingredients & nutrition (slower)", "type": "boolean", "description": "Optional boolean. true = open each product page to add barcode (GTIN), ingredients, allergens, dietary info, nutrition panel, country of origin and all images; runs take about twice as long. Default false (prices only).", "default": false }, "storeId": { "title": "Store ID", "type": "string", "description": "Optional. Coles store number for that store's prices and stock, e.g. \"7799\", or a store page URL like \"https://www.coles.com.au/find-stores/coles/vic/ardeer-7799\". Omit for the default online store." }, "includeSponsored": { "title": "Include sponsored products", "type": "boolean", "description": "Optional boolean. true = include paid product ads, flagged isSponsored: true. Default false (organic results only).", "default": false }, "maxConcurrency": { "title": "Max concurrency", "minimum": 1, "maximum": 25, "type": "integer", "description": "Optional, advanced. Number of parallel requests, integer 1-25. Default 5. Leave unset unless the run is very large.", "default": 5 }, "maxRequestRetries": { "title": "Max retries per request", "minimum": 0, "maximum": 20, "type": "integer", "description": "Optional, advanced. Retries per failed or blocked request, integer 0-20; each retry uses a new proxy session. Default 8. Leave unset.", "default": 8 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Optional, advanced. Apify Proxy settings object. Default {\"useApifyProxy\": true, \"apifyProxyGroups\": [\"RESIDENTIAL\"], \"apifyProxyCountry\": \"AU\"}, which Coles requires (datacenter IPs are blocked). Leave unset.", "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 } } } } } } } } } }