{ "openapi": "3.0.1", "info": { "title": "New World NZ Scraper — Store Prices, Clubcard, Specials, EAN", "description": "New World NZ (newworld.co.nz) scraper: store, product ID, name, brand, size, shelf price, Clubcard price, unit price, promotions, category, channels, URL; details add EAN barcode, ingredients, allergens, nutrition, image. Keyword or category, one store to all. Pay per result, no login.", "version": "1.0", "x-build-id": "jcI1IQdV2JF6bNUIS" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/architekture~new-world-nz-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-architekture-new-world-nz-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/architekture~new-world-nz-scraper/runs": { "post": { "operationId": "runs-sync-architekture-new-world-nz-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/architekture~new-world-nz-scraper/run-sync": { "post": { "operationId": "run-sync-architekture-new-world-nz-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": { "searchTerms": { "title": "Search terms", "maxItems": 50, "type": "array", "description": "Product keywords, searched the way a shopper types them on newworld.co.nz (e.g. milk, weet-bix). Up to 50.", "items": { "type": "string" } }, "categories": { "title": "Categories", "maxItems": 50, "type": "array", "description": "Browse whole categories instead of (or as well as) searching: a category name (\"Pantry\"), a path (\"pantry/baking\") or a category URL (https://www.newworld.co.nz/shop/category/pantry). Matched against each store's own category tree.", "items": { "type": "string" } }, "stores": { "title": "Stores", "maxItems": 200, "type": "array", "description": "New World stores to price, by name (\"Thorndon\", \"New World Queenstown\") or store id. Prices differ between stores, so every product row carries its store. Use \"all\" for every online store (about 150). Default: New World Thorndon.", "items": { "type": "string" } }, "maxItemsPerQuery": { "title": "Max products per search, per store", "minimum": 0, "maximum": 1000, "type": "integer", "description": "Stop each search term or category at each store after this many products. 0 = everything New World lists (at most 1,000 per search per store).", "default": 100 }, "includeDetails": { "title": "Include product details", "type": "boolean", "description": "Also fetch each product's detail record: barcode (EAN), description, ingredients, allergens, nutrition and image. One extra request per product, so slower; same price per product.", "default": false }, "incrementalMode": { "title": "Incremental: only new or changed products", "type": "boolean", "description": "Requires stateKey. Delivers only products that are new to this stateKey at that store, or whose price, Clubcard price, unit price or promotions changed since they were last delivered. Unchanged products are skipped and not charged; a run that delivers nothing pays no run fee.", "default": false }, "stateKey": { "title": "State key", "type": "string", "description": "Any name (e.g. my-basket). Keeps saved progress and the incremental baseline in your account, isolated per key. Use a different key for different inputs.", "default": "" }, "continuePreviousRun": { "title": "Continue saved collection", "type": "boolean", "description": "Resume an unfinished collection saved under stateKey (after a spending limit, timeout, abort or platform migration). Delivered products are not delivered or charged again; the resumed run pays its own $0.15 run fee only if it delivers at least one product.", "default": false }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "New World is protected by Cloudflare: Apify RESIDENTIAL proxy in New Zealand is required and is the tested default.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ], "apifyProxyCountry": "NZ" } }, "feedback": { "title": "Feedback for the maintainers", "type": "string", "description": "Tell the maintainers what you needed and did not get. Read by a human; does not change the output." } } }, "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 } } } } } } } } } }