Yelp Scraper avatar

Yelp Scraper

Deprecated
Go to Store
This Actor is deprecated

This Actor is unavailable because the developer has decided to deprecate it. Would you like to try a similar Actor instead?

See alternative Actors
Yelp Scraper

Yelp Scraper

eunit/yelp-scraper

Effortlessly extract business names, addresses, phone numbers, ratings, and reviews from Yelp. No Yelp API is required! Analyze customer sentiment, track competitors, or gather market research data. Scrape by location or keywords. Export data (CSV, JSON, HTML) and automate scraping.

You can access the Yelp Scraper programmatically from your own applications by using the Apify API. You can choose the language preference from below. To use the Apify API, you’ll need an Apify account and your API token, found in Integrations settings in Apify Console.

1{
2  "openapi": "3.0.1",
3  "info": {
4    "version": "1.0",
5    "x-build-id": "nod0AAZLwzjEWwFhG"
6  },
7  "servers": [
8    {
9      "url": "https://api.apify.com/v2"
10    }
11  ],
12  "paths": {
13    "/acts/eunit~yelp-scraper/run-sync-get-dataset-items": {
14      "post": {
15        "operationId": "run-sync-get-dataset-items-eunit-yelp-scraper",
16        "x-openai-isConsequential": false,
17        "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.",
18        "tags": [
19          "Run Actor"
20        ],
21        "requestBody": {
22          "required": true,
23          "content": {
24            "application/json": {
25              "schema": {
26                "$ref": "#/components/schemas/inputSchema"
27              }
28            }
29          }
30        },
31        "parameters": [
32          {
33            "name": "token",
34            "in": "query",
35            "required": true,
36            "schema": {
37              "type": "string"
38            },
39            "description": "Enter your Apify token here"
40          }
41        ],
42        "responses": {
43          "200": {
44            "description": "OK"
45          }
46        }
47      }
48    },
49    "/acts/eunit~yelp-scraper/runs": {
50      "post": {
51        "operationId": "runs-sync-eunit-yelp-scraper",
52        "x-openai-isConsequential": false,
53        "summary": "Executes an Actor and returns information about the initiated run in response.",
54        "tags": [
55          "Run Actor"
56        ],
57        "requestBody": {
58          "required": true,
59          "content": {
60            "application/json": {
61              "schema": {
62                "$ref": "#/components/schemas/inputSchema"
63              }
64            }
65          }
66        },
67        "parameters": [
68          {
69            "name": "token",
70            "in": "query",
71            "required": true,
72            "schema": {
73              "type": "string"
74            },
75            "description": "Enter your Apify token here"
76          }
77        ],
78        "responses": {
79          "200": {
80            "description": "OK",
81            "content": {
82              "application/json": {
83                "schema": {
84                  "$ref": "#/components/schemas/runsResponseSchema"
85                }
86              }
87            }
88          }
89        }
90      }
91    },
92    "/acts/eunit~yelp-scraper/run-sync": {
93      "post": {
94        "operationId": "run-sync-eunit-yelp-scraper",
95        "x-openai-isConsequential": false,
96        "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.",
97        "tags": [
98          "Run Actor"
99        ],
100        "requestBody": {
101          "required": true,
102          "content": {
103            "application/json": {
104              "schema": {
105                "$ref": "#/components/schemas/inputSchema"
106              }
107            }
108          }
109        },
110        "parameters": [
111          {
112            "name": "token",
113            "in": "query",
114            "required": true,
115            "schema": {
116              "type": "string"
117            },
118            "description": "Enter your Apify token here"
119          }
120        ],
121        "responses": {
122          "200": {
123            "description": "OK"
124          }
125        }
126      }
127    }
128  },
129  "components": {
130    "schemas": {
131      "inputSchema": {
132        "type": "object",
133        "required": [
134          "proxy"
135        ],
136        "properties": {
137          "searchTerms": {
138            "title": "Search terms",
139            "type": "array",
140            "description": "Here you can provide a search queries for Yelp bussinesses to scrape. <br /><br /><strong>Choose either of 'Search Terms' or 'Direct URLs'.</strong>",
141            "items": {
142              "type": "string"
143            }
144          },
145          "locations": {
146            "title": "Locations",
147            "type": "array",
148            "description": "Locations that will be searched for each search term.",
149            "items": {
150              "type": "string"
151            }
152          },
153          "searchLimit": {
154            "title": "Search results limit",
155            "minimum": 1,
156            "maximum": 999999,
157            "type": "integer",
158            "description": "How many search results (eq. Yelp bussinesses) should be processed per search query"
159          },
160          "directUrls": {
161            "title": "Direct Yelp page URLs instead of search",
162            "uniqueItems": true,
163            "type": "array",
164            "description": "If you already have URL(s) of page(s) you wish to scrape, you can set them here. <br /><br /><strong>Either of 'Search' or 'Direct URLs' or both fields.</strong>",
165            "default": [],
166            "items": {
167              "type": "string"
168            }
169          },
170          "maxImages": {
171            "title": "Max images",
172            "minimum": 0,
173            "type": "integer",
174            "description": "Maximum number of images per business"
175          },
176          "reviewLimit": {
177            "title": "Maximum reviews",
178            "minimum": 0,
179            "maximum": 999999,
180            "type": "integer",
181            "description": "How many reviews should be scraped per business"
182          },
183          "scrapeReviewerName": {
184            "title": "Reviewer name",
185            "type": "boolean",
186            "description": "Extract Reviewer name",
187            "default": false
188          },
189          "scrapeReviewerUrl": {
190            "title": "Reviewer URL",
191            "type": "boolean",
192            "description": "Extract Reviewer URL",
193            "default": false
194          },
195          "proxy": {
196            "title": "Proxy configuration",
197            "type": "object",
198            "description": "<strong>Proxy is required to run this actor!</strong> Either use Apify proxy, or provide your own proxy servers.",
199            "default": {
200              "useApifyProxy": true,
201              "apifyProxyGroups": [
202                "RESIDENTIAL"
203              ]
204            }
205          },
206          "maxRequestRetries": {
207            "title": "Max page retries",
208            "minimum": 0,
209            "maximum": 100,
210            "type": "integer",
211            "description": "How many times a failed request is retried before thrown away. Requests usually failed when blocked by the target site.",
212            "default": 10
213          }
214        }
215      },
216      "runsResponseSchema": {
217        "type": "object",
218        "properties": {
219          "data": {
220            "type": "object",
221            "properties": {
222              "id": {
223                "type": "string"
224              },
225              "actId": {
226                "type": "string"
227              },
228              "userId": {
229                "type": "string"
230              },
231              "startedAt": {
232                "type": "string",
233                "format": "date-time",
234                "example": "2025-01-08T00:00:00.000Z"
235              },
236              "finishedAt": {
237                "type": "string",
238                "format": "date-time",
239                "example": "2025-01-08T00:00:00.000Z"
240              },
241              "status": {
242                "type": "string",
243                "example": "READY"
244              },
245              "meta": {
246                "type": "object",
247                "properties": {
248                  "origin": {
249                    "type": "string",
250                    "example": "API"
251                  },
252                  "userAgent": {
253                    "type": "string"
254                  }
255                }
256              },
257              "stats": {
258                "type": "object",
259                "properties": {
260                  "inputBodyLen": {
261                    "type": "integer",
262                    "example": 2000
263                  },
264                  "rebootCount": {
265                    "type": "integer",
266                    "example": 0
267                  },
268                  "restartCount": {
269                    "type": "integer",
270                    "example": 0
271                  },
272                  "resurrectCount": {
273                    "type": "integer",
274                    "example": 0
275                  },
276                  "computeUnits": {
277                    "type": "integer",
278                    "example": 0
279                  }
280                }
281              },
282              "options": {
283                "type": "object",
284                "properties": {
285                  "build": {
286                    "type": "string",
287                    "example": "latest"
288                  },
289                  "timeoutSecs": {
290                    "type": "integer",
291                    "example": 300
292                  },
293                  "memoryMbytes": {
294                    "type": "integer",
295                    "example": 1024
296                  },
297                  "diskMbytes": {
298                    "type": "integer",
299                    "example": 2048
300                  }
301                }
302              },
303              "buildId": {
304                "type": "string"
305              },
306              "defaultKeyValueStoreId": {
307                "type": "string"
308              },
309              "defaultDatasetId": {
310                "type": "string"
311              },
312              "defaultRequestQueueId": {
313                "type": "string"
314              },
315              "buildNumber": {
316                "type": "string",
317                "example": "1.0.0"
318              },
319              "containerUrl": {
320                "type": "string"
321              },
322              "usage": {
323                "type": "object",
324                "properties": {
325                  "ACTOR_COMPUTE_UNITS": {
326                    "type": "integer",
327                    "example": 0
328                  },
329                  "DATASET_READS": {
330                    "type": "integer",
331                    "example": 0
332                  },
333                  "DATASET_WRITES": {
334                    "type": "integer",
335                    "example": 0
336                  },
337                  "KEY_VALUE_STORE_READS": {
338                    "type": "integer",
339                    "example": 0
340                  },
341                  "KEY_VALUE_STORE_WRITES": {
342                    "type": "integer",
343                    "example": 1
344                  },
345                  "KEY_VALUE_STORE_LISTS": {
346                    "type": "integer",
347                    "example": 0
348                  },
349                  "REQUEST_QUEUE_READS": {
350                    "type": "integer",
351                    "example": 0
352                  },
353                  "REQUEST_QUEUE_WRITES": {
354                    "type": "integer",
355                    "example": 0
356                  },
357                  "DATA_TRANSFER_INTERNAL_GBYTES": {
358                    "type": "integer",
359                    "example": 0
360                  },
361                  "DATA_TRANSFER_EXTERNAL_GBYTES": {
362                    "type": "integer",
363                    "example": 0
364                  },
365                  "PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
366                    "type": "integer",
367                    "example": 0
368                  },
369                  "PROXY_SERPS": {
370                    "type": "integer",
371                    "example": 0
372                  }
373                }
374              },
375              "usageTotalUsd": {
376                "type": "number",
377                "example": 0.00005
378              },
379              "usageUsd": {
380                "type": "object",
381                "properties": {
382                  "ACTOR_COMPUTE_UNITS": {
383                    "type": "integer",
384                    "example": 0
385                  },
386                  "DATASET_READS": {
387                    "type": "integer",
388                    "example": 0
389                  },
390                  "DATASET_WRITES": {
391                    "type": "integer",
392                    "example": 0
393                  },
394                  "KEY_VALUE_STORE_READS": {
395                    "type": "integer",
396                    "example": 0
397                  },
398                  "KEY_VALUE_STORE_WRITES": {
399                    "type": "number",
400                    "example": 0.00005
401                  },
402                  "KEY_VALUE_STORE_LISTS": {
403                    "type": "integer",
404                    "example": 0
405                  },
406                  "REQUEST_QUEUE_READS": {
407                    "type": "integer",
408                    "example": 0
409                  },
410                  "REQUEST_QUEUE_WRITES": {
411                    "type": "integer",
412                    "example": 0
413                  },
414                  "DATA_TRANSFER_INTERNAL_GBYTES": {
415                    "type": "integer",
416                    "example": 0
417                  },
418                  "DATA_TRANSFER_EXTERNAL_GBYTES": {
419                    "type": "integer",
420                    "example": 0
421                  },
422                  "PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
423                    "type": "integer",
424                    "example": 0
425                  },
426                  "PROXY_SERPS": {
427                    "type": "integer",
428                    "example": 0
429                  }
430                }
431              }
432            }
433          }
434        }
435      }
436    }
437  }
438}

Yelp Scraper OpenAPI definition

OpenAPI is a standard for designing and describing RESTful APIs, allowing developers to define API structure, endpoints, and data formats in a machine-readable way. It simplifies API development, integration, and documentation.

OpenAPI is effective when used with AI agents and GPTs by standardizing how these systems interact with various APIs, for reliable integrations and efficient communication.

By defining machine-readable API specifications, OpenAPI allows AI models like GPTs to understand and use varied data sources, improving accuracy. This accelerates development, reduces errors, and provides context-aware responses, making OpenAPI a core component for AI applications.

You can download the OpenAPI definitions for Yelp Scraper from the options below:

If you’d like to learn more about how OpenAPI powers GPTs, read our blog post.

You can also check out our other API clients:

Developer
Maintained by Community