{ "openapi": "3.0.1", "info": { "title": "Coles Australia Scraper", "description": "Scrape Coles Australia grocery products by category, search term or product URL: price, was-price, specials, multibuys, unit price, brand, size, images, nutrition.", "version": "0.1", "x-build-id": "0EL4rPgibOAJ2G33e" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/tortuga~coles-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-tortuga-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/tortuga~coles-scraper/runs": { "post": { "operationId": "runs-sync-tortuga-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/tortuga~coles-scraper/run-sync": { "post": { "operationId": "run-sync-tortuga-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": { "mode": { "title": "Mode", "enum": [ "category", "search", "product" ], "type": "string", "description": "What to scrape: `category` walks Coles listing pages (Category URLs), `search` runs search terms, `product` fetches individual products by URL or product ID (always with full details).", "default": "category" }, "categoryUrls": { "title": "Category URLs", "type": "array", "description": "Coles listing URLs, one per line: a department (https://www.coles.com.au/browse/fruit-vegetables), a category (.../browse/dairy-eggs-fridge/milk), specials (https://www.coles.com.au/on-special, .../on-special?filter_Special=halfprice) or Down Down (.../browse/down-down). Filters and sort already in the URL are kept. Every page is followed automatically (48 products per page). Used when Mode is `category`.", "items": { "type": "string" } }, "searchTerms": { "title": "Search terms", "type": "array", "description": "Search queries such as `almond milk` or `dishwasher tablets`. Each term is paginated like the website search. Used when Mode is `search`.", "items": { "type": "string" } }, "productUrls": { "title": "Product URLs", "type": "array", "description": "Product page URLs like https://www.coles.com.au/product/coles-full-cream-milk-3l-8150288. Used when Mode is `product`.", "items": { "type": "string" } }, "productIds": { "title": "Product IDs", "type": "array", "description": "Coles product IDs (the number at the end of the product URL), e.g. `8150288`. Used when Mode is `product`, together with or instead of Product URLs.", "items": { "type": "string" } }, "maxItems": { "title": "Max items", "minimum": 1, "type": "integer", "description": "Stop after this many products in total (across all categories / search terms). Keeps cost predictable.", "default": 200 }, "includeDetails": { "title": "Include product details", "type": "boolean", "description": "Also open every product page to add the long description, ingredients, nutrition table, allergens, dietary claims, country of origin, storage instructions and all gallery images. One extra request per product, charged extra (see pricing).", "default": false }, "onlySpecials": { "title": "Only specials", "type": "boolean", "description": "Keep only products on special: price cuts (`wasPrice`), half price, multibuys such as `Buy 2 for $6` and other Coles specials. The site's own specials filter is applied first, so fewer pages are fetched.", "default": false }, "includeSponsored": { "title": "Include sponsored tiles", "type": "boolean", "description": "Listing pages occasionally carry ad or cross-sell tiles that belong to other aisles. Off by default so the dataset matches the category's real product list; switch on to keep them (flagged with `isSponsored: true`).", "default": false }, "sort": { "title": "Sort order", "enum": [ "relevance", "priceAscending", "priceDescending", "productNameAscending", "productNameDescending", "recentlyAdded", "promotion" ], "type": "string", "description": "Order in which Coles returns products (matters when Max items cuts a category short).", "default": "relevance" }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Coles' bot protection blocks datacenter IPs, so residential Apify Proxy in Australia is the default. Proxy usage is billed to your account.", "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 } } }, "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 } } } } } } } } } }