{ "openapi": "3.0.1", "info": { "title": "Save-On-Foods, PriceSmart, Urban Fare & Quality Foods Scraper", "description": "Store-level grocery prices from Save-On-Foods, PriceSmart Foods, Urban Fare and Quality Foods across Western Canada. Search, aisles or whole stores, nearest stores by postal code. Sale dates, UPC, unit price, fees, stock, nutrition.", "version": "0.1", "x-build-id": "YIk4Fqww5RIOoC1So" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/yugenox~save-on-foods-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-yugenox-save-on-foods-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/yugenox~save-on-foods-scraper/runs": { "post": { "operationId": "runs-sync-yugenox-save-on-foods-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/yugenox~save-on-foods-scraper/run-sync": { "post": { "operationId": "run-sync-yugenox-save-on-foods-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": { "banner": { "title": "Grocery chain", "enum": [ "saveonfoods", "pricesmart", "urbanfare", "qualityfoods" ], "type": "string", "description": "Which Pattison Food Group chain to price. Each chain prices its own stores independently. To compare several chains in one run, use \"Several chains\" under Advanced.", "default": "saveonfoods" }, "search_terms": { "title": "Search terms", "type": "array", "description": "Products to look up, e.g. \"milk\", \"organic eggs\", \"chicken breast\". Each term returns up to ~280 best matches (the store's own search limit). For every product in an aisle, use Categories instead. With Categories set, the terms search inside those categories.", "items": { "type": "string" } }, "categories": { "title": "Categories", "type": "array", "description": "Departments (📁) or aisles (└) to scrape completely. A department includes every aisle under it.", "items": { "type": "string", "enum": [ "canadian-products", "fruits-vegetables", "fruits-vegetables/fresh-fruit", "fruits-vegetables/fresh-juice-smoothies", "fruits-vegetables/fresh-noodle-tofu-soy-products", "fruits-vegetables/fresh-vegetables", "fruits-vegetables/salad-kits-greens-essentials", "fruits-vegetables/trays-baskets-platters", "fruits-vegetables/dried-snack-fruit-nuts", "fruits-vegetables/dressing-dips", "baby-care", "baby-care/baby-food", "baby-care/baby-formula", "baby-care/diapers", "baby-care/baby-wipes", "baby-care/baby-bath-skincare", "baby-care/baby-accessories-toys", "baby-care/baby-health-wellness", "bakery", "bakery/bagels-english-muffins", "bakery/breads", "bakery/cakes", "bakery/dessert-pastries", "bakery/frozen-bakery", "bakery/pies-tarts", "bakery/pitas-flatbread-wraps", "bakery/pizza-crust-crumbs", "bakery/rolls-buns", "bakery/roti-naan-breads", "cleaning-paper-home", "cleaning-paper-home/air-freshners-candles", "cleaning-paper-home/cleaning-supplies", "cleaning-paper-home/laundry-essentials", "cleaning-paper-home/paper-products", "cleaning-paper-home/plastic-foil-storage", "cleaning-paper-home/household-essentials", "cleaning-paper-home/kitchen-dining", "cleaning-paper-home/bakeware-baking-tools", "cleaning-paper-home/outdoor-living", "dairy-eggs", "dairy-eggs/butter-margarine", "dairy-eggs/cheese", "dairy-eggs/chilled-juice-drinks", "dairy-eggs/dough-products", "dairy-eggs/eggs-substitutes", "dairy-eggs/milk-creams", "dairy-eggs/milk-substitutes", "dairy-eggs/pudding-desserts", "dairy-eggs/sour-cream-dips", "dairy-eggs/yogurt", "deli-ready-made-meals", "deli-ready-made-meals/cheese", "deli-ready-made-meals/dips-spreads-olives", "deli-ready-made-meals/meat", "deli-ready-made-meals/party-platters", "deli-ready-made-meals/quick-ready-meals-sides", "floral-and-garden", "floral-and-garden/bouquets", "floral-and-garden/ferns-outdoor-floral", "floral-and-garden/potted-plants", "floral-and-garden/roses", "frozen", "frozen/frozen-appetizers-snacks", "frozen/frozen-bakery", "frozen/frozen-beverages-ice", "frozen/frozen-breakfast", "frozen/frozen-fruit", "frozen/frozen-meals-sides", "frozen/frozen-meat", "frozen/frozen-pizza", "frozen/frozen-seafood", "frozen/frozen-vegetables", "frozen/ice-cream-desserts", "health-beauty", "health-beauty/diet-nutrition", "health-beauty/medicine-health", "health-beauty/personal-care", "health-beauty/beauty", "international-foods", "international-foods/asian", "international-foods/european", "international-foods/indian-middle-eastern", "international-foods/latin-mexican", "international-foods/mediterranean", "meat-seafood", "meat-seafood/bacon", "meat-seafood/beef-veal", "meat-seafood/chicken-turkey", "meat-seafood/fish", "meat-seafood/frozen-meat", "meat-seafood/frozen-seafood", "meat-seafood/game-specialty-meats", "meat-seafood/hot-dogs-sausages", "meat-seafood/lamb", "meat-seafood/meat-alternatives", "meat-seafood/pork-ham", "meat-seafood/shrimp-shell-fish", "meat-seafood/smoked-cured-fish", "pantry", "pantry/baking-goods", "pantry/breakfast", "pantry/canned-packaged", "pantry/condiments-toppings", "pantry/herbs-spices-seasonings", "pantry/marinates-sauces", "pantry/oils-vinegars", "pantry/pasta-sauces-grains", "pantry/beverages", "pantry/bulk", "pantry/candy", "pantry/snacks", "pet-care", "pet-care/cat", "pet-care/dog", "pet-care/pet-grooming", "pet-care/small-animal-fish-bird", "plant-based-non-dairy", "plant-based-non-dairy/meat-alternatives", "plant-based-non-dairy/non-dairy-beverages", "plant-based-non-dairy/non-dairy-cheese", "plant-based-non-dairy/non-dairy-creamers", "plant-based-non-dairy/non-dairy-frozen-dessert", "plant-based-non-dairy/non-dairy-spreads-condiments", "plant-based-non-dairy/non-dairy-yogurt", "plant-based-non-dairy/tofu", "plant-based-non-dairy/egg-alternatives" ], "enumTitles": [ "📁 Canadian Products", "📁 Fruits & Vegetables", " └ Fresh Fruit", " └ Fresh Juice & Smoothies", " └ Fresh Noodle, Tofu & Soy Products", " └ Fresh Vegetables", " └ Salad Kits & Greens, Essentials", " └ Trays, Baskets, Platters", " └ Dried Snack Fruit & Nuts", " └ Dressing & Dips", "📁 Baby Care", " └ Baby Food", " └ Baby Formula", " └ Diapers", " └ Baby Wipes", " └ Baby Bath & Skincare", " └ Baby Accessories & Toys", " └ Baby Health & Wellness", "📁 Bakery", " └ Bagels & English Muffins", " └ Breads", " └ Cakes", " └ Dessert & Pastries", " └ Frozen Bakery", " └ Pies & Tarts", " └ Pitas, Flatbread & Wraps", " └ Pizza Crust & Crumbs", " └ Rolls & Buns", " └ Roti & Naan Breads", "📁 Cleaning, Paper & Home", " └ Air Freshners & Candles", " └ Cleaning Supplies", " └ Laundry Essentials", " └ Paper Products", " └ Plastic, Foil & Storage", " └ Household Essentials", " └ Kitchen & Dining", " └ Bakeware & Baking Tools", " └ Outdoor Living", "📁 Dairy & Eggs", " └ Butter & Margarine", " └ Cheese", " └ Chilled Juice & Drinks", " └ Dough Products", " └ Eggs & Substitutes", " └ Milk & Creams", " └ Milk Substitutes", " └ Pudding & Desserts", " └ Sour Cream & Dips", " └ Yogurt", "📁 Deli & Ready Made Meals", " └ Cheese", " └ Dips, Spreads & Olives", " └ Meat", " └ Party Platters", " └ Quick Ready Meals & Sides", "📁 Floral and Garden", " └ Bouquets", " └ Ferns & Outdoor Floral", " └ Potted Plants", " └ Roses", "📁 Frozen", " └ Frozen Appetizers & Snacks", " └ Frozen Bakery", " └ Frozen Beverages & Ice", " └ Frozen Breakfast", " └ Frozen Fruit", " └ Frozen Meals & Sides", " └ Frozen Meat", " └ Frozen Pizza", " └ Frozen Seafood", " └ Frozen Vegetables", " └ Ice Cream & Desserts", "📁 Health & Beauty", " └ Diet & Nutrition", " └ Medicine & Health", " └ Personal Care", " └ Beauty", "📁 International Foods", " └ Asian", " └ European", " └ Indian & Middle Eastern", " └ Latin & Mexican", " └ Mediterranean", "📁 Meat & Seafood", " └ Bacon", " └ Beef & Veal", " └ Chicken & Turkey", " └ Fish", " └ Frozen Meat", " └ Frozen Seafood", " └ Game & Specialty Meats", " └ Hot Dogs & Sausages", " └ Lamb", " └ Meat Alternatives", " └ Pork & Ham", " └ Shrimp & Shell Fish", " └ Smoked & Cured Fish", "📁 Pantry", " └ Baking Goods", " └ Breakfast", " └ Canned & Packaged", " └ Condiments & Toppings", " └ Herbs, Spices & Seasonings", " └ Marinates & Sauces", " └ Oils & Vinegars", " └ Pasta, Sauces & Grains", " └ Beverages", " └ Bulk", " └ Candy", " └ Snacks", "📁 Pet Care", " └ Cat", " └ Dog", " └ Pet Grooming", " └ Small Animal, Fish & Bird", "📁 Plant Based & Non Dairy", " └ Meat Alternatives", " └ Non Dairy Beverages", " └ Non Dairy Cheese", " └ Non Dairy Creamers", " └ Non Dairy Frozen Dessert", " └ Non Dairy Spreads & Condiments", " └ Non Dairy Yogurt", " └ Tofu", " └ Egg Alternatives" ] } }, "categoryUrls": { "title": "Category IDs or URLs", "type": "array", "description": "Any category not in the list above: its numeric ID (e.g. \"30910\") or its URL from the chain's website (\"...-id-30910\"). Deeper aisles work too.", "items": { "type": "string" } }, "all_products": { "title": "Entire store", "type": "boolean", "description": "Scrape every product the store carries (15,000-23,000 items, a few minutes per store). Search terms and categories are optional when this is on.", "default": false }, "postal_code": { "title": "Postal code", "type": "string", "description": "Canadian postal code (BC, AB, SK, MB or YT). Prices come from the nearest store. A postal code a chain does not serve is refused with the provinces it does serve.", "default": "V6M 2P8" }, "locationId": { "title": "Store ID", "type": "string", "description": "Price exact stores instead of the nearest one (overrides postal code). One ID or several separated by commas, e.g. \"2246\" (Save-On-Foods Kerrisdale, Vancouver). Every row reports its store ID; the ID is also in the store's URL on the chain's site (/rsid/2246/)." }, "stores_per_banner": { "title": "Nearest stores", "minimum": 1, "maximum": 50, "type": "integer", "description": "Price the N nearest stores to the postal code (1-50) and compare prices between them in one run. Prices differ by store.", "default": 1 }, "all_stores": { "title": "Every store of the chain", "type": "boolean", "description": "Price every store of the chosen chain(s): about 195 Save-On-Foods, 5 PriceSmart, 5 Urban Fare and 14 Quality Foods stores. Combine with a few search terms or categories.", "default": false }, "on_sale_only": { "title": "Sale items only", "type": "boolean", "description": "Keep only products on sale right now (with a was-price and the sale's start and end dates).", "default": false }, "include_details": { "title": "Nutrition, ingredients & extra images", "type": "boolean", "description": "Also fetch each product's nutrition facts, ingredients, serving size and additional images. One extra request per product, so slower and billed per product as an add-on.", "default": false }, "max_items_per_search": { "title": "Max products per search term or category", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Upper limit for each search term (or term inside a category) per store.", "default": 1000 }, "max_items": { "title": "Max products in total", "minimum": 0, "type": "integer", "description": "Stop the whole run after this many products. 0 = no limit.", "default": 0 }, "banners": { "title": "Several chains (optional)", "type": "array", "description": "Price more than one chain in one run; overrides \"Grocery chain\". A chain with no store in the postal code's province is skipped with a note.", "items": { "type": "string", "enum": [ "saveonfoods", "pricesmart", "urbanfare", "qualityfoods" ], "enumTitles": [ "Save-On-Foods", "PriceSmart Foods", "Urban Fare", "Quality Foods" ] } }, "sort": { "title": "Sort order", "enum": [ "relevance", "price", "price desc", "brand", "brand desc" ], "type": "string", "description": "Order results are read in. Matters only when a limit cuts the list short (e.g. price = the cheapest N matches).", "default": "relevance" }, "maxConcurrency": { "title": "Parallel requests", "minimum": 1, "maximum": 10, "type": "integer", "description": "Requests in flight at once (1-10). The default suits almost every run.", "default": 8 } } }, "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 } } } } } } } } } }