{ "openapi": "3.0.1", "info": { "title": "Woolworths Australia Scraper - Prices, Specials & Price History", "description": "Woolworths AU prices, unit prices and specials with price history nobody else keeps: previous price, 30-day low, 90-day average and a real-discount check. Barcodes, nutrition, allergens, in-store availability, directory of ~1,140 stores, full catalogue. Nightly cache, so runs don't fail.", "version": "0.0", "x-build-id": "75tbmgwQOv3AbWVRD" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/crawlplant~woolworths-au/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-crawlplant-woolworths-au", "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/crawlplant~woolworths-au/runs": { "post": { "operationId": "runs-sync-crawlplant-woolworths-au", "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/crawlplant~woolworths-au/run-sync": { "post": { "operationId": "run-sync-crawlplant-woolworths-au", "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": [ "search", "category", "specials", "products", "urls", "categories", "catalog" ], "type": "string", "description": "What to fetch: keyword search, a category listing, current specials, products by stockcode, any Woolworths URLs, the list of departments / categories / specials groups, or the full catalogue from our nightly snapshot (fast; set Max items high, filters apply).", "default": "search" }, "queries": { "title": "Search queries", "type": "array", "description": "Used in 'search' mode. Each query is searched separately.", "default": [ "milk" ], "items": { "type": "string" } }, "categoryUrls": { "title": "Category URLs", "type": "array", "description": "Used in 'category' mode, e.g. https://www.woolworths.com.au/shop/browse/dairy-eggs-fridge/milk. Tip: run mode 'List categories' to get every category URL.", "default": [], "items": { "type": "string" } }, "productIds": { "title": "Stockcodes", "type": "array", "description": "Used in 'products' mode: the number in a product URL, e.g. 88436.", "default": [], "items": { "type": "string" } }, "urls": { "title": "Woolworths URLs", "type": "array", "description": "Used in 'urls' mode: paste any product, search, category or specials page URL (or a bare stockcode). Each is fetched the right way automatically.", "default": [], "items": { "type": "string" } }, "specialsGroups": { "title": "Specials groups", "type": "array", "description": "Used in 'specials' mode. Empty = all groups, promotions first. Values: half-price, buy-more-save-more, lower-shelf-price, seasonal-price, bundles, everyday-low-price.", "default": [], "items": { "type": "string" } }, "maxItems": { "title": "Max items", "minimum": 1, "type": "integer", "description": "Maximum products per query / category / URL (after filters). For specials, products and the full catalogue: per run (the catalogue has ~25-30k products).", "default": 100 }, "sortBy": { "title": "Sort by", "enum": [ "relevance", "price_asc", "price_desc", "unit_price_asc", "name", "specials_first" ], "type": "string", "description": "Result order, applied by Woolworths before paging. Price sorts skip products that are unavailable online (no price).", "default": "relevance" }, "specialsOnly": { "title": "Only products on special", "type": "boolean", "description": "Keep only products currently on special / half price.", "default": false }, "inStockOnly": { "title": "Only products in stock", "type": "boolean", "description": "Skip products currently unavailable online.", "default": false }, "minPrice": { "title": "Minimum price (AUD)", "minimum": 0, "type": "number", "description": "Keep only products priced at or above this amount." }, "maxPrice": { "title": "Maximum price (AUD)", "minimum": 0, "type": "number", "description": "Keep only products priced at or below this amount." }, "minRating": { "title": "Minimum customer rating", "minimum": 0, "maximum": 5, "type": "number", "description": "Keep only products with an average customer rating of at least this many stars (0-5). Products without ratings are skipped." }, "includeMarketplace": { "title": "Include Everyday Market (third-party sellers)", "type": "boolean", "description": "Also return products sold by third-party Everyday Market sellers (furniture, electronics, ...). Off = products sold by Woolworths only.", "default": false }, "excludeCategories": { "title": "Exclude departments", "type": "array", "description": "Departments to leave out, by name or URL slug, e.g. 'beer-wine-spirits' or 'Pet'.", "default": [], "items": { "type": "string" } }, "dietary": { "title": "Dietary requirements", "type": "array", "description": "Keep only products tagged with ALL of these, e.g. Gluten Free, Vegan, Vegetarian, Halal, Dairy Free, Low Sugar.", "default": [], "items": { "type": "string" } }, "excludeAllergens": { "title": "Exclude allergens", "type": "array", "description": "Skip products that contain or may contain any of these, e.g. Peanuts, Tree Nuts, Milk, Gluten. Products without allergen data are skipped too.", "default": [], "items": { "type": "string" } }, "minHealthStarRating": { "title": "Minimum Health Star Rating", "minimum": 0, "maximum": 5, "type": "number", "description": "Keep only products rated at least this many health stars (0.5-5)." }, "maxSugarPer100g": { "title": "Max sugar per 100 g/mL (g)", "minimum": 0, "type": "number", "description": "Keep only products with at most this much sugar per 100 g/mL. Products without nutrition data are skipped." }, "minProteinPer100g": { "title": "Min protein per 100 g/mL (g)", "minimum": 0, "type": "number", "description": "Keep only products with at least this much protein per 100 g/mL." }, "changedSince": { "title": "Only price changes since", "type": "string", "description": "Return only products whose price changed since this date/time (e.g. 2026-09-01), or 'last-run' for changes since your previous run with the same input. Uses our shared daily price history." }, "priceHistoryDays": { "title": "Include price history (days)", "minimum": 0, "maximum": 3650, "type": "integer", "description": "Add each product's price changes from the last N days (0 = off). Every result always includes previousPrice and priceChangedAt when known.", "default": 0 }, "onlyNew": { "title": "Only new products", "type": "boolean", "description": "Only products that appeared at Woolworths in the last 7 days.", "default": false }, "onlyNewSpecials": { "title": "Only new specials", "type": "boolean", "description": "Only products that went on special in the last 7 days (specials change every Wednesday).", "default": false }, "fetchFullDetails": { "title": "Fetch full product details", "type": "boolean", "description": "Adds the printed nutrition panel (per serving and per 100 g/mL), country of origin and all product images. Needs one extra request per product, so it is slower, and it is charged as a separate event per product. Description, ingredients, allergens, health star rating and dietary tags are always included for free.", "default": false }, "maxAgeHours": { "title": "Max data age (hours)", "minimum": 0, "type": "integer", "description": "Serve cached data younger than this. 0 = always fetch live.", "default": 12 }, "includeRaw": { "title": "Include raw payload", "type": "boolean", "description": "Add the original Woolworths payload to each record (every attribute, including ones we don't map).", "default": false } } }, "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 } } } } } } } } } }