Yelp Scraper
7 days trial then $20.00/month - No credit card required now
This Actor may be unreliable while under maintenance. Would you like to try a similar Actor instead?
See alternative ActorsYelp Scraper
7 days trial then $20.00/month - No credit card required now
The Yelp-Reviews-Scraper, Apify platform based scraper, enables the collection of reviews directly from Yelp's business pages. This tool is designed to retrieve comprehensive business information, user ratings, and customer feedback without the necessity of utilizing Yelp's official API.
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": "0.0",
5 "x-build-id": "5ccFNCXDep4MAygQU"
6 },
7 "servers": [
8 {
9 "url": "https://api.apify.com/v2"
10 }
11 ],
12 "paths": {
13 "/acts/widbox~yelp-scraper/run-sync-get-dataset-items": {
14 "post": {
15 "operationId": "run-sync-get-dataset-items-widbox-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/widbox~yelp-scraper/runs": {
50 "post": {
51 "operationId": "runs-sync-widbox-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/widbox~yelp-scraper/run-sync": {
93 "post": {
94 "operationId": "run-sync-widbox-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 "bizUrl",
135 "sortType",
136 "proxy"
137 ],
138 "properties": {
139 "bizUrl": {
140 "title": "Yelp business page url",
141 "type": "string",
142 "description": "Provide url of YELP place, to scrape reviews. Example: https://www.yelp.com/biz/gotham-burger-social-club-new-york."
143 },
144 "sortType": {
145 "title": "Yelp reviews sorting method",
146 "enum": [
147 "RELEVANCE_DESC",
148 "DATE_DESC",
149 "DATE_ASC",
150 "RATING_DESC",
151 "RATING_ASC",
152 "ELITES_DESC"
153 ],
154 "type": "string",
155 "description": "Select one of yelp sorting methods like a date-descending, date-ascending or other.",
156 "default": "RELEVANCE_DESC"
157 },
158 "reviewsCount": {
159 "title": "Reviews count",
160 "type": "integer",
161 "description": "Provide reviews count to scrape, for limit reviews. If reviews count is not filled, we will try to get all existing reviews"
162 },
163 "rating": {
164 "title": "Yelp reviews rating",
165 "pattern": "^(?:[1-5],\\s?){0,4}[1-5]?$",
166 "type": "string",
167 "description": "Provide review rating numbers you want to scrape. If you want to scrape all reviews, leave it empty. Format: 1, 2, 3, 4, 5."
168 },
169 "timestamp": {
170 "title": "Timestamp filter (seconds)",
171 "type": "integer",
172 "description": "Provide timestamp in seconds to scrape reviews newer than this timestamp. Reviews older than this timestamp will be ignored. Use only with \"Newest first\" sortType, or timestamp will be ignored."
173 },
174 "proxy": {
175 "title": "Proxy configuration",
176 "type": "object",
177 "description": "Select proxies to be used by your crawler."
178 }
179 }
180 },
181 "runsResponseSchema": {
182 "type": "object",
183 "properties": {
184 "data": {
185 "type": "object",
186 "properties": {
187 "id": {
188 "type": "string"
189 },
190 "actId": {
191 "type": "string"
192 },
193 "userId": {
194 "type": "string"
195 },
196 "startedAt": {
197 "type": "string",
198 "format": "date-time",
199 "example": "2025-01-08T00:00:00.000Z"
200 },
201 "finishedAt": {
202 "type": "string",
203 "format": "date-time",
204 "example": "2025-01-08T00:00:00.000Z"
205 },
206 "status": {
207 "type": "string",
208 "example": "READY"
209 },
210 "meta": {
211 "type": "object",
212 "properties": {
213 "origin": {
214 "type": "string",
215 "example": "API"
216 },
217 "userAgent": {
218 "type": "string"
219 }
220 }
221 },
222 "stats": {
223 "type": "object",
224 "properties": {
225 "inputBodyLen": {
226 "type": "integer",
227 "example": 2000
228 },
229 "rebootCount": {
230 "type": "integer",
231 "example": 0
232 },
233 "restartCount": {
234 "type": "integer",
235 "example": 0
236 },
237 "resurrectCount": {
238 "type": "integer",
239 "example": 0
240 },
241 "computeUnits": {
242 "type": "integer",
243 "example": 0
244 }
245 }
246 },
247 "options": {
248 "type": "object",
249 "properties": {
250 "build": {
251 "type": "string",
252 "example": "latest"
253 },
254 "timeoutSecs": {
255 "type": "integer",
256 "example": 300
257 },
258 "memoryMbytes": {
259 "type": "integer",
260 "example": 1024
261 },
262 "diskMbytes": {
263 "type": "integer",
264 "example": 2048
265 }
266 }
267 },
268 "buildId": {
269 "type": "string"
270 },
271 "defaultKeyValueStoreId": {
272 "type": "string"
273 },
274 "defaultDatasetId": {
275 "type": "string"
276 },
277 "defaultRequestQueueId": {
278 "type": "string"
279 },
280 "buildNumber": {
281 "type": "string",
282 "example": "1.0.0"
283 },
284 "containerUrl": {
285 "type": "string"
286 },
287 "usage": {
288 "type": "object",
289 "properties": {
290 "ACTOR_COMPUTE_UNITS": {
291 "type": "integer",
292 "example": 0
293 },
294 "DATASET_READS": {
295 "type": "integer",
296 "example": 0
297 },
298 "DATASET_WRITES": {
299 "type": "integer",
300 "example": 0
301 },
302 "KEY_VALUE_STORE_READS": {
303 "type": "integer",
304 "example": 0
305 },
306 "KEY_VALUE_STORE_WRITES": {
307 "type": "integer",
308 "example": 1
309 },
310 "KEY_VALUE_STORE_LISTS": {
311 "type": "integer",
312 "example": 0
313 },
314 "REQUEST_QUEUE_READS": {
315 "type": "integer",
316 "example": 0
317 },
318 "REQUEST_QUEUE_WRITES": {
319 "type": "integer",
320 "example": 0
321 },
322 "DATA_TRANSFER_INTERNAL_GBYTES": {
323 "type": "integer",
324 "example": 0
325 },
326 "DATA_TRANSFER_EXTERNAL_GBYTES": {
327 "type": "integer",
328 "example": 0
329 },
330 "PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
331 "type": "integer",
332 "example": 0
333 },
334 "PROXY_SERPS": {
335 "type": "integer",
336 "example": 0
337 }
338 }
339 },
340 "usageTotalUsd": {
341 "type": "number",
342 "example": 0.00005
343 },
344 "usageUsd": {
345 "type": "object",
346 "properties": {
347 "ACTOR_COMPUTE_UNITS": {
348 "type": "integer",
349 "example": 0
350 },
351 "DATASET_READS": {
352 "type": "integer",
353 "example": 0
354 },
355 "DATASET_WRITES": {
356 "type": "integer",
357 "example": 0
358 },
359 "KEY_VALUE_STORE_READS": {
360 "type": "integer",
361 "example": 0
362 },
363 "KEY_VALUE_STORE_WRITES": {
364 "type": "number",
365 "example": 0.00005
366 },
367 "KEY_VALUE_STORE_LISTS": {
368 "type": "integer",
369 "example": 0
370 },
371 "REQUEST_QUEUE_READS": {
372 "type": "integer",
373 "example": 0
374 },
375 "REQUEST_QUEUE_WRITES": {
376 "type": "integer",
377 "example": 0
378 },
379 "DATA_TRANSFER_INTERNAL_GBYTES": {
380 "type": "integer",
381 "example": 0
382 },
383 "DATA_TRANSFER_EXTERNAL_GBYTES": {
384 "type": "integer",
385 "example": 0
386 },
387 "PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
388 "type": "integer",
389 "example": 0
390 },
391 "PROXY_SERPS": {
392 "type": "integer",
393 "example": 0
394 }
395 }
396 }
397 }
398 }
399 }
400 }
401 }
402 }
403}
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:
Actor Metrics
6 monthly users
-
3 bookmarks
92% runs succeeded
Created in Apr 2024
Modified 7 months ago