# Yelp Scraper (`axlymxp/yelp-scraper`) Actor Scrape Yelp using the official API. Supports search, business info, reviews, photos, Q\&A and more. - **URL**: https://apify.com/axlymxp/yelp-scraper.md - **Developed by:** [axly](https://apify.com/axlymxp) (community) - **Categories:** Agents, E-commerce, Automation - **Stats:** 2 total users, 1 monthly users, 100.0% runs succeeded, NaN bookmarks - **User rating**: No ratings yet ## Pricing from $2.00 / 1,000 results This Actor is paid per event. You are not charged for the Apify platform usage, but only a fixed price for specific events. Learn more: https://docs.apify.com/platform/actors/running/actors-in-store#pay-per-event ## 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.md): ```bash npm install apify-client ``` In Python projects, use official [Python client library](https://docs.apify.com/api/client/python.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/platform/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 ## Standby JavaScript template Start a new [web scraping](https://apify.com/web-scraping) project quickly and easily in JavaScript (Node.js) with our Standby project template. It provides a basic structure for building an Actor with [Apify SDK](https://docs.apify.com/sdk/js/) and allows you to easily add your own functionality. ### Included features - **[Apify SDK](https://docs.apify.com/sdk/js/)** - a toolkit for building [Actors](https://apify.com/actors) ### Resources - [Actor Standby documentation](https://docs.apify.com/platform/actors/development/programming-interface/standby) # Actor input Schema ## `action` (type: `string`): What to scrape: search businesses, get business info, reviews, photos, Q&A, or related businesses. ## `term` (type: `string`): Search term (e.g. 'Sushi', 'Coffee shops'). Required for 'search' action. ## `location` (type: `string`): Location for search (e.g. 'New York, NY', 'San Francisco, CA'). Required for 'search' action. ## `businessId` (type: `string`): Yelp business ID (alias or encoded ID). Required for businessInfo, reviews, photos, qa, relatedBusinesses actions. ## `limit` (type: `integer`): Number of results per request (max 50 for search, max 100 for reviews). ## `maxItems` (type: `integer`): Maximum total items to collect. Set to 0 for unlimited. ## `sortBy` (type: `string`): Sort order for reviews. ## `cc` (type: `string`): Country code for localization (e.g. US, GB, CA). ## `lang` (type: `string`): Language code for content (e.g. en, fr, de). ## `distanceUnit` (type: `string`): Unit for distance display. ## Actor input object example ```json { "action": "search", "term": "Coffee", "location": "New York, NY", "limit": 20, "maxItems": 100, "sortBy": "relevance_desc", "cc": "US", "lang": "en", "distanceUnit": "mi" } ```` # 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 = { "term": "Coffee", "location": "New York, NY" }; // Run the Actor and wait for it to finish const run = await client.actor("axlymxp/yelp-scraper").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 = { "term": "Coffee", "location": "New York, NY", } # Run the Actor and wait for it to finish run = client.actor("axlymxp/yelp-scraper").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 '{ "term": "Coffee", "location": "New York, NY" }' | apify call axlymxp/yelp-scraper --silent --output-dataset ``` ## MCP server setup ```json { "mcpServers": { "apify": { "command": "npx", "args": [ "mcp-remote", "https://mcp.apify.com/?tools=axlymxp/yelp-scraper", "--header", "Authorization: Bearer " ] } } } ``` ## OpenAPI specification ```json { "openapi": "3.0.1", "info": { "title": "Yelp Scraper", "description": "Scrape Yelp using the official API. Supports search, business info, reviews, photos, Q&A and more.", "version": "0.1", "x-build-id": "8XICaSD7rzfeWCIqZ" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/axlymxp~yelp-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-axlymxp-yelp-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/axlymxp~yelp-scraper/runs": { "post": { "operationId": "runs-sync-axlymxp-yelp-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/axlymxp~yelp-scraper/run-sync": { "post": { "operationId": "run-sync-axlymxp-yelp-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", "required": [ "action" ], "properties": { "action": { "title": "Action", "enum": [ "search", "businessInfo", "reviews", "photos", "qa", "relatedBusinesses" ], "type": "string", "description": "What to scrape: search businesses, get business info, reviews, photos, Q&A, or related businesses.", "default": "search" }, "term": { "title": "Search Term", "type": "string", "description": "Search term (e.g. 'Sushi', 'Coffee shops'). Required for 'search' action.", "default": "Coffee" }, "location": { "title": "Location", "type": "string", "description": "Location for search (e.g. 'New York, NY', 'San Francisco, CA'). Required for 'search' action.", "default": "New York, NY" }, "businessId": { "title": "Business ID", "type": "string", "description": "Yelp business ID (alias or encoded ID). Required for businessInfo, reviews, photos, qa, relatedBusinesses actions." }, "limit": { "title": "Results Per Page", "minimum": 1, "maximum": 100, "type": "integer", "description": "Number of results per request (max 50 for search, max 100 for reviews).", "default": 20 }, "maxItems": { "title": "Max Items", "minimum": 0, "type": "integer", "description": "Maximum total items to collect. Set to 0 for unlimited.", "default": 100 }, "sortBy": { "title": "Sort Reviews By", "enum": [ "relevance_desc", "rating_desc", "rating_asc", "time_desc" ], "type": "string", "description": "Sort order for reviews.", "default": "relevance_desc" }, "cc": { "title": "Country Code", "type": "string", "description": "Country code for localization (e.g. US, GB, CA).", "default": "US" }, "lang": { "title": "Language Code", "type": "string", "description": "Language code for content (e.g. en, fr, de).", "default": "en" }, "distanceUnit": { "title": "Distance Unit", "enum": [ "mi", "km" ], "type": "string", "description": "Unit for distance display.", "default": "mi" } } }, "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 } } } } } } } } } } ```