{ "openapi": "3.0.1", "info": { "title": "Yelp Reviews Scraper (new-review monitor, no personal data)", "description": "Use this Actor when you need Yelp reviews of one or many businesses: rating, full text, date, votes, photos and owner replies, past the 3-review cap. Monitor mode returns only reviews posted since the last run. No reviewer names or profiles. Failed businesses are not charged.", "version": "0.1", "x-build-id": "ohV43zuk5zRJOiqKx" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/integrative_cafe_8pc~yelp-reviews-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-integrative_cafe_8pc-yelp-reviews-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/integrative_cafe_8pc~yelp-reviews-scraper/runs": { "post": { "operationId": "runs-sync-integrative_cafe_8pc-yelp-reviews-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/integrative_cafe_8pc~yelp-reviews-scraper/run-sync": { "post": { "operationId": "run-sync-integrative_cafe_8pc-yelp-reviews-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": [ "businesses" ], "properties": { "businesses": { "title": "Yelp businesses", "type": "array", "description": "One business per line: a Yelp business link (https://www.yelp.com/biz/gary-danko-san-francisco), the alias from that link (gary-danko-san-francisco) or the Yelp business id. Any Yelp country site works (yelp.com, yelp.ca, yelp.co.uk).", "default": [ "https://www.yelp.com/biz/gary-danko-san-francisco", "tartine-bakery-san-francisco-3" ], "items": { "type": "string" } }, "maxReviewsPerBusiness": { "title": "Max reviews per business", "minimum": 0, "type": "integer", "description": "Stop after this many reviews per business. 0 means every review the business has.", "default": 20 }, "sortBy": { "title": "Sort reviews by", "enum": [ "newest", "oldest", "highest", "lowest", "relevance" ], "type": "string", "description": "Order in which reviews are collected. Monitor mode and 'Only reviews since' always use newest first.", "default": "newest" }, "ratings": { "title": "Star ratings to include", "type": "array", "description": "Only reviews with these star ratings. Leave empty for all. Example: 1 and 2 to collect complaints only.", "items": { "type": "string", "enum": [ "1", "2", "3", "4", "5" ], "enumTitles": [ "1 star", "2 stars", "3 stars", "4 stars", "5 stars" ] }, "default": [] }, "onlyReviewsSince": { "title": "Only reviews since", "type": "string", "description": "Only reviews posted on or after this date (2026-01-31) or within the last N days ('30 days'). Leave empty for no date limit." }, "onlyNewReviews": { "title": "Monitor mode: only new reviews", "type": "boolean", "description": "Remember which reviews were already returned and, on every next run, return only reviews posted since. The first run returns the latest reviews and saves them as the starting point. Schedule the Actor daily to get a feed of new Yelp reviews.", "default": false }, "language": { "title": "Review language", "type": "string", "description": "Two-letter language code of the reviews to collect (en, es, fr, zh...).", "default": "en" }, "maxConcurrency": { "title": "Parallel businesses", "minimum": 1, "maximum": 5, "type": "integer", "description": "How many businesses are collected at the same time, from 1 to 5. Lower is gentler on Yelp.", "default": 3 }, "proxy": { "title": "Proxy", "type": "object", "description": "Proxy settings. The default Apify datacenter proxy works and keeps the cost low; if Yelp keeps blocking it, the run moves to residential proxy by itself.", "default": { "useApifyProxy": true } } } }, "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 }, "PROXY_UNBLOCKER_UNITS": { "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 }, "PROXY_UNBLOCKER_UNITS": { "type": "integer", "example": 0 } } } } } } } } } }