{ "openapi": "3.0.1", "info": { "title": "Woolworths Scraper: Prices, Specials & Nutrition", "description": "Scrape Woolworths Australia (woolworths.com.au) by search term, category, specials page or stockcode. Get price, was price, specials, multibuy offers, unit price, stock, barcode, nutrition, allergens, ingredients, Health Star Rating and departments. No browser; $0.50 per 1,000 products.", "version": "0.2", "x-build-id": "kGPx7SzhdVnxY6CyK" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/fabricalabs~woolworths-au-products/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-fabricalabs-woolworths-au-products", "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/fabricalabs~woolworths-au-products/runs": { "post": { "operationId": "runs-sync-fabricalabs-woolworths-au-products", "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/fabricalabs~woolworths-au-products/run-sync": { "post": { "operationId": "run-sync-fabricalabs-woolworths-au-products", "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": { "searchTerms": { "title": "Search terms", "type": "array", "description": "Product searches, typed as you would on woolworths.com.au, e.g. milk, coffee beans, chicken breast. Each term is paged through separately and its products keep their position in the results.", "items": { "type": "string" } }, "categoryUrls": { "title": "Category and specials pages", "type": "array", "description": "Woolworths category pages, e.g. https://www.woolworths.com.au/shop/browse/dairy-eggs-fridge/milk, or specials pages such as .../shop/browse/specials/half-price. Open the page on the site and paste its address; .../shop/browse/specials collects every kind of special. A product in several categories is delivered once.", "items": { "type": "string" } }, "productIds": { "title": "Products (stockcodes or links)", "type": "array", "description": "Woolworths stockcodes (e.g. 888140) or product page links, to track the price of specific products. They are looked up 30 at a time, so long lists are fast. Stockcodes Woolworths doesn't sell are reported as free rows.", "items": { "type": "string" } }, "sortBy": { "title": "Sort by", "enum": [ "relevance", "priceLowToHigh", "priceHighToLow", "unitPriceLowToHigh", "name" ], "type": "string", "description": "Order of the products within each search term or category, as Woolworths sorts them.", "default": "relevance" }, "specialsOnly": { "title": "Specials only", "type": "boolean", "description": "Only products on special right now, in searches and categories.", "default": false }, "includeMarketplace": { "title": "Include Everyday Market products", "type": "boolean", "description": "Everyday Market products are sold by third-party sellers, not Woolworths. Searches and categories leave them out by default, because some categories hold tens of thousands of them. Products you ask for by stockcode are always delivered.", "default": false }, "maxResults": { "title": "Maximum products (whole run)", "minimum": 0, "maximum": 1000000, "type": "integer", "description": "Stop after this many products in total, across all inputs. 0 means no limit. It caps what a run can cost: 1,000 products cost $0.50.", "default": 1000 }, "maxResultsPerTerm": { "title": "Maximum products per search term or category", "minimum": 0, "maximum": 1000000, "type": "integer", "description": "Stop each search term or category after this many products. 0 means no limit per input (the whole-run maximum still applies).", "default": 0 }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Apify datacenter proxy is the cheapest option and works well with Woolworths. Switch to residential only if your runs get refused.", "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 } } } } } } } } } }