{
  "openapi": "3.0.1",
  "info": {
    "title": "Coles Scraper: Prices, Specials, Nutrition & Store Stock",
    "description": "Scrape Coles Australia (coles.com.au): product, brand, size, price, was-price, specials, unit price, stock and category by keyword, category page or product link. Add nutrition labels, aisle and shelf stock for your store, or watch prices and get only what changed.",
    "version": "0.1",
    "x-build-id": "MJnDWhCg8eTbbVREU"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/apimy~coles-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-apimy-coles-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/apimy~coles-scraper/runs": {
      "post": {
        "operationId": "runs-sync-apimy-coles-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/apimy~coles-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-apimy-coles-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": {
          "keywords": {
            "title": "🔎 What to look up",
            "type": "array",
            "description": "Products to search on coles.com.au — <b>milk</b>, <b>nappies</b>, <b>tim tam</b>, <b>olive oil</b>. One search per keyword; each product comes back as one row with price, was-price, unit price, stock and category.",
            "items": {
              "type": "string"
            }
          },
          "specials": {
            "title": "🏷️ This week's Coles specials",
            "type": "boolean",
            "description": "Walk the Coles <b>On special</b> list (half price, down-downs, multi-buys) without typing a keyword. Depth is set by <b>Products per keyword or category</b>.",
            "default": false
          },
          "categories": {
            "title": "📂 Coles category pages",
            "type": "array",
            "description": "Whole aisles instead of a keyword. Paste a Coles category link such as <b>https://www.coles.com.au/browse/dairy-eggs-fridge/milk</b>, or just the path after /browse/ (<b>dairy-eggs-fridge/milk</b>). The Actor pages through the aisle up to <b>Products per keyword or category</b>.",
            "default": [],
            "items": {
              "type": "string"
            }
          },
          "productUrls": {
            "title": "🔗 Coles product URLs",
            "type": "array",
            "description": "Specific products instead of, or alongside, a search. Paste Coles product links, e.g. <b>https://www.coles.com.au/product/coles-full-cream-milk-2l-8150288</b>. A product page also carries the label: ingredients, allergens, nutrition panel.",
            "default": [],
            "items": {
              "type": "string"
            }
          },
          "maxProductsPerKeyword": {
            "title": "💯 Products per keyword or category",
            "minimum": 1,
            "maximum": 1000,
            "type": "integer",
            "description": "How deep to go for each keyword, category page or the specials list. Thirty is a fast look; raise it to sweep a whole aisle (Coles shows 48 products a page).",
            "default": 30
          },
          "output": {
            "title": "📤 What a row should be",
            "enum": [
              "products",
              "stores"
            ],
            "type": "string",
            "description": "<b>One product per row</b> — prices, specials, stock, category (the default). <b>One Coles store per row</b> — the Coles supermarkets near a postcode or a pair of coordinates, nearest first, with the store number you can paste into \"Coles store number\".",
            "default": "products"
          },
          "colesStoreId": {
            "title": "🏬 Coles store number",
            "type": "string",
            "description": "Set it and product rows come back with the aisle the product sits in and the quantity that store has on the shelf, instead of the national range. Get the number from a store row of this Actor (<b>One Coles store per row</b>), or from the URL of your store on the Coles site.",
            "default": ""
          },
          "includeNutrition": {
            "title": "🥗 Ingredients, allergens and nutrition",
            "type": "boolean",
            "description": "Adds ingredients, allergens, dietary claims, the nutrition panel, serving size, country of origin and GTIN to every product found by search or category. Coles keeps the label on the product page, so each product needs one extra request, charged as a separate add-on. Products given as product URLs carry the label anyway, at no extra charge.",
            "default": false
          },
          "maxNutritionLookups": {
            "title": "Maximum label lookups per run",
            "minimum": 0,
            "type": "integer",
            "description": "A ceiling on the extra label requests, so a large sweep cannot surprise you.",
            "default": 200
          },
          "postcode": {
            "title": "📍 Postcode",
            "type": "string",
            "description": "An Australian postcode, used to find the Coles stores near it when rows are stores. Coordinates can be given instead.",
            "default": ""
          },
          "latitude": {
            "title": "Latitude",
            "type": "string",
            "description": "Coordinates instead of a postcode, e.g. <b>-33.8688</b>. Both latitude and longitude must be given.",
            "default": ""
          },
          "longitude": {
            "title": "Longitude",
            "type": "string",
            "description": "The matching longitude, e.g. <b>151.2093</b>.",
            "default": ""
          },
          "watchName": {
            "title": "🔔 Watch name — deliver only what changed",
            "type": "string",
            "description": "Give this run a name — <b>weekly-shop</b>, <b>dairy</b> — and every later run under the same name returns only products whose price moved, that went on or off special, that came back in stock, or that are new. Leave empty to get everything found, every time.",
            "default": ""
          },
          "deliverBaseline": {
            "title": "📥 Deliver everything on the first run of a watch",
            "type": "boolean",
            "description": "The first run of a new watch has nothing to compare against. Leave this on to receive the current prices as the starting point; turn it off to start silently and hear only about movements from now on.",
            "default": true
          },
          "resetWatch": {
            "title": "♻️ Forget the prices this watch remembers",
            "type": "boolean",
            "description": "Wipe this watch's memory and start a new baseline on this run.",
            "default": false
          },
          "onSpecialOnly": {
            "title": "🏷️ Only products on special",
            "type": "boolean",
            "description": "Keep only products with a was-price or a special flag.",
            "default": false
          },
          "minDiscountPercent": {
            "title": "📉 Minimum discount, %",
            "minimum": 0,
            "maximum": 95,
            "type": "integer",
            "description": "Keep only products discounted by at least this much. Zero means no minimum.",
            "default": 0
          },
          "maxPrice": {
            "title": "💲 Maximum price, AUD",
            "minimum": 0,
            "type": "integer",
            "description": "Ignore anything dearer than this. Zero means no limit.",
            "default": 0
          },
          "inStockOnly": {
            "title": "📦 Only what is in stock",
            "type": "boolean",
            "description": "Drop products Coles reports as unavailable.",
            "default": false
          },
          "maxItems": {
            "title": "Maximum rows per run",
            "minimum": 1,
            "type": "integer",
            "description": "A hard ceiling on what one run delivers and bills.",
            "default": 5000
          },
          "concurrency": {
            "title": "Parallel requests",
            "minimum": 1,
            "maximum": 10,
            "type": "integer",
            "description": "How many Coles requests to run at once.",
            "default": 3
          },
          "proxyConfiguration": {
            "title": "Proxy configuration",
            "type": "object",
            "description": "Apify Proxy with residential addresses is on by default, because Coles refuses most datacenter traffic. The Actor still tries the cheaper datacenter pool first and moves to Australian residential addresses as soon as it is refused. You are not billed for proxy traffic separately.",
            "default": {
              "useApifyProxy": true,
              "apifyProxyGroups": [
                "RESIDENTIAL"
              ]
            }
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}