{ "openapi": "3.0.1", "info": { "title": "SkipTheDishes Scraper β€” Restaurants, Menus, Prices & Offers", "description": "Scrape SkipTheDishes across Canada β€” every restaurant in a city (open and closed), full menus with prices, item options, delivery fees by address, offers, phone numbers, addresses, hours and grocery/convenience/liquor store catalogs. No login.", "version": "0.1", "x-build-id": "1OxwrAKzhVXxaeVkv" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/yugenox~skipthedishes-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-yugenox-skipthedishes-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~skipthedishes-scraper/runs": { "post": { "operationId": "runs-sync-yugenox-skipthedishes-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~skipthedishes-scraper/run-sync": { "post": { "operationId": "run-sync-yugenox-skipthedishes-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": { "cities": { "title": "πŸ™οΈ Cities", "type": "array", "description": "SkipTheDishes cities to scrape, e.g. \"Toronto\", \"Vancouver\", \"MontrΓ©al\", \"St. John's\". A two-letter province code (\"ON\", \"BC\", \"QC\"…) adds every city in that province, and \"all\" adds all ~180 cities in Canada. Each city returns every restaurant and store that delivers there β€” open and closed.", "items": { "type": "string" } }, "location": { "title": "πŸ“ Delivery location (latitude, longitude)", "type": "string", "description": "Optional. Coordinates of an address, e.g. \"43.6532, -79.3832\". Returns only the restaurants that deliver to that spot, with the live delivery fee, order minimum, distance and delivery time for that address." }, "restaurantUrls": { "title": "πŸ”— Restaurant URLs", "type": "array", "description": "Optional. SkipTheDishes restaurant or store pages, e.g. https://www.skipthedishes.com/asian-gourmet-dundas-street-east (or just the last part of the URL). Returns details and menus for exactly these.", "items": { "type": "string" } }, "dishQuery": { "title": "🍜 Only restaurants that serve this dish", "type": "string", "description": "Optional. Keep only restaurants whose menu has this dish, e.g. \"butter chicken\", \"poutine\", \"pho\". Works with cities and with a delivery location. Uses SkipTheDishes' own dish search, which only covers restaurants open at run time (closed ones are never matched)." }, "includeDetails": { "title": "Add restaurant details", "type": "boolean", "description": "Full street address with postal code, phone number, rating out of 10, open now / next opening time, today's ordering hours, delivery time range and every active offer (free items, BOGO, $ off). One extra request per restaurant.", "default": false }, "includeMenus": { "title": "Add full menus", "type": "boolean", "description": "Every menu item with price, description, image, availability and a popular flag. Grocery, convenience and liquor stores return their full product catalog (sizes, sold-by-weight, estimated prices).", "default": false }, "includeModifiers": { "title": "Add item options (sizes, add-ons, choices)", "type": "boolean", "description": "For each menu item, its option groups (e.g. \"Choose a size\", \"Add toppings\") with minimum/maximum picks and the price of each option. One extra request per menu item β€” combine with \"Max items per restaurant\" to keep runs fast.", "default": false }, "outputFormat": { "title": "Output format", "enum": [ "restaurants", "menuItems" ], "type": "string", "description": "\"One row per restaurant\" nests the menu inside each restaurant. \"One row per menu item\" gives a flat table of items with the restaurant name, city and URL on every row (menus are turned on automatically).", "default": "restaurants" }, "restaurantTypes": { "title": "Store types", "type": "array", "description": "Optional. Keep only these kinds of stores. Leave empty for all.", "items": { "type": "string", "enum": [ "FULL_SERVICE", "QUICK_SERVICE", "GROCERY", "CONVENIENCE_STORE", "ALCOHOL" ], "enumTitles": [ "Restaurants", "Fast food / quick service", "Grocery & bakery", "Convenience stores", "Liquor & beer stores" ] } }, "cuisines": { "title": "Cuisines", "type": "array", "description": "Optional. Keep only restaurants tagged with one of these cuisines, e.g. \"Pizza\", \"Indian\", \"Sushi\", \"Vegan\" (partial, case-insensitive match).", "items": { "type": "string" } }, "includeClosed": { "title": "Include restaurants that are closed right now", "type": "boolean", "description": "Most restaurants are closed outside business hours. Turn off to get only the ones taking orders at run time.", "default": true }, "onlyWithOffers": { "title": "Only restaurants with an active offer", "type": "boolean", "description": "Keep only restaurants running a deal right now (free item, buy-one-get-one, or $ off).", "default": false }, "orderType": { "title": "Order type", "enum": [ "DELIVERY", "PICKUP" ], "type": "string", "description": "Delivery or pickup β€” changes which restaurants are listed and menu prices where they differ.", "default": "DELIVERY" }, "maxRestaurants": { "title": "Max restaurants", "minimum": 1, "type": "integer", "description": "Stop after this many restaurants in total. Leave empty for no limit (Toronto alone has ~5,000)." }, "maxRestaurantsPerCity": { "title": "Max restaurants per city", "minimum": 1, "type": "integer", "description": "Optional cap per city β€” useful with many cities or \"all\"." }, "maxItemsPerRestaurant": { "title": "Max menu items per restaurant", "minimum": 1, "type": "integer", "description": "Optional cap on menu items (or store products) per restaurant. Leave empty for the full menu." }, "maxConcurrency": { "title": "Max concurrency", "minimum": 1, "maximum": 30, "type": "integer", "description": "Parallel requests. The default is fast and gentle; higher values only help for large menu jobs.", "default": 10 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Apify Proxy is required. The default (automatic) works β€” no residential proxy needed.", "default": { "useApifyProxy": true } } } }, "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 } } } } } } } } } }