{ "openapi": "3.0.1", "info": { "title": "Tesco Scraper: Prices, Clubcard Offers & Products (UK)", "description": "Scrape Tesco UK grocery products by search, category or product URL: price, unit price, Clubcard Price, promotions and multi-buys, stock, category, barcode (GTIN), ratings, and optional ingredients, allergens and nutrition. Fast JSON from Tesco's own data. Pay per product.", "version": "0.1", "x-build-id": "iYn7D7WiRvkviQdlm" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/zaiq~tesco-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-zaiq-tesco-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/zaiq~tesco-scraper/runs": { "post": { "operationId": "runs-sync-zaiq-tesco-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/zaiq~tesco-scraper/run-sync": { "post": { "operationId": "run-sync-zaiq-tesco-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", "type": "array", "description": "Words to search Tesco for, one per line, the way you would type them on the site (for example: milk, coffee, pasta). Each term returns up to the per-search limit below.", "items": { "type": "string" } }, "categoryUrls": { "title": "Category or aisle URLs", "type": "array", "description": "Tesco category, aisle or shelf pages to list every product from, for example https://www.tesco.com/groceries/en-GB/shop/fresh-food/milk-butter-and-eggs/milk/all", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "productUrls": { "title": "Product URLs", "type": "array", "description": "Tesco product pages to check, for example https://www.tesco.com/groceries/en-GB/products/254656543. Products that cannot be found come back as a free row with an error.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "productIds": { "title": "Product numbers", "type": "array", "description": "Tesco product numbers: the 9-digit TPNC at the end of a product URL, or the 8-digit TPNB. Useful for checking a fixed list of products every day.", "items": { "type": "string" } }, "maxItems": { "title": "Max products", "minimum": 1, "maximum": 1000000, "type": "integer", "description": "The run stops after writing this many products in total. You pay only for products written.", "default": 1000 }, "maxItemsPerSource": { "title": "Max products per search or category", "minimum": 1, "maximum": 100000, "type": "integer", "description": "Stop each search term or category after this many products. Raise it to list a whole category.", "default": 200 }, "offersOnly": { "title": "Only products on offer", "type": "boolean", "description": "Only products with a promotion: Clubcard Prices, multi-buys, meal deals and other offers. Applies to searches, categories and product inputs.", "default": false }, "sort": { "title": "Sort", "enum": [ "relevance", "price-low-high", "price-high-low" ], "type": "string", "description": "The order Tesco returns results in (its own sort options).", "default": "relevance" }, "includeDetails": { "title": "Add ingredients, allergens and nutrition", "type": "boolean", "description": "Read each product's detail page as well and add its ingredients, allergy advice, nutrition table, storage and origin under `details`. One extra request per product, charged as a separate product-details event.", "default": false }, "deduplicate": { "title": "Skip products already returned in this run", "type": "boolean", "description": "When a product is found by two searches or categories, write it once (with the first one's search term or category). Switch off to get every search's full list, for example to track search rankings.", "default": true }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Tesco answers UK home (residential) connections reliably; that is the default and is included in the price.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ], "apifyProxyCountry": "GB" } }, "maxConcurrency": { "title": "Requests at once", "minimum": 1, "maximum": 10, "type": "integer", "description": "At most this many requests to Tesco at the same time (kept low to be polite).", "default": 4 } } }, "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 } } } } } } } } } }