# Restaurant/Menu/Local Competitor Snapshot (`isotonic/restaurant-menu-local-competitor-snapshot`) Actor Collects public restaurant website, menu, contact, and competitor-positioning signals into flat dataset rows. - **URL**: https://apify.com/isotonic/restaurant-menu-local-competitor-snapshot.md - **Developed by:** [Brian Keefe](https://apify.com/isotonic) (community) - **Categories:** Travel, Business, Lead generation - **Stats:** 2 total users, 1 monthly users, 100.0% runs succeeded, 0 bookmarks - **User rating**: No ratings yet ## Pricing Pay per usage This Actor is paid per platform usage. The Actor is free to use, and you only pay for the Apify platform usage, which gets cheaper the higher subscription plan you have. Learn more: https://docs.apify.com/platform/actors/running/actors-in-store#pay-per-usage ## What's an Apify Actor? Actors are a software tools running on the Apify platform, for all kinds of web data extraction and automation use cases. In Batch mode, an Actor accepts a well-defined JSON input, performs an action which can take anything from a few seconds to a few hours, and optionally produces a well-defined JSON output, datasets with results, or files in key-value store. In Standby mode, an Actor provides a web server which can be used as a website, API, or an MCP server. Actors are written with capital "A". ## How to integrate an Actor? If asked about integration, you help developers integrate Actors into their projects. You adapt to their stack and deliver integrations that are safe, well-documented, and production-ready. The best way to integrate Actors is as follows. In JavaScript/TypeScript projects, use official [JavaScript/TypeScript client](https://docs.apify.com/api/client/js/docs.md): ```bash npm install apify-client ``` In Python projects, use official [Python client library](https://docs.apify.com/api/client/python/docs.md): ```bash pip install apify-client ``` In shell scripts, use [Apify CLI](https://docs.apify.com/cli/docs.md): ````bash # MacOS / Linux curl -fsSL https://apify.com/install-cli.sh | bash # Windows irm https://apify.com/install-cli.ps1 | iex ```bash In AI frameworks, you might use the [Apify MCP server](https://docs.apify.com/integrations/mcp.md). If your project is in a different language, use the [REST API](https://docs.apify.com/api/v2.md). For usage examples, see the [API](#api) section below. For more details, see Apify documentation as [Markdown index](https://docs.apify.com/llms.txt) and [Markdown full-text](https://docs.apify.com/llms-full.txt). # README ## restaurant-menu-local-competitor-snapshot Production-oriented Apify Actor repo for collecting restaurant website, menu, and local competitor positioning signals from public web data. ### What It Does - Accepts `restaurantUrls`, `domains`, and/or richer `businessRows`. - Fetches public restaurant pages without browser automation. - Extracts restaurant-level fields from HTML and `schema.org` JSON-LD. - Discovers menu pages, menu links, reservation links, delivery links, social links, and contact links. - Emits flat dataset rows: - one `restaurant` row per restaurant - optional `menu_item` rows per menu item - Stores the same array in dataset output and the `OUTPUT` key. - Gracefully degrades on fetch failures by emitting partial records with warnings instead of crashing the batch. ### Public-Data Limitations - This actor uses only public website data. - It does not log in, use private APIs, or bypass access controls. - It avoids deep scraping of delivery platforms. Public outbound links are captured, but third-party menu ecosystems are not recursively scraped. - PDF and image menu links are recorded, but binary files are not parsed unless menu text is directly present in HTML. ### Input ```json { "restaurantUrls": ["https://example-restaurant.com"], "domains": ["example-restaurant.com"], "businessRows": [ { "name": "Example Restaurant", "url": "https://example-restaurant.com", "domain": "example-restaurant.com", "city": "Portland", "state": "OR", "fixtureId": "optional-fixture-id" } ], "maxPagesPerRestaurant": 3, "includeMenuItems": true, "fixtureMode": false } ```` ### Output The actor pushes flat-ish JSON rows to the default dataset and writes the same array to `OUTPUT`. Restaurant row fields include: - `recordType` - `restaurantKey` - `name` - `website` - `domain` - `status` - `warnings` - `cuisineTags` - `priceRange` - `ratingValue` - `reviewCount` - `telephone` - `email` - `address` - `reservationLinks` - `deliveryLinks` - `socialLinks` - `contactLinks` - `menuPageUrls` - `pdfOrImageMenuLinks` - `competitorPositioningFlags` Menu item rows include: - `recordType: "menu_item"` - `restaurantKey` - `restaurantName` - `sourceUrl` - `itemName` - `itemDescription` - `itemPrice` See `examples/sample-output.json` for the deterministic fixture output. ### Local Usage Install dependencies: ```bash npm install ``` Run locally with Apify local storage: ```bash APIFY_LOCAL_STORAGE_DIR=./storage CRAWLEE_STORAGE_DIR=./storage node src/main.js ``` To use the deterministic fixture instead of live fetches, point `INPUT` at `examples/sample-input.json` or set `fixtureMode: true` in your input. ### Smoke Tests Run deterministic smoke tests: ```bash npm test ``` The smoke suite verifies: - exact fixture output from `runSnapshot(input)` - actor main path reading `INPUT` from Apify local storage - dataset write behavior - `OUTPUT` key write behavior ### Project Structure ```text .actor/ examples/ src/ tests/smoke/ ``` Main modules: - `src/main.js` - `src/runner.js` - `src/input.js` - `src/extract.js` - `src/fetch.js` ### Publish ```bash apify push ``` # Actor input Schema ## `restaurantUrls` (type: `array`): Restaurant website URLs to snapshot. ## `domains` (type: `array`): Bare domains to snapshot. The actor prefixes https:// when needed. ## `businessRows` (type: `array`): Optional richer rows containing name, url, domain, and other metadata. ## `maxPagesPerRestaurant` (type: `integer`): Maximum number of public pages to fetch per restaurant, including discovered menu pages. ## `includeMenuItems` (type: `boolean`): When enabled, emit additional menu\_item dataset rows for simple HTML or schema.org menu items. ## `fixtureMode` (type: `boolean`): Uses deterministic raw HTML fixtures instead of live HTTP fetches. ## Actor input object example ```json { "maxPagesPerRestaurant": 3, "includeMenuItems": true, "fixtureMode": false } ``` # API You can run this Actor programmatically using our API. Below are code examples in JavaScript, Python, and CLI, as well as the OpenAPI specification and MCP server setup. ## JavaScript example ```javascript import { ApifyClient } from 'apify-client'; // Initialize the ApifyClient with your Apify API token // Replace the '' with your token const client = new ApifyClient({ token: '', }); // Prepare Actor input const input = {}; // Run the Actor and wait for it to finish const run = await client.actor("isotonic/restaurant-menu-local-competitor-snapshot").call(input); // Fetch and print Actor results from the run's dataset (if any) console.log('Results from dataset'); console.log(`💾 Check your data here: https://console.apify.com/storage/datasets/${run.defaultDatasetId}`); const { items } = await client.dataset(run.defaultDatasetId).listItems(); items.forEach((item) => { console.dir(item); }); // 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/js/docs ``` ## Python example ```python from apify_client import ApifyClient # Initialize the ApifyClient with your Apify API token # Replace '' with your token. client = ApifyClient("") # Prepare the Actor input run_input = {} # Run the Actor and wait for it to finish run = client.actor("isotonic/restaurant-menu-local-competitor-snapshot").call(run_input=run_input) # Fetch and print Actor results from the run's dataset (if there are any) print("💾 Check your data here: https://console.apify.com/storage/datasets/" + run["defaultDatasetId"]) for item in client.dataset(run["defaultDatasetId"]).iterate_items(): print(item) # 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/python/docs/quick-start ``` ## CLI example ```bash echo '{}' | apify call isotonic/restaurant-menu-local-competitor-snapshot --silent --output-dataset ``` ## MCP server setup ```json { "mcpServers": { "apify": { "command": "npx", "args": [ "mcp-remote", "https://mcp.apify.com/?tools=isotonic/restaurant-menu-local-competitor-snapshot", "--header", "Authorization: Bearer " ] } } } ``` ## OpenAPI specification ```json { "openapi": "3.0.1", "info": { "title": "Restaurant/Menu/Local Competitor Snapshot", "description": "Collects public restaurant website, menu, contact, and competitor-positioning signals into flat dataset rows.", "version": "0.1", "x-build-id": "EsXo6hGUgDKF4gSH9" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/isotonic~restaurant-menu-local-competitor-snapshot/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-isotonic-restaurant-menu-local-competitor-snapshot", "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/isotonic~restaurant-menu-local-competitor-snapshot/runs": { "post": { "operationId": "runs-sync-isotonic-restaurant-menu-local-competitor-snapshot", "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/isotonic~restaurant-menu-local-competitor-snapshot/run-sync": { "post": { "operationId": "run-sync-isotonic-restaurant-menu-local-competitor-snapshot", "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": { "restaurantUrls": { "title": "Restaurant URLs", "type": "array", "description": "Restaurant website URLs to snapshot.", "items": { "type": "string" } }, "domains": { "title": "Domains", "type": "array", "description": "Bare domains to snapshot. The actor prefixes https:// when needed.", "items": { "type": "string" } }, "businessRows": { "title": "Business Rows", "type": "array", "description": "Optional richer rows containing name, url, domain, and other metadata.", "items": { "type": "object" } }, "maxPagesPerRestaurant": { "title": "Max Pages Per Restaurant", "minimum": 1, "maximum": 10, "type": "integer", "description": "Maximum number of public pages to fetch per restaurant, including discovered menu pages.", "default": 3 }, "includeMenuItems": { "title": "Include Menu Item Rows", "type": "boolean", "description": "When enabled, emit additional menu_item dataset rows for simple HTML or schema.org menu items.", "default": true }, "fixtureMode": { "title": "Fixture Mode", "type": "boolean", "description": "Uses deterministic raw HTML fixtures instead of live HTTP fetches.", "default": 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 } } }, "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 } } } } } } } } } } ```