{
  "openapi": "3.0.1",
  "info": {
    "title": "Tesco Scraper - Products, Prices, Clubcard, Nutrition & Reviews",
    "description": "Scrape Tesco grocery products by search, category, link, product id or barcode: price, unit price, Clubcard Price, promotions, ingredients, allergens, nutrition, reviews and availability. UK, Ireland, Czechia, Hungary, Slovakia. Price monitor mode. $1.00 per 1,000 products.",
    "version": "0.1",
    "x-build-id": "h35HN4JKhctG9SZaH"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/topapi~tesco-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-topapi-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/topapi~tesco-scraper/runs": {
      "post": {
        "operationId": "runs-sync-topapi-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/topapi~tesco-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-topapi-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": {
          "searchQueries": {
            "title": "Search words",
            "type": "array",
            "description": "Words to search Tesco with, one per line, the way a shopper types them: \"milk\", \"oat milk\", \"nappies\", \"protein bars\". Each word is one Tesco search, read up to 1,000 products per request.",
            "items": {
              "type": "string"
            }
          },
          "startUrls": {
            "title": "Tesco links",
            "type": "array",
            "description": "Product, search or category links from tesco.com, tesco.ie, nakup.itesco.cz, bevasarlas.tesco.hu or potravinydomov.itesco.sk, e.g. https://www.tesco.com/groceries/en-GB/products/254656543, https://www.tesco.com/groceries/en-GB/search?query=milk&brand=TESCO or https://www.tesco.com/groceries/en-GB/shop/fresh-food/milk-butter-and-eggs/milk/all. Filters and sorting in a link are kept; each link uses its own store.",
            "items": {
              "type": "object",
              "required": [
                "url"
              ],
              "properties": {
                "url": {
                  "type": "string",
                  "title": "URL of a web page",
                  "format": "uri"
                }
              }
            }
          },
          "productIds": {
            "title": "Product ids or barcodes",
            "type": "array",
            "description": "Tesco product ids (the number in a product link, e.g. 254656543), base product ids (TPNB, e.g. 54550994) or GTIN / EAN barcodes (e.g. 5000436589457). Prefix one with tpnc:, tpnb: or gtin: to say which it is. Each id that exists becomes one row with full details.",
            "items": {
              "type": "string"
            }
          },
          "categories": {
            "title": "Categories",
            "type": "array",
            "description": "Tesco departments, aisles or shelves by name or link path: \"Fresh Food\", \"fresh-food/milk-butter-and-eggs\", \"fresh-food/milk-butter-and-eggs/milk\", \"Frozen Food\", \"Drinks\", \"Pet\", \"Health & Beauty\". A department reads every product in it.",
            "items": {
              "type": "string"
            }
          },
          "region": {
            "title": "Tesco store",
            "enum": [
              "UK",
              "IE",
              "CZ",
              "HU",
              "SK"
            ],
            "type": "string",
            "description": "The store searched for your search words, product ids and categories. Links always use the store of their own website.",
            "default": "UK"
          },
          "language": {
            "title": "Language (Czechia, Hungary, Slovakia)",
            "enum": [
              "local",
              "english"
            ],
            "type": "string",
            "description": "Titles and details in the store's own language or in English. The UK and Ireland are always English.",
            "default": "local"
          },
          "maxItems": {
            "title": "Maximum products",
            "minimum": 0,
            "type": "integer",
            "description": "Most products to deliver across all searches, links, ids and categories. 0 = no limit (a whole department can be 5,000+ products).",
            "default": 100
          },
          "maxItemsPerSource": {
            "title": "Maximum products per search / category",
            "minimum": 0,
            "type": "integer",
            "description": "Most products from each search word, link or category. Empty = only the overall maximum applies."
          },
          "startPage": {
            "title": "Start page",
            "minimum": 1,
            "type": "integer",
            "description": "Tesco results page to start from on each search and category (Tesco shows 24 products per page), to resume a large read. A page= value in a pasted link wins.",
            "default": 1
          },
          "maxPagesPerSource": {
            "title": "Maximum Tesco pages per search / category",
            "minimum": 0,
            "type": "integer",
            "description": "Stop each search or category after this many Tesco pages of 24 products. 0 = no page limit.",
            "default": 0
          },
          "sortBy": {
            "title": "Sort",
            "enum": [
              "relevance",
              "price-ascending",
              "price-descending"
            ],
            "type": "string",
            "description": "Order of search and category results, like the sort menu on Tesco.",
            "default": "relevance"
          },
          "brand": {
            "title": "Brands",
            "type": "array",
            "description": "Only these brands, as Tesco writes them in its brand filter: \"TESCO\", \"TESCO finest\", \"Cadbury\", \"alpro\".",
            "items": {
              "type": "string"
            }
          },
          "dietary": {
            "title": "Dietary / lifestyle",
            "type": "array",
            "description": "Tesco's dietary filter values: \"Vegan\", \"Vegetarian\", \"No gluten\", \"Organic\", \"No milk\", \"Halal\" ...",
            "items": {
              "type": "string"
            }
          },
          "onOffer": {
            "title": "Special offers only",
            "type": "boolean",
            "description": "Only products on a promotion or Clubcard Price (Tesco's own offers filter).",
            "default": false
          },
          "newProducts": {
            "title": "New products only",
            "type": "boolean",
            "description": "Only products Tesco marks as new.",
            "default": false
          },
          "productSource": {
            "title": "Sold by",
            "enum": [
              "all",
              "tesco",
              "marketplace"
            ],
            "type": "string",
            "description": "Tesco's own range, its Marketplace (third-party sellers, with seller name), or both.",
            "default": "all"
          },
          "minPrice": {
            "title": "Minimum price",
            "minimum": 0,
            "type": "number",
            "description": "Only products at or above this shelf price, in the store's currency (GBP, EUR, CZK, HUF). Empty = no floor."
          },
          "maxPrice": {
            "title": "Maximum price",
            "minimum": 0,
            "type": "number",
            "description": "Only products at or below this shelf price, in the store's currency. Empty = no ceiling. With Price: low to high, the read stops at the first product above it."
          },
          "inStockOnly": {
            "title": "Available products only",
            "type": "boolean",
            "description": "Skip products Tesco shows as unavailable.",
            "default": false
          },
          "clubcardOnly": {
            "title": "Clubcard Prices only",
            "type": "boolean",
            "description": "Only products with a Clubcard Price offer.",
            "default": false
          },
          "includeProductDetails": {
            "title": "Product details",
            "type": "boolean",
            "description": "Adds the product page data to each row: description, pack size and net contents, ingredients, allergens, full nutrition table (per 100 g / ml and per serving), GDA traffic lights, storage, cooking and freezing instructions, origin, recycling, warnings, manufacturer and return address, all images, ratings distribution. Read 10 products per request; same price per product.",
            "default": true
          },
          "includeReviews": {
            "title": "Customer reviews",
            "type": "boolean",
            "description": "Adds the product's customer reviews (rating, title, text, date, verified buyer, syndication source), newest first. Same price per product.",
            "default": false
          },
          "maxReviewsPerProduct": {
            "title": "Reviews per product",
            "minimum": 1,
            "maximum": 500,
            "type": "integer",
            "description": "Most reviews added to each product when reviews are on (up to 500).",
            "default": 10
          },
          "reviewsPostedWithin": {
            "title": "Reviews posted within",
            "type": "string",
            "description": "Only reviews newer than this: \"7 days\", \"3 months\", \"1 year\" or a date like 2026-01-31. Empty = all."
          },
          "deduplicateProducts": {
            "title": "Each product once",
            "type": "boolean",
            "description": "A product found by several searches, links or categories is delivered (and charged) once. Turn off to get one row per product per source.",
            "default": true
          },
          "excludeEmptyFields": {
            "title": "Leave out empty fields",
            "type": "boolean",
            "description": "Drop fields that are empty for a product (smaller rows). Off = every row has every field, empty ones as null.",
            "default": false
          },
          "monitorMode": {
            "title": "Monitor prices (only new or changed products)",
            "type": "boolean",
            "description": "For scheduled runs: each run delivers only products not delivered by an earlier run of the same input, plus products whose price, Clubcard price, offers or availability changed since (changeType, previousPrice, priceChange, priceChangePercent). A run with nothing new charges nothing.",
            "default": false
          },
          "monitorStoreName": {
            "title": "Monitor name",
            "type": "string",
            "description": "Name of this watch. Runs with the same name and the same input share one memory.",
            "default": "tesco-monitor"
          },
          "resetMonitor": {
            "title": "Start the monitor over",
            "type": "boolean",
            "description": "Forget what earlier runs delivered (the next run delivers everything again).",
            "default": false
          },
          "proxyConfiguration": {
            "title": "Proxy",
            "type": "object",
            "description": "Not needed: Tesco's product API answers without a proxy, and the actor moves to Apify's datacenter and then residential proxy by itself if it is refused. Set one only to use your own network.",
            "default": {
              "useApifyProxy": false
            }
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}