# Yelp Businesses & Reviews Scraper (`dami_studio/yelp-scraper`) Actor

Scrape Yelp business listings and reviews. Search by term + location, or pass business URLs/slugs for full detail. Returns name, rating, review count, price, phone, address, geo and reviews. Real browser beats DataDome; never charges blocked or empty runs.

- **URL**: https://apify.com/dami\_studio/yelp-scraper.md
- **Developed by:** [Dami's Studio](https://apify.com/dami_studio) (community)
- **Categories:** Lead generation, Integrations, E-commerce
- **Stats:** 2 total users, 1 monthly users, 100.0% runs succeeded, 0 bookmarks
- **User rating**: No ratings yet

## Pricing

$3.00 / 1,000 business returneds

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

## Yelp Businesses & Reviews Scraper

Scrape Yelp business listings and full business detail (with reviews) using a real
browser to get past Yelp's **DataDome** bot wall.

### Input modes

- **Search / listings** — set `searchQueries` (e.g. `["coffee in San Francisco"]`),
  or the single `query` + `location` fields. Returns one row per business in the
  results list.
- **Detail + reviews** — set `businessUrls` (`https://www.yelp.com/biz/...`) and/or
  `businessSlugs` (the part after `/biz/`). Returns the full business plus up to
  `maxReviews` reviews each.

You can combine both modes in one run. `maxItems` caps the total.

#### Example input

```json
{
  "searchQueries": ["coffee in San Francisco"],
  "businessUrls": ["https://www.yelp.com/biz/blue-bottle-coffee-san-francisco-7"],
  "maxItems": 50,
  "maxReviews": 20,
  "countryCode": "US"
}
````

### Output

One dataset item per business:

```json
{
  "ok": true,
  "name": "Blue Bottle Coffee",
  "yelpUrl": "https://www.yelp.com/biz/blue-bottle-coffee-san-francisco-7",
  "category": "Coffee & Tea",
  "rating": 4.1,
  "reviewCount": 2543,
  "price": "$$",
  "phone": "(510) 653-3394",
  "address": "66 Mint St",
  "city": "San Francisco",
  "state": "CA",
  "zip": "94103",
  "lat": 37.782, "lng": -122.407,
  "isAd": false,
  "reviews": [
    { "author": "Jane D.", "rating": 5, "text": "Great espresso…", "date": "2025-12-01" }
  ]
}
```

`reviews` is only present for businesses scraped in detail mode with `maxReviews > 0`.

#### Nullable fields

Detail-mode rows (from `businessUrls` / `businessSlugs`) are the most complete.
**Search/listing rows can be sparse:** when Yelp doesn't embed structured data for
a result and the actor falls back to parsing the visible DOM, only `name`,
`yelpUrl` and `slug` are guaranteed — `rating`, `reviewCount`, `category`,
`price`, `phone`, `address`, `city`, `state`, `zip`, `lat` and `lng` may be
`null`. Use detail mode for full records.

#### Pagination

Search mode paginates each query in batches of 10 (`start=0,10,20,…`), stops a
query after 2 consecutive empty/duplicate pages, and never goes past `start=240`.
`maxItems` caps the total across all inputs.

### Proxy (required)

Yelp is behind DataDome. A **RESIDENTIAL** proxy is required — the default proxy
configuration uses it. Set `countryCode` to the Yelp region you're targeting. On a
block the actor rotates the whole browser + IP up to 7 times before giving up.

### Billing

Charged per business returned (event `business`). Blocked, empty, or bad-input
runs emit a diagnostic row (`ok:false`, `errorCode` — e.g. `BLOCKED`,
`NO_RESULTS`, `BAD_INPUT`) and are **never** charged.

### Troubleshooting

- **`BAD_INPUT` row, no results** — you didn't provide any search input. Set
  `searchQueries` (e.g. `["coffee in San Francisco"]`), or `query` + `location`,
  and/or `businessUrls` / `businessSlugs`.
- **`BLOCKED` row** — Yelp's DataDome wall blocked every rotation. Retry (a fresh
  residential IP usually gets through) and confirm a RESIDENTIAL proxy plus the
  right `countryCode` are set.
- **Sparse search rows** — see *Nullable fields* above; use detail mode for full
  records.

# Actor input Schema

## `searchQueries` (type: `array`):

Listing searches. Each entry is "{term} in {location}", e.g. "coffee in San Francisco", "plumbers in Austin, TX". Use this OR the single query + location fields below.

## `query` (type: `string`):

A single search term, e.g. "coffee", "dentist", "pizza". Combine with the Location field below. Ignored if Search queries is used.

## `location` (type: `string`):

City / area for the single search term above, e.g. "San Francisco", "Austin, TX", "10001".

## `businessUrls` (type: `array`):

Yelp business page URLs (https://www.yelp.com/biz/...) to scrape for full detail + reviews. Use this for detail mode.

## `businessSlugs` (type: `array`):

Yelp business slugs (the part after /biz/, e.g. "blue-bottle-coffee-san-francisco-7") to scrape for full detail + reviews.

## `maxItems` (type: `integer`):

Maximum number of businesses to collect across all inputs (search paginates in batches of 10). Note: on a search row, only name, yelpUrl and slug are guaranteed — rating, reviewCount, category, price, phone, address, city, state, zip, lat and lng can be null when Yelp's structured data is missing and the DOM fallback is used. Use businessUrls/businessSlugs (detail mode) for complete records.

## `maxReviews` (type: `integer`):

For business URL/slug detail mode: how many reviews to include per business (author, rating, text, date). 0 = no reviews. Listing search rows never include reviews.

## `countryCode` (type: `string`):

Residential proxy country (2-letter ISO). Yelp is geo-aware; use US for US searches, GB/CA/etc. for other Yelp regions.

## `slackConnector` (type: `string`):

Optional. Post a summary of the scrape (count + top 5 businesses + dataset link) to Slack when the run finishes. Authorize a Slack connector once in Settings → API & Integrations → MCP connectors, then pick it here. Leave empty to skip (default) — results are always saved to the dataset regardless.

## `slackChannel` (type: `string`):

Channel for the Slack summary (only used if a Slack connector is set), e.g. "#leads". Defaults to #general.

## `notionConnector` (type: `string`):

Optional. Write each scraped business as a page into your Notion when the run finishes — great for turning leads into a CRM. Authorize a Notion connector once in Settings → API & Integrations → MCP connectors, then pick it here. Leave empty to skip (default) — results are always saved to the dataset regardless.

## `notionParentId` (type: `string`):

Optional. The Notion data source ID of the database to write businesses into (only used if a Notion connector is set). Leave empty to create the pages privately in your workspace instead.

## `proxyConfiguration` (type: `object`):

Yelp uses DataDome — a RESIDENTIAL proxy is required to get past the bot wall.

## Actor input object example

```json
{
  "searchQueries": [
    "coffee in San Francisco"
  ],
  "maxItems": 50,
  "maxReviews": 0,
  "countryCode": "US",
  "proxyConfiguration": {
    "useApifyProxy": true,
    "apifyProxyGroups": [
      "RESIDENTIAL"
    ]
  }
}
```

# Actor output Schema

## `results` (type: `string`):

Scraped rows are stored in the default dataset (one row per result). Blocked/empty/error runs return a single uncharged diagnostic row instead.

# 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 '<YOUR_API_TOKEN>' with your token
const client = new ApifyClient({
    token: '<YOUR_API_TOKEN>',
});

// Prepare Actor input
const input = {
    "searchQueries": [
        "coffee in San Francisco"
    ]
};

// Run the Actor and wait for it to finish
const run = await client.actor("dami_studio/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 '<YOUR_API_TOKEN>' with your token.
client = ApifyClient("<YOUR_API_TOKEN>")

# Prepare the Actor input
run_input = { "searchQueries": ["coffee in San Francisco"] }

# Run the Actor and wait for it to finish
run = client.actor("dami_studio/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 '{
  "searchQueries": [
    "coffee in San Francisco"
  ]
}' |
apify call dami_studio/yelp-scraper --silent --output-dataset

```

## MCP server setup

```json
{
    "mcpServers": {
        "apify": {
            "command": "npx",
            "args": [
                "mcp-remote",
                "https://mcp.apify.com/?tools=dami_studio/yelp-scraper",
                "--header",
                "Authorization: Bearer <YOUR_API_TOKEN>"
            ]
        }
    }
}

```

## OpenAPI specification

```json
{
    "openapi": "3.0.1",
    "info": {
        "title": "Yelp Businesses & Reviews Scraper",
        "description": "Scrape Yelp business listings and reviews. Search by term + location, or pass business URLs/slugs for full detail. Returns name, rating, review count, price, phone, address, geo and reviews. Real browser beats DataDome; never charges blocked or empty runs.",
        "version": "0.1",
        "x-build-id": "ugQKC0IXEMqFlHlFX"
    },
    "servers": [
        {
            "url": "https://api.apify.com/v2"
        }
    ],
    "paths": {
        "/acts/dami_studio~yelp-scraper/run-sync-get-dataset-items": {
            "post": {
                "operationId": "run-sync-get-dataset-items-dami_studio-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/dami_studio~yelp-scraper/runs": {
            "post": {
                "operationId": "runs-sync-dami_studio-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/dami_studio~yelp-scraper/run-sync": {
            "post": {
                "operationId": "run-sync-dami_studio-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",
                "properties": {
                    "searchQueries": {
                        "title": "Search queries",
                        "type": "array",
                        "description": "Listing searches. Each entry is \"{term} in {location}\", e.g. \"coffee in San Francisco\", \"plumbers in Austin, TX\". Use this OR the single query + location fields below.",
                        "items": {
                            "type": "string"
                        }
                    },
                    "query": {
                        "title": "Search term (single)",
                        "type": "string",
                        "description": "A single search term, e.g. \"coffee\", \"dentist\", \"pizza\". Combine with the Location field below. Ignored if Search queries is used."
                    },
                    "location": {
                        "title": "Location (single)",
                        "type": "string",
                        "description": "City / area for the single search term above, e.g. \"San Francisco\", \"Austin, TX\", \"10001\"."
                    },
                    "businessUrls": {
                        "title": "Business URLs",
                        "type": "array",
                        "description": "Yelp business page URLs (https://www.yelp.com/biz/...) to scrape for full detail + reviews. Use this for detail mode.",
                        "items": {
                            "type": "string"
                        }
                    },
                    "businessSlugs": {
                        "title": "Business slugs",
                        "type": "array",
                        "description": "Yelp business slugs (the part after /biz/, e.g. \"blue-bottle-coffee-san-francisco-7\") to scrape for full detail + reviews.",
                        "items": {
                            "type": "string"
                        }
                    },
                    "maxItems": {
                        "title": "Max businesses",
                        "minimum": 1,
                        "maximum": 1000,
                        "type": "integer",
                        "description": "Maximum number of businesses to collect across all inputs (search paginates in batches of 10). Note: on a search row, only name, yelpUrl and slug are guaranteed — rating, reviewCount, category, price, phone, address, city, state, zip, lat and lng can be null when Yelp's structured data is missing and the DOM fallback is used. Use businessUrls/businessSlugs (detail mode) for complete records.",
                        "default": 50
                    },
                    "maxReviews": {
                        "title": "Max reviews per business",
                        "minimum": 0,
                        "maximum": 2000,
                        "type": "integer",
                        "description": "For business URL/slug detail mode: how many reviews to include per business (author, rating, text, date). 0 = no reviews. Listing search rows never include reviews.",
                        "default": 0
                    },
                    "countryCode": {
                        "title": "Proxy country",
                        "type": "string",
                        "description": "Residential proxy country (2-letter ISO). Yelp is geo-aware; use US for US searches, GB/CA/etc. for other Yelp regions.",
                        "default": "US"
                    },
                    "slackConnector": {
                        "title": "Slack connector (optional)",
                        "type": "string",
                        "description": "Optional. Post a summary of the scrape (count + top 5 businesses + dataset link) to Slack when the run finishes. Authorize a Slack connector once in Settings → API & Integrations → MCP connectors, then pick it here. Leave empty to skip (default) — results are always saved to the dataset regardless."
                    },
                    "slackChannel": {
                        "title": "Slack channel",
                        "type": "string",
                        "description": "Channel for the Slack summary (only used if a Slack connector is set), e.g. \"#leads\". Defaults to #general."
                    },
                    "notionConnector": {
                        "title": "Notion connector (optional)",
                        "type": "string",
                        "description": "Optional. Write each scraped business as a page into your Notion when the run finishes — great for turning leads into a CRM. Authorize a Notion connector once in Settings → API & Integrations → MCP connectors, then pick it here. Leave empty to skip (default) — results are always saved to the dataset regardless."
                    },
                    "notionParentId": {
                        "title": "Notion target data source ID",
                        "type": "string",
                        "description": "Optional. The Notion data source ID of the database to write businesses into (only used if a Notion connector is set). Leave empty to create the pages privately in your workspace instead."
                    },
                    "proxyConfiguration": {
                        "title": "Proxy",
                        "type": "object",
                        "description": "Yelp uses DataDome — a RESIDENTIAL proxy is required to get past the bot wall.",
                        "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
                                    }
                                }
                            },
                            "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
                                    }
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}
```
