{ "openapi": "3.0.1", "info": { "title": "Woolworths Australia Scraper: Products, Prices & Specials", "description": "Scrape Woolworths Australia (woolworths.com.au) products by search term, category or specials page (half price, multibuy) or product URL: price, was-price, special flag, unit price, availability, barcode, and optional product details (ingredients, nutrition, images). Pay per product.", "version": "0.1", "x-build-id": "SXEeOx38mD06YyC68" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/atalaia~woolworths-au/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-atalaia-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/atalaia~woolworths-au/runs": { "post": { "operationId": "runs-sync-atalaia-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/atalaia~woolworths-au/run-sync": { "post": { "operationId": "run-sync-atalaia-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": { "searchQueries": { "title": "Search terms", "type": "array", "description": "Text searches, exactly as you would type them on woolworths.com.au (for example milk, tim tam, a2 milk 2l). Each term returns up to \"Max items per search or category\" products.", "items": { "type": "string" } }, "categoryUrls": { "title": "Category or specials URLs", "type": "array", "description": "Listing pages from woolworths.com.au: aisles (https://www.woolworths.com.au/shop/browse/fruit-veg), specials pages (https://www.woolworths.com.au/shop/browse/specials/half-price) or search-result URLs. All pages are followed up to the item cap.", "items": { "type": "string" } }, "productUrls": { "title": "Product URLs or IDs", "type": "array", "description": "Product pages (https://www.woolworths.com.au/shop/productdetails/44528/...) or bare numeric product IDs (stockcodes). Each one returns the full product with details.", "items": { "type": "string" } }, "maxItemsPerQuery": { "title": "Max items per search or category", "minimum": 1, "maximum": 2000, "type": "integer", "description": "Maximum number of products returned for each search term or category URL (36 products per page are read until this cap or the end of the listing).", "default": 100 }, "includeDetails": { "title": "Include product details", "type": "boolean", "description": "Also open each listed product's page to add description, ingredients, nutrition, allergens, country of origin and up to 10 images. Charged as an extra product-detail event per product and makes runs slower.", "default": false }, "onlySpecials": { "title": "Only specials", "type": "boolean", "description": "Keep only products that are really discounted: on special (with a was-price) or on a multibuy offer such as \"2 for $5\". Badges like \"Lower shelf price\" or \"Everyday low price\" alone don't count.", "default": false }, "postcode": { "title": "Postcode (optional)", "pattern": "^\\s*(\\d{4})?\\s*$", "type": "string", "description": "4-digit Australian postcode (for example 3000). Prices, specials and availability are then read for the nearest Woolworths store to that postcode instead of the default online store. This opens each product's page (charged as product details, like \"Include product details\") because Woolworths only gives store prices there. Leave empty for the default online store. An unknown postcode stops the run with an error." }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Apify datacenter proxy is used by default and is enough for Woolworths.", "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 }, "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 } } } } } } } } } }