{ "openapi": "3.0.1", "info": { "title": "Coles Scraper – Prices, Specials, Barcodes & Full Catalogue", "description": "Scrape Coles (coles.com.au): search, categories, the weekly specials catalogue or the full catalogue. Price, was price, half-price & multi-buy offers, unit price, stock, category; optional barcode (GTIN), ingredients, nutrition and country of origin.", "version": "0.1", "x-build-id": "ynFpoo0uUEHkWbBd1" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/rt-solutions~coles-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-rt-solutions-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/rt-solutions~coles-scraper/runs": { "post": { "operationId": "runs-sync-rt-solutions-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/rt-solutions~coles-scraper/run-sync": { "post": { "operationId": "run-sync-rt-solutions-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": "What to scrape", "enum": [ "search", "categories", "specials", "full_catalogue" ], "type": "string", "description": "Choose one mode.", "default": "search" }, "keywords": { "title": "Keywords", "type": "array", "description": "For 'Search by keyword', e.g. milk, coffee pods, nappies.", "items": { "type": "string" } }, "categories": { "title": "Categories", "type": "array", "description": "For 'Categories'.", "items": { "type": "string", "enum": [ "meat-seafood", "fruit-vegetables", "dairy-eggs-fridge", "bakery", "deli", "pantry", "chips-chocolates-snacks", "international-foods", "health-dietary", "drinks", "liquorland", "frozen", "cleaning-laundry", "health-beauty", "baby", "pet", "home-garden", "back-to-school", "big-pack-value" ], "enumTitles": [ "Meat & Seafood", "Fruit & Vegetables", "Dairy, Eggs & Fridge", "Bakery", "Deli", "Pantry", "Chips, Chocolates & Snacks", "International Foods", "Health & Dietary", "Drinks", "Liquorland", "Frozen", "Cleaning & Laundry", "Health & Beauty", "Baby", "Pet", "Home & Garden", "Back to School", "Big Pack Value" ] } }, "categoryUrls": { "title": "Or sub-category URLs", "type": "array", "description": "For 'Categories': any Coles category page, e.g. https://www.coles.com.au/browse/dairy-eggs-fridge/milk", "items": { "type": "string" } }, "specialsOnly": { "title": "Specials only", "type": "boolean", "description": "Keep only products on special (works with every mode).", "default": false }, "includeDetails": { "title": "Include product details", "type": "boolean", "description": "Opens each product page: barcode (GTIN), country of origin, ingredients, allergens, nutrition, dimensions, full description, all images. Extra charge per product.", "default": false }, "maxResults": { "title": "Max products per keyword / category", "minimum": 1, "maximum": 50000, "type": "integer", "description": "Stop after this many products for each keyword or category.", "default": 200 }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Australian residential proxy is used by default (Coles blocks most datacenter IPs).", "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 } } } } } } } } } }