{ "openapi": "3.0.1", "info": { "title": "Coles Australia Scraper: Products, Prices, Specials & Stock", "description": "Scrape product data, live prices, discounts, weekly specials, and stock levels from Coles Australia (coles.com.au). Search by keyword, walk category and specials URLs, or look up specific SKUs. Get brand, pack size, aisle location, purchase limits, and store-specific pricing by Coles store ID.", "version": "0.2", "x-build-id": "HiDC2IYnSfz4l2e1D" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/getascraper~coles-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-getascraper-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/getascraper~coles-scraper/runs": { "post": { "operationId": "runs-sync-getascraper-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/getascraper~coles-scraper/run-sync": { "post": { "operationId": "run-sync-getascraper-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", "required": [ "scrapeMode" ], "properties": { "scrapeMode": { "title": "Scraping Mode", "enum": [ "searchKeyword", "providedUrls", "skuList" ], "type": "string", "description": "Choose whether to search by keyword, browse category URLs, or input a custom SKU list.", "default": "searchKeyword" }, "searchQuery": { "title": "Search Keyword", "type": "string", "description": "The search keyword, product name, or barcode/EAN to query (e.g., 'milk', '9300601385150'). Only used in Keyword Search mode.", "default": "milk" }, "startUrls": { "title": "Category / Browse URLs", "type": "array", "description": "Paste Coles search, category, or weekly Specials URLs (e.g., 'https://www.coles.com.au/specials/half-price') to scrape directly.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "skuList": { "title": "Direct SKU List", "type": "array", "description": "Input specific Coles product SKU IDs to scrape their specifications directly. Only used in Direct SKU List mode." }, "includeDescription": { "title": "Include Product Description", "type": "boolean", "description": "Extract full text product descriptions for each item when found.", "default": true }, "maxItems": { "title": "Max Items to Scrape", "minimum": 1, "type": "integer", "description": "Maximum number of product listings to extract. Runs stop synchronously when this cap is reached.", "default": 25 }, "maxRequestsPerCrawl": { "title": "Max Requests limit", "minimum": 0, "type": "integer", "description": "Maximum number of page requests/paginations that can be made by this crawler (0 = unlimited).", "default": 100 }, "monitorMode": { "title": "Monitor mode", "enum": [ "snapshot", "changes" ], "type": "string", "description": "Snapshot returns the current data every run. Changes compares each run against the last run of the same Watchlist name and adds change_type (NEW, PRICE_DROP, PRICE_RISE, BACK_IN_STOCK, OUT_OF_STOCK, UNCHANGED) plus the prior price to every row.", "default": "snapshot" }, "stateName": { "title": "Watchlist name", "type": "string", "description": "Distinguishes separate change-tracking scopes (e.g. different searches on a schedule). Only used when Monitor mode is Changes.", "default": "default" }, "onlyChanged": { "title": "Only output changed rows", "type": "boolean", "description": "When Monitor mode is Changes, emit only rows whose price or stock changed since the last run (skips UNCHANGED rows). The first run always emits every row as NEW.", "default": false }, "proxyConfiguration": { "title": "Proxy Configuration", "type": "object", "description": "Datacenter proxies are the validated default for Coles product pages. Switch to an Australian residential proxy only if a high-volume run is challenged.", "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 } } }, "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 } } } } } } } } } }