{ "openapi": "3.0.1", "info": { "title": "Woolworths Australia Scraper", "description": "Scrape Woolworths Australia grocery products by category, search term or stock code: price, was-price, specials, unit price, brand, size, images, ratings, ingredients and nutrition.", "version": "0.1", "x-build-id": "kN8xCAXnljN68VLSf" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/tortuga~woolworths-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-tortuga-woolworths-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~woolworths-scraper/runs": { "post": { "operationId": "runs-sync-tortuga-woolworths-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~woolworths-scraper/run-sync": { "post": { "operationId": "run-sync-tortuga-woolworths-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 Woolworths browse pages (Category URLs), `search` runs search terms, `product` fetches individual products by URL or stock code (always with full details).", "default": "category" }, "categoryUrls": { "title": "Category URLs", "type": "array", "description": "Woolworths browse URLs, one per line: a department (https://www.woolworths.com.au/shop/browse/fruit-veg), an aisle (.../shop/browse/dairy-eggs-fridge/milk), a sub-aisle (.../fruit-veg/fruit/apples-pears) or a specials page (.../shop/browse/specials/half-price). Every page of the category is followed automatically (36 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.woolworths.com.au/shop/productdetails/888141/woolworths-lite-milk. Used when Mode is `product`.", "items": { "type": "string" } }, "stockcodes": { "title": "Stock codes", "type": "array", "description": "Woolworths stock codes (the number in the product URL), e.g. `888141`. 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's detail endpoint to add the full nutrition table (per serve and per 100 g, serving size), country-of-origin label with Australian-ingredient percentage, storage instructions, directions, product warnings and variants. Listing items already carry description, ingredients, allergens, dietary claims and per-100 g nutrition without this. Charged extra per product (see pricing).", "default": false }, "onlySpecials": { "title": "Only specials", "type": "boolean", "description": "Keep only products that are on special: a price cut (`isOnSpecial`), a half-price deal or a promotion such as `2 for $6`. The server-side specials filter is applied first, so fewer pages are fetched.", "default": false }, "includeSponsored": { "title": "Include sponsored tiles", "type": "boolean", "description": "Listing pages carry 4-8 sponsored product tiles that repeat across pages and may 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": [ "TraderRelevance", "PriceAsc", "PriceDesc", "CUPAsc", "CUPDesc", "Name", "NameDesc", "Specials", "AvailableDateDesc" ], "type": "string", "description": "Order in which Woolworths returns products (matters when Max items cuts a category short).", "default": "TraderRelevance" }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Apify Proxy is recommended. Datacenter proxies worked in testing; switch to residential (Australia) if runs report HTTP/2 stream resets or 403s.", "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 } } } } } } } } } }